Skip to main content
GET
Get customer entitlements

Authorizations

Authorization
string
header
required

Use sk_test_ keys for sandbox. Use sk_live_ keys for production. Obtain your key from the dashboard.

Path Parameters

id
string
required

Response

Entitlement status

object
enum<string>
Available options:
entitlements
subscription_id
string | null
Example:

"sub_01JABC..."

state
enum<string> | null
Available options:
active,
trialing,
past_due,
grace,
delinquent,
paused,
canceled
Example:

"active"

has_access
boolean

True if the customer should have access to paid features. Active, trialing, past_due, and grace all return true.

Example:

true

tier
enum<string>
Available options:
full,
free
Example:

"full"

features
string[]
Example: