Budgets

Server

Download schema

List budgets

GET

https://api.costfluent.com

/v1/budgets

Bearer (API token)

Returns all budgets, optionally filtered by workspace

List budgets › query Parameters

page

integer · int32 · required

limit

integer · int32 · required

workspaceId

List budgets › Responses

Success

CostfluentPublicApiModelsV1CommonPaginatedResponseOfBudgetResponse

CostfluentPublicApiModelsV1CommonPaginationLinks · required

CostfluentPublicApiModelsV1ResponsesBudgetResponse[] · required

GET/v1/budgets

curl 'https://api.costfluent.com/v1/budgets?page=<number>&limit=<number>' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "links": {
    "self": "self",
    "first": "first",
    "prev": "prev",
    "next": "next",
    "last": "last"
  },
  "data": [
    {
      "id": {
        "Value": "Value"
      },
      "name": "name",
      "amount": 0,
      "currency": "currency",
      "period": "period",
      "status": "status",
      "currentSpend": 0,
      "percentUsed": 0,
      "spendAvailability": "spendAvailability",
      "alerts": [
        {
          "thresholdPercent": 0,
          "isTriggered": true,
          "triggeredAt": "2024-08-25T15:00:00Z"
        }
      ],
      "createdAt": "2024-08-25T15:00:00Z",
      "updatedAt": "2024-08-25T15:00:00Z"
    }
  ]
}

json

application/json

Create budget

POST

https://api.costfluent.com

/v1/budgets

Bearer (API token)

Creates a new budget with optional alert thresholds

Create budget › Request Body

CostfluentPublicApiModelsV1RequestsCreateBudgetRequest

CostfluentSharedKernelPublicIdsWorkspacePublicId · minLength: 1 · required

name

string · minLength: 0 · maxLength: 200 · required

currency

string · minLength: 3 · maxLength: 3 · required

amount

number · double

period

string

array | null

segmentId

string | null

Create budget › Responses

Success

CostfluentPublicApiModelsV1ResponsesBudgetResponse

CostfluentSharedKernelPublicIdsBudgetPublicId · required

spendAvailability

string · required

name

string

amount

number · double

currency

string

period

string

status

string

currentSpend

number | null · double

percentUsed

number | null · double

CostfluentPublicApiModelsV1ResponsesBudgetAlertResponse[]

createdAt

string · date-time

updatedAt

string | null · date-time

POST/v1/budgets

curl https://api.costfluent.com/v1/budgets \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "workspaceId": {
    "Value": "Value"
  },
  "name": "name",
  "amount": 0.1,
  "currency": "currency",
  "period": "period",
  "alerts": [
    {
      "thresholdPercent": 0
    }
  ],
  "segmentId": "segmentId"
}'

Example Request Body

{
  "workspaceId": {
    "Value": "Value"
  },
  "name": "name",
  "amount": 0.1,
  "currency": "currency",
  "period": "period",
  "alerts": [
    {
      "thresholdPercent": 0
    }
  ],
  "segmentId": "segmentId"
}

json

Example Responses

{
  "id": {
    "Value": "Value"
  },
  "name": "name",
  "amount": 0,
  "currency": "currency",
  "period": "period",
  "status": "status",
  "currentSpend": 0,
  "percentUsed": 0,
  "spendAvailability": "spendAvailability",
  "alerts": [
    {
      "thresholdPercent": 0,
      "isTriggered": true,
      "triggeredAt": "2024-08-25T15:00:00Z"
    }
  ],
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z"
}

json

application/json

Get budget

GET

https://api.costfluent.com

/v1/budgets/{budgetId}

Bearer (API token)

Returns a specific budget with current spend

Get budget › path Parameters

CostfluentSharedKernelPublicIdsBudgetPublicId · required

Get budget › Responses

Success

CostfluentPublicApiModelsV1ResponsesBudgetResponse

CostfluentSharedKernelPublicIdsBudgetPublicId · required

spendAvailability

string · required

name

string

amount

number · double

currency

string

period

string

status

string

currentSpend

number | null · double

percentUsed

number | null · double

CostfluentPublicApiModelsV1ResponsesBudgetAlertResponse[]

createdAt

string · date-time

updatedAt

string | null · date-time

Update budget

PUT

https://api.costfluent.com

/v1/budgets/{budgetId}

Bearer (API token)

Updates a budget name, amount, or filter

Update budget › path Parameters

CostfluentSharedKernelPublicIdsBudgetPublicId · required

Update budget › Request Body

CostfluentPublicApiModelsV1RequestsUpdateBudgetRequest

name

string | null

amount

number | null · double

segmentId

string | null

Update budget › Responses

Success

CostfluentPublicApiModelsV1ResponsesBudgetResponse

CostfluentSharedKernelPublicIdsBudgetPublicId · required

spendAvailability

string · required

name

string

amount

number · double

currency

string

period

string

status

string

currentSpend

number | null · double

percentUsed

number | null · double

CostfluentPublicApiModelsV1ResponsesBudgetAlertResponse[]

createdAt

string · date-time

updatedAt

string | null · date-time

PUT/v1/budgets/{budgetId}

curl https://api.costfluent.com/v1/budgets/:budgetId \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "name",
  "amount": 0,
  "segmentId": "segmentId"
}'

Example Request Body

{
  "name": "name",
  "amount": 0,
  "segmentId": "segmentId"
}

json

Example Responses

{
  "id": {
    "Value": "Value"
  },
  "name": "name",
  "amount": 0,
  "currency": "currency",
  "period": "period",
  "status": "status",
  "currentSpend": 0,
  "percentUsed": 0,
  "spendAvailability": "spendAvailability",
  "alerts": [
    {
      "thresholdPercent": 0,
      "isTriggered": true,
      "triggeredAt": "2024-08-25T15:00:00Z"
    }
  ],
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z"
}

json

application/json

Delete budget

DELETE

https://api.costfluent.com

/v1/budgets/{budgetId}

Bearer (API token)

Deletes a budget and its alert configuration

Delete budget › path Parameters

CostfluentSharedKernelPublicIdsBudgetPublicId · required

Delete budget › Responses

No Content

No data returned

Contracting Billing

Costfluent Public API

Budgets

Server

Download schema

List budgets

GET

https://api.costfluent.com

/v1/budgets

Bearer (API token)

Returns all budgets, optionally filtered by workspace

List budgets › query Parameters

page

integer · int32 · required

limit

integer · int32 · required

workspaceId

List budgets › Responses

Success

CostfluentPublicApiModelsV1CommonPaginatedResponseOfBudgetResponse

CostfluentPublicApiModelsV1CommonPaginationLinks · required

CostfluentPublicApiModelsV1ResponsesBudgetResponse[] · required

GET/v1/budgets

curl 'https://api.costfluent.com/v1/budgets?page=<number>&limit=<number>' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "links": {
    "self": "self",
    "first": "first",
    "prev": "prev",
    "next": "next",
    "last": "last"
  },
  "data": [
    {
      "id": {
        "Value": "Value"
      },
      "name": "name",
      "amount": 0,
      "currency": "currency",
      "period": "period",
      "status": "status",
      "currentSpend": 0,
      "percentUsed": 0,
      "spendAvailability": "spendAvailability",
      "alerts": [
        {
          "thresholdPercent": 0,
          "isTriggered": true,
          "triggeredAt": "2024-08-25T15:00:00Z"
        }
      ],
      "createdAt": "2024-08-25T15:00:00Z",
      "updatedAt": "2024-08-25T15:00:00Z"
    }
  ]
}

json

application/json

Create budget

POST

https://api.costfluent.com

/v1/budgets

Bearer (API token)

Creates a new budget with optional alert thresholds

Create budget › Request Body

CostfluentPublicApiModelsV1RequestsCreateBudgetRequest

CostfluentSharedKernelPublicIdsWorkspacePublicId · minLength: 1 · required

name

string · minLength: 0 · maxLength: 200 · required

currency

string · minLength: 3 · maxLength: 3 · required

amount

number · double

period

string

array | null

segmentId

string | null

Create budget › Responses

Success

CostfluentPublicApiModelsV1ResponsesBudgetResponse

CostfluentSharedKernelPublicIdsBudgetPublicId · required

spendAvailability

string · required

name

string

amount

number · double

currency

string

period

string

status

string

currentSpend

number | null · double

percentUsed

number | null · double

CostfluentPublicApiModelsV1ResponsesBudgetAlertResponse[]

createdAt

string · date-time

updatedAt

string | null · date-time

POST/v1/budgets

curl https://api.costfluent.com/v1/budgets \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "workspaceId": {
    "Value": "Value"
  },
  "name": "name",
  "amount": 0.1,
  "currency": "currency",
  "period": "period",
  "alerts": [
    {
      "thresholdPercent": 0
    }
  ],
  "segmentId": "segmentId"
}'

Example Request Body

{
  "workspaceId": {
    "Value": "Value"
  },
  "name": "name",
  "amount": 0.1,
  "currency": "currency",
  "period": "period",
  "alerts": [
    {
      "thresholdPercent": 0
    }
  ],
  "segmentId": "segmentId"
}

json

Example Responses

{
  "id": {
    "Value": "Value"
  },
  "name": "name",
  "amount": 0,
  "currency": "currency",
  "period": "period",
  "status": "status",
  "currentSpend": 0,
  "percentUsed": 0,
  "spendAvailability": "spendAvailability",
  "alerts": [
    {
      "thresholdPercent": 0,
      "isTriggered": true,
      "triggeredAt": "2024-08-25T15:00:00Z"
    }
  ],
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z"
}

json

application/json

Get budget

GET

https://api.costfluent.com

/v1/budgets/{budgetId}

Bearer (API token)

Returns a specific budget with current spend

Get budget › path Parameters

CostfluentSharedKernelPublicIdsBudgetPublicId · required

Get budget › Responses

Success

CostfluentPublicApiModelsV1ResponsesBudgetResponse

CostfluentSharedKernelPublicIdsBudgetPublicId · required

spendAvailability

string · required

name

string

amount

number · double

currency

string

period

string

status

string

currentSpend

number | null · double

percentUsed

number | null · double

CostfluentPublicApiModelsV1ResponsesBudgetAlertResponse[]

createdAt

string · date-time

updatedAt

string | null · date-time

Update budget

PUT

https://api.costfluent.com

/v1/budgets/{budgetId}

Bearer (API token)

Updates a budget name, amount, or filter

Update budget › path Parameters

CostfluentSharedKernelPublicIdsBudgetPublicId · required

Update budget › Request Body

CostfluentPublicApiModelsV1RequestsUpdateBudgetRequest

name

string | null

amount

number | null · double

segmentId

string | null

Update budget › Responses

Success

CostfluentPublicApiModelsV1ResponsesBudgetResponse

CostfluentSharedKernelPublicIdsBudgetPublicId · required

spendAvailability

string · required

name

string

amount

number · double

currency

string

period

string

status

string

currentSpend

number | null · double

percentUsed

number | null · double

CostfluentPublicApiModelsV1ResponsesBudgetAlertResponse[]

createdAt

string · date-time

updatedAt

string | null · date-time

PUT/v1/budgets/{budgetId}

curl https://api.costfluent.com/v1/budgets/:budgetId \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "name",
  "amount": 0,
  "segmentId": "segmentId"
}'

Example Request Body

{
  "name": "name",
  "amount": 0,
  "segmentId": "segmentId"
}

json

Example Responses

{
  "id": {
    "Value": "Value"
  },
  "name": "name",
  "amount": 0,
  "currency": "currency",
  "period": "period",
  "status": "status",
  "currentSpend": 0,
  "percentUsed": 0,
  "spendAvailability": "spendAvailability",
  "alerts": [
    {
      "thresholdPercent": 0,
      "isTriggered": true,
      "triggeredAt": "2024-08-25T15:00:00Z"
    }
  ],
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z"
}

json

application/json

Delete budget

DELETE

https://api.costfluent.com

/v1/budgets/{budgetId}

Bearer (API token)

Deletes a budget and its alert configuration

Delete budget › path Parameters

CostfluentSharedKernelPublicIdsBudgetPublicId · required

Delete budget › Responses

No Content

No data returned

Contracting Billing