Get subscription handlers

Returns the tenant’s current subscription details, or 404 if no subscription is on file. Required scope: read

GET /api/v1/billing/subscription

cURL

curl --request GET \
  --url 'https://api.nsr.stateset.com/api/v1/billing/subscription' \
  --header "X-API-Key: $STATESET_NSR_API_KEY"

200

{
  "cancel_at_period_end": true,
  "current_period_end": "string",
  "status": "pending",
  "subscription_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "tier": "string"
}

Returns the tenant’s current subscription details, or 404 if no subscription is on file.

Required scope: read

Response

SubscriptionResponse

cancel_at_period_end · boolean · required

current_period_end · string

status · string · required

subscription_id · string

tier · string · required

Status codes

Code	Meaning
200	Subscription details
401	Unauthorized — missing or invalid credentials
403	Forbidden — the key/token lacks the required scope
404	No subscription found
429	Rate limited — see Retry-After / X-RateLimit-Reset
503	Billing not configured

cURL

curl --request GET \
  --url 'https://api.nsr.stateset.com/api/v1/billing/subscription' \
  --header "X-API-Key: $STATESET_NSR_API_KEY"

200

{
  "cancel_at_period_end": true,
  "current_period_end": "string",
  "status": "pending",
  "subscription_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "tier": "string"
}