Get Active Subscriptions for a User

This endpoint will return all active subscriptions for a customer and can optionally be filtered with a list of entitlements, returning an empty array if no matches are found. These entitlements correspond to the featureIds of product features as described in the products endpoint. This endpoint can therefore be used to check what products the customer should be able to buy and which they already own.

Header Parameters

X-API-Keystring
Authorizationstring

Query Parameters

entitlementsstring

Filter for comma-separated list of entitlement IDs

Response

200
Object
List of subscriptions

Response Attributes

idstring

The user ID

entitlementstring

The ID of the Stripe Product Feature that the user is entitled to

productIdstring

The product ID

subscriptionIdstring

The Stripe subscription ID

statusstring

The subscription status

expirystring

The subscription expiry date (if applicable)

lastModifiedstring

The date the subscription was last modified

401
Object
Unauthorized - Missing or invalid JWT token

Response Attributes

messagestring

Error message

codestring

Error code

detailsobject

Additional error details

500
Object
Server error - check errors field for specific error type

Response Attributes

errorsstring Required

Error code identifying the type of error

Enum values:
bad_requestunauthorizedforbiddennot_found500incorrect_datanot_memberalready_memberincorrect_stripe_signatureincorrect_stripe_event
... 4 other enums
Was this section helpful?

What made this section unhelpful for you?

GET

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?