PATCH /organizations/{org}/settings/billing/budgets/{budget_id}

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`		No	The type of pricing model used by the budget. Determines how `budget_product_sku` is interpreted. `BundlePricing`: Covers all AI credit SKUs. Set `budget_product_sku` to `ai_credits`. `ProductPricing`: Covers all SKUs that belong to a product. Set `budget_product_sku` to a product such as `actions` or `packages`. `SkuPricing`: Covers a single, specific SKU. Set `budget_product_sku` to a SKU such as `actions_linux`.
`prevent_further_usage`	Boolean	No	Whether to prevent additional spending once the budget is exceeded. For budgets with `user` or `multi_user_customer` scope, this must remain `true`.
`budget_scope`	String	No	The scope of the budget for this organization. `organization`: Apply the budget to the organization. `repository`: Apply the budget to a specific repository in the organization. `multi_user_customer`: Apply a universal budget to all users in the organization. `user`: Apply the budget to a single user in the organization. Valid values: `"organization"` `"cost_center"` `"enterprise"` `"repository"` `"multi_user_customer"` `"user"`
`user`	String	No	The username of the user for `user` scope budgets.
`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.