Subscriptions allow you to charge a customer on a recurring basis.
Related guide: Creating Subscriptions.
Subscription Object
{
"id": "sub_c26WqxP13PEG0pIt2TvAGPmyK9kDnD4kGR4tri",
"object": "subscription",
"amount": 10.99,
"blockchain": "Ethereum",
"checkout_session_id": "cs_a1U7SSk86e6DUcjD9Zg7c26WqxP13PEG0pIt2TvAGPmyK9kDnD4kGR4tri",
"created": 1671995248,
"duration": 3600,
"from": "0x7C5E84A6b64435783D6A793Aeff1cd517fF8d246",
"next_charge": 1671995248,
"status": "active",
"to": "0x7C5E84A6b64435783D6A793Aeff1cd517fF8d246",
"token": "USDT",
"transaction_hash": "0x0460f2b4ae63bfb2dfc91afb0abca1ca17097651caa145c7a9a6bfd0f1e2bd48"
}
Attributes
| Attribute | Type | Description |
|---|---|---|
id | string | Unique identifier for the object. |
object | string | A string representing the object’s type. Objects of the same type share the same value. |
amount | number | The total amount of the subscription. |
blockchain | string | Blockchain of the subscription, one of BNB Smart Chain, Ethereum, Arbitrum, Optimism, Polygon, Polygon zkEVM. |
checkout_session_id | string | The ID of the Checkout Session for a link between objects. |
created | number | The time at which the Subscription was created. Measured in seconds since the Unix epoch. |
duration | number | Period of subscription in seconds. |
from | string | The address of the customer. |
next_charge | number | The time at which the next charge is. Measured in seconds from the Unix era. |
status | string | The status of the Subscription is one of active, canceled, failed, or waiting. |
to | string | The address to which the subscription payment is made. |
token | string | Token of subscription, one of USDT, USDC, DAI, and BUSD. |
transaction_hash | string | The transaction hash. |