PATCH /organizations/{org}/settings/billing/budgets/{budget_id}
[!NOTE] This endpoint is in public preview and is subject to change.
Updates an existing budget for an organization. The authenticated user must be an organization admin or billing manager.
Servers
- https://api.github.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
org |
String | Yes |
The organization name. The name is not case sensitive. |
budget_id |
String | Yes |
The ID corresponding to the budget. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
budget_alerting |
Object | No | |
budget_alerting.alert_recipients[] |
Array | No |
Array of user login names who will receive alerts |
budget_alerting.will_alert |
Boolean | No |
Whether alerts are enabled for this budget |
budget_type |
String | No |
The type of pricing for the budget Valid values:
|
prevent_further_usage |
Boolean | No |
Whether to prevent additional spending once the budget is exceeded |
budget_scope |
String | No |
The scope of the budget Valid values:
|
budget_entity_name |
String | No |
The name of the entity to apply the budget to |
budget_amount |
Integer | No |
The budget amount in whole dollars. For license-based products, this represents the number of licenses. |
budget_product_sku |
String | No |
A single product or SKU that will be covered in the budget |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.