Skip to main content
POST
get customer entitlements

Authorizations

Authorization
string
header
required

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

Body

application/json

Body of the request

customerId
string
required

The customer ID

Example:

"cus_1H7KQFLr7RepUyQBKdnvY"

projectId
string

The project ID

Example:

"prj_1H7KQFLr7RepUyQBKdnvY"

Response

The result of the get customer entitlements

id
string
required
Maximum string length: 36
projectId
string
required
Maximum string length: 36
createdAtM
number
required
updatedAtM
number
required
customerId
string
required
Maximum string length: 36
featurePlanVersionId
string
required
Maximum string length: 36
subscriptionId
string | null
required
Maximum string length: 36
subscriptionPhaseId
string | null
required
Maximum string length: 36
subscriptionItemId
string | null
required
Maximum string length: 36
effectiveAt
number
required
expiresAt
number | null
required
overageStrategy
enum<string>
required
Available options:
none,
last-call,
always
metadata
object | null
required
featurePlanVersion
object
required
grants
object[]
subscriptionPhase
object | null