A valid request URL is required to generate request examples{
"entitled": true,
"reason": "<string>",
"access_until": "<string>"
}{
"error": {
"code": "INVALID_DATA",
"message": "invalid collection_method"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "SUBSCRIPTION_NOT_FOUND",
"message": "subscription not found"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Check subscription entitlement
Returns the current access decision for the subscription. The
entitled field is the access gate; access_until is informational
only and may be in the past or null while entitled is true (for
example while an automatic payment retry is in progress). Gate access
on entitled; do not use access_until as the access boundary.
A valid request URL is required to generate request examples{
"entitled": true,
"reason": "<string>",
"access_until": "<string>"
}{
"error": {
"code": "INVALID_DATA",
"message": "invalid collection_method"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "SUBSCRIPTION_NOT_FOUND",
"message": "subscription not found"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Authorizations
A merchant secret key (sk_…) sent as Authorization: Bearer <key>.
Headers
Merchant ID when an authorized Platform acts for a connected Merchant. Omit when authenticating directly as that Merchant.
^mer_[0-9A-Za-z]{14}$Path Parameters
The subscription id (sub_…).
Response
The entitlement decision.
The access decision for a subscription.
True when the subscriber has active access. Use this field as the access gate; do not use access_until as the boundary.
A human-readable explanation of the entitlement decision.
RFC 3339 timestamp of when access expires. Informational only: may be null or in the past while entitled is true (for example during dunning or when a renewal sweep is pending).