ORorq-ai
Budgets

Update a budget

Changed on

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. Requires a Management Key with the Budgets permission; project-scoped API keys cannot manage budgets.

patch/v2/budgets/{budget_id}

Request

  • Base URL
    https://my.orq.ai
  • URL
    https://my.orq.ai/v2/budgets/{budget_id}
  • Auth
    HTTP bearer

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

  • 0b4e519a544fRevision changes
    • breaking

      removed the enum value BUDGET_ALERT_DIMENSION_UNSPECIFIED of the request property //

    • breaking

      removed the enum value BUDGET_PERIOD_UNSPECIFIED of the request property /////

    • info

      added the non-success response with the status

    • info

      removed the BUDGET_ALERT_DIMENSION_UNSPECIFIED enum value from the /////// response property for the response status

    • info

      removed the BUDGET_PERIOD_UNSPECIFIED enum value from the ////// response property for the response status

  • 732aed62833aRevision changes
    • warning

      added the new BUDGET_ALERT_DIMENSION_UNSPECIFIED enum value to the /////// response property for the response status

    • warning

      added the new BUDGET_PERIOD_UNSPECIFIED enum value to the ////// response property for the response status

    • info

      added the new BUDGET_ALERT_DIMENSION_UNSPECIFIED enum value to the request property //

    • info

      added the new BUDGET_PERIOD_UNSPECIFIED enum value to the request property /////

    • info

      removed the non-success response with the status