Subscription Information

Retrieve information about an existing subscription, including expiry time, payment information and recurrency status.

API scope required: subscriptions.read

Authorizations

X-API-KEY

string

headerrequired

Obtained in the Crossmint developer console

Path Parameters

subscriptionLocator

string

required

The 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>

required

Available options:

active,

expired

expiresAt

number

required

tokenLocator

string

required

collection

object

required

Show child attributes

collection.id

string

required

owner

string

required

payment

object

required

Show child attributes

payment.type

enum<string>

required

Available options:

recurring-credit-card

payment.status

enum<string>

required

Available options:

active,

cancelled

payment.recurring

object

required

Show child attributes

payment.recurring.interval

enum<string>

required

Available options:

month

payment.recurring.intervalCount

enum<number>

required

Available options:

1

payment.lastChargeDate

number

required

payment.nextChargeDate

number

required