scoped-budgets

Update Scoped Budget

Relabel a ceiling, or point it at a different budget.

The scope and the provider narrowing are not editable: changing either would move the ceiling to a different identity while carrying its spend, which is a delete and a create, not an update.

There is no limit or period to set here any more. Both are properties of the budget, so changing what a ceiling allows is either editing that budget, which moves every ceiling naming it, or naming a different one.

patch/v1/scoped-budgets/{budget_id}

Path parameters

budget_idstring required

Request body

budget_idstring nullable
namestring nullable

Response

Successful Response

budget_duration_secinteger nullable required
budget_idstring required
created_atstring required
current_spendnumber required
idstring required
max_budgetnumber nullable required
namestring nullable required
period_endstring nullable required
period_startstring nullable required
provider_key_idstring nullable required
reserved_spendnumber required
reset_alignmentstring nullable required
scope_idstring required
scope_typestring required
updated_atstring required

Changes

Changed in 5 of the 132 revisions of this API.1710

  • e0dee1efa50132See the full diff
    • removed the request property budget_duration_sec

      request-property-removed

    • removed the request property max_budget

      request-property-removed

    • removed the request property reset_alignment

      request-property-removed

    • added the new optional request property budget_id

      new-optional-request-property

    • added the required property budget_id to the response with the 200 status

      response-required-property-added

  • 2f89238cc674113See the full diff
    • removed the required property budget_id from the response with the 200 status

      response-required-property-removed

    • removed the request property budget_id

      request-property-removed

    • added the new optional request property budget_duration_sec

      new-optional-request-property

    • added the new optional request property max_budget

      new-optional-request-property

    • added the new optional request property reset_alignment

      new-optional-request-property

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

  • 875cef5dd6a832See the full diff
    • removed the request property budget_duration_sec

      request-property-removed

    • removed the request property max_budget

      request-property-removed

    • removed the request property reset_alignment

      request-property-removed

    • added the new optional request property budget_id

      new-optional-request-property

    • added the required property budget_id to the response with the 200 status

      response-required-property-added

    • added the new optional request property reset_alignment

      new-optional-request-property

    • added the required property reset_alignment to the response with the 200 status

      response-required-property-added

    • endpoint added

      endpoint-added