Retrieve spend caps

Retrieve spend caps

GET/api/v1/spend-caps

GET /spend-caps
curl -X GET 'https://www.unitpost.com/api/v1/spend-caps' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'
Response · 200
{
  "object": "spend_caps",
  "sms_purchases": {
    "cap_cents": 0,
    "max_cents": 0,
    "spent_cents": 0,
    "period_start": "string",
    "period_end": "string"
  },
  "shared_plan": {
    "cap_cents": 0,
    "spent_cents": 0,
    "period_start": "string",
    "period_end": "string"
  }
}

The workspace's monthly spend caps and what each has counted this period. sms_purchases caps the SMS carrier purchases API keys and apps confirm (POST /sms/quotes/{id}/confirm): the fee due now plus the first month of a monthly fee, per UTC calendar month; dashboard purchases never count. cap_cents is the cap as set (null: none, so every API purchase is refused with 403 api_spend_cap_not_set); the cap that applies is the lower of it and max_cents ($1,000 a month by default). A workspace that starts a paid plan on its own card starts with a $75 cap when it has none, unless a key or app of it already holds sms:purchase (a workspace its organization pays for follows the organization Owner's rules instead; a key still needs sms:purchase to buy). shared_plan is the workspace's cap on its organization's shared plan and what it drew from it this period (null when it isn't on one); its organization sets it. Requires the sms:read or sms:purchase or spend_caps:write capability.

Response · 200 fields3 fields
FieldTypeDescription
objectrequiredstring—
sms_purchasesrequiredobjectSMS purchases by API (`POST /sms/quotes/{id}/confirm`). Purchases made in the dashboard never count.
shared_planobject | nullThe workspace's cap on its organization's shared plan, read-only: its organization sets it (`PATCH /organizations/{id}/shared-plan/workspaces/{workspace_id}`). Null when the workspace isn't on a shared plan.
200401403404422

Search docs and guides

Search the docs and product guides.