Delete a budget for an organization

DELETE

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

Deletes a budget by ID for an organization. The authenticated user must be an organization admin or billing manager.

API method documentation

Parameters

Path Parameters

org

required

string

The organization name. The name is not case sensitive.

budget_id

required

string

The ID corresponding to the budget.

Responses

200

Response when deleting a budget

Media type application/json

object

message

required

A message indicating the result of the deletion operation

string

id

required

The ID of the deleted budget

string

Examples

Example default

{
  "message": "Budget successfully deleted.",
  "budget_id": "2c1feb79-3947-4dc8-a16e-80cbd732cc0b"
}

400

Bad Request

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

Scim Error

Scim Error

object

message

string

nullable

documentation_url

string

nullable

detail

string

nullable

status

integer

scimType

string

nullable

schemas

Array<string>

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "detail": "example",
  "status": 1,
  "scimType": "example",
  "schemas": [
    "example"
  ]
}

403

Forbidden

Media type application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

404

Resource not found

Media type application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

500

Internal Error

Media type application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

503

Service unavailable

Media type application/json

object

code

string

message

string

documentation_url

string

Example ^generated

{
  "code": "example",
  "message": "example",
  "documentation_url": "example"
}