Skip to main content
GET
/
v1
/
billing
/
subscription
Get Subscription
curl --request GET \
  --url https://api.polysimulator.com/v1/billing/subscription \
  --header 'X-API-Key: <api-key>'
{
  "plan": "<string>",
  "status": "<string>",
  "current_period_end": "<string>",
  "cancel_at_period_end": false,
  "trial_ends_at": "<string>",
  "interval": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

Issue from /v1/keys (or admin-issued for enterprise tier).

Headers

​
authorization
string | null

Response

Successful Response

​
plan
string
required
​
status
string
required
​
current_period_end
string | null
​
cancel_at_period_end
boolean
default:false
​
trial_ends_at
string | null
​
interval
string | null