Skip to main content
GET
/
v1
/
contracts
/
{contractId}
/
budgets
List Credit Budgets
curl --request GET \
  --url https://api.monk.com/v1/contracts/{contractId}/budgets \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "budgets": [
      {
        "index": 123,
        "label": "<string>",
        "eventPropertyKey": "<string>",
        "eventPropertyValue": "<string>",
        "meterId": "<string>",
        "maxCredits": 123,
        "maxCreditsCents": 123,
        "isExhausted": true
      }
    ],
    "contractId": "<string>",
    "walletMode": "credits"
  }
}
Returns all credit budgets configured on the contract. Each budget defines a per-dimension spending cap on the shared credit pool. The walletMode field indicates whether to use maxCredits (credit-based) or maxCreditsCents (dollar-based) when creating budgets. Scope: contracts:read

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
contractId
string
required

The unique identifier of the contract (UUID)

Response

List of budgets

​
data
object