Sign in
Budgets

Update a budget

Updates mutable fields of a budget: limits, rate limit, activation, and expiration. The scope is immutable — to change a budget's target, delete and recreate it. Omitted fields keep their current values.

patch/v2/budgets/{budget_id}

Path parameters

budget_idstring required

Budget id to update.

Request body

is_activeboolean

New active state. Omit to keep current.

expires_atstring date-time

New expiration. Omit to keep current. Set clear_expires_at = true to remove an existing expiration.

clear_expires_atboolean

Force-clear the expiration. Mutually exclusive with expires_at.

clear_alertsboolean

Force-clear every alert. Mutually exclusive with a non-empty alerts.

Response

OK

Changes

Changed in 11 of the 257 revisions of this API.2712

  • 9642bb8e4f831See the full diff
    • ●

      removed the optional property budget/allOf[BudgetRestResponse]/scope/allOf[BudgetScopeRestResponse]/factory from the response with the 200 status

      response-optional-property-removed

    This revision also has 39 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • a38e9ab597711See the full diff
    • ○

      added the optional property budget/allOf[BudgetRestResponse]/scope/allOf[BudgetScopeRestResponse]/factory to the response with the 200 status

      response-optional-property-added

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 2f27caf6888c3See the full diff
    • ○

      added the new optional request property alerts

      new-optional-request-property

    • ○

      added the new optional request property clear_alerts

      new-optional-request-property

    • ○

      added the optional property budget/allOf[Budget]/alerts to the response with the 200 status

      response-optional-property-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • bee257c5b2483See the full diff
    • ●

      removed the request property alerts

      request-property-removed

    • ●

      removed the request property clear_alerts

      request-property-removed

    • ●

      removed the optional property budget/allOf[Budget]/alerts from the response with the 200 status

      response-optional-property-removed

    This revision also has 49 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 801f61a5a0563See the full diff
    • ○

      added the new optional request property alerts

      new-optional-request-property

    • ○

      added the new optional request property clear_alerts

      new-optional-request-property

    • ○

      added the optional property budget/allOf[Budget]/alerts to the response with the 200 status

      response-optional-property-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 42d5d20625273See the full diff
    • ●

      removed the request property alerts

      request-property-removed

    • ●

      removed the request property clear_alerts

      request-property-removed

    • ●

      removed the optional property budget/allOf[Budget]/alerts from the response with the 200 status

      response-optional-property-removed

    This revision also has 49 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • d418091db1633See the full diff
    • ○

      added the new optional request property alerts

      new-optional-request-property

    • ○

      added the new optional request property clear_alerts

      new-optional-request-property

    • ○

      added the optional property budget/allOf[Budget]/alerts to the response with the 200 status

      response-optional-property-added

  • bc4a415db9cb1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 54f62cd22dcd1See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 46 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f21a1b29f8451See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 257 revisions, 71 have no diff computed.