Retrieve a subscription
GET/subscriptions/{subscriptionId}Retrieve the current state of an on-chain subscription, including the subscriber, the contract address on the chosen chain, charge scheduling (next_charge_at, charge_nonce), and per-cycle budget tracking.
Headers
| Header | Description | Required |
|---|---|---|
| Authorization | Bearer token with your secret API key | yes |
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| subscriptionId | string | yes |
Example Request
Request
const response = await fetch('https://checkout-api.exodus-int.com/subscriptions/<subscriptionId>', {
method: 'GET',
headers: {
Authorization: 'Bearer sk_live_xxxxxxxxxxxxxxxx',
},
});Responses
| Status | Description |
|---|---|
| 200 | The requested subscription. |
| 400 | Validation error |
| 401 | Missing or invalid authentication |
| 404 | Resource not found |
Response body
| Field | Type | Required | Description |
|---|---|---|---|
| object | enum: subscription | yes | |
| id | string | yes | |
| subscriber | string | yes | |
| asset | string | yes | |
| token_symbol | string | yes | |
| token_decimals | number | yes | |
| cap_amount | string | yes | |
| price | string | yes | |
| price_currency | string | null | yes | |
| period_duration | number | yes | |
| last_charged_at | string | null | yes | |
| next_charge_at | string | null | yes | |
| charge_nonce | number | yes | |
| status | enum: active | cancelling | cancelled | yes | |
| paused | boolean | yes | |
| flagged | boolean | yes | |
| budget | string | null | yes | |
| spent_this_period | string | null | yes | |
| remaining_budget | string | null | yes | |
| created_at | string | yes | |
| subscription_manager_address | string | yes | |
| chain | string | yes | |
| cancel_url | string | null | yes | |
| subscription_checkout_id | string | null | yes |
Example Response
{
"object": "subscription",
"id": "0x9f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e2f3a",
"subscriber": "0x742d35Cc6634C0532925a3b844Bc9e7595f8fE21",
"asset": "eip155:1/erc20:0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
"token_symbol": "USDC",
"token_decimals": 6,
"cap_amount": "120000000",
"price": "9990000",
"price_currency": null,
"period_duration": 2592000,
"last_charged_at": "2026-04-19T12:02:18Z",
"next_charge_at": "2026-05-19T12:02:18Z",
"charge_nonce": 3,
"status": "active",
"paused": false,
"flagged": false,
"budget": "300000000",
"spent_this_period": "29970000",
"remaining_budget": "270030000",
"created_at": "2026-02-19T12:02:18Z",
"subscription_manager_address": "0xa1b2c3d4e5f6789012345678901234567890abcd",
"chain": "eip155:1",
"cancel_url": "https://merchant.com/cancelled",
"subscription_checkout_id": "schk_1234567890abcdef"
}Error Response
Error (e.g. 400)
{
"error": {
"type": "validation_error",
"message": "amount must be a positive number",
"param": "amount"
}
}