GET
/
2022-06-09
/
subscriptions
/
{subscriptionLocator}
curl --request GET \
  --url https://staging.crossmint.com/api/2022-06-09/subscriptions/{subscriptionLocator} \
  --header 'X-API-KEY: <api-key>'
{
  "status": "active",
  "expiresAt": 1731984105000,
  "tokenLocator": "base:0xdC46584d76aCcc879d682Ed2d9c7338f8FdbF1cC:1",
  "collection": {
    "id": "28c5bc10-1964-4d94-b45b-0e1dab1cd346"
  },
  "owner": "0x62e2cb5f9Ac87cf91358395fdB6797ADb7EA9E38",
  "payment": {
    "type": "recurring-credit-card",
    "status": "active",
    "recurring": {
      "interval": "month",
      "intervalCount": 1
    },
    "lastChargeDate": 1731984105000,
    "nextChargeDate": 1731984105000
  }
}

Authorizations

​
X-API-KEY
string
header
required

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.

Example:

"base:0x1234567890123456789012345678901234567890:1"

Response

200
application/json
Subscription information
​
status
enum<string>
required
Available options:
active,
expired
​
expiresAt
number
required
Example:

1731984105000

​
tokenLocator
string
required
Example:

"base:0xdC46584d76aCcc879d682Ed2d9c7338f8FdbF1cC:1"

​
collection
object
required
​
owner
string
required
Example:

"0x62e2cb5f9Ac87cf91358395fdB6797ADb7EA9E38"

​
payment
object
required

Was this page helpful?

Cancel Subscription