Skip to main content
GET
/
v1
/
billing
/
subscription
Current plan + usage-vs-limit for the tenant
curl --request GET \
  --url https://api.example.com/v1/billing/subscription \
  --header 'Authorization: Bearer <token>'
{
  "plan": "<string>",
  "used": 123,
  "included": 123,
  "hardCap": 123,
  "overageEnabled": true,
  "overage": 123,
  "blocked": true,
  "status": "<string>"
}

Authorizations

Authorization
string
header
required

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

Response

200 - application/json
plan
string
required
used
number
required
included
number
required
hardCap
number
required
overageEnabled
boolean
required
overage
number
required
blocked
boolean
required
status
string
required