Subscriptions
Subscription Information
Retrieve information about an existing subscription, including expiry time, payment information and recurrency status.
API scope required: subscriptions.read
GET
/
2022-06-09
/
subscriptions
/
{subscriptionLocator}
Authorizations
X-API-KEY
string
headerrequiredObtained in the Crossmint developer console
Path Parameters
subscriptionLocator
string
requiredThe unique identifier for the subscription, formatted as chain:contractAddress:tokenId
.
This locator references the specific token associated with the subscription.
Response
200 - application/json
status
enum<string>
requiredAvailable options:
active
, expired
expiresAt
number
requiredtokenLocator
string
requiredcollection
object
requiredowner
string
requiredpayment
object
required