Subscription objects represent a recurring billing arrangement for a customer. They contain subscription items that define what is being charged and how often.
{
"id": "sub_456789abcdef",
"object": "subscription",
"billing_cycle_anchor": "2025-08-01T00:00:00Z",
"collection_method": "charge_automatically",
"created_at": "2025-08-01T12:00:00Z",
"customer": "cus_01234567",
"items": [
{
"id": "si_89abcdef0123",
"object": "subscription_item",
"price": {
"currency": "CLP",
"product": {
"name": "Pro Plan"
},
"recurring": {
"interval": "month",
"interval_count": 1
},
"unit_amount": 15000
},
"quantity": 1
}
],
"metadata": {},
"mode": "live",
"payment_method": null,
"status": "active"
}
| Attribute | Type | Description |
|---|---|---|
id | string | Unique identifier for the Subscription |
object | string | Identifier for the type of object. Its value will always be subscription |
billing_cycle_anchor | string | ISO 8601 timestamp that aligns invoice generation |
collection_method | string | How payment is handled. Can be charge_automatically or send_invoice |
created_at | string | Creation date, using ISO 8601 |
customer | string | Customer ID associated with this subscription |
items | array | List of subscription item objects |
items[].id | string | Unique identifier for the subscription item |
items[].object | string | Identifier for the type of object. Its value will always be subscription_item |
items[].price | hash | Pricing details for the item |
items[].price.currency | string | Currency ISO code. For now, we only support CLP |
items[].price.product | hash | Product information |
items[].price.product.name | string | Product name |
items[].price.recurring | hash | Billing recurrence settings |
items[].price.recurring.interval | string | Billing frequency. For now, we only support month |
items[].price.recurring.interval_count | integer | Number of intervals between charges |
items[].price.unit_amount | integer | Charge amount per unit, represented as an integer |
items[].quantity | integer | Quantity of the item |
metadata | hash | Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. |
mode | string | Indicates whether the Subscription is in live mode or in test mode |
payment_method | string | Payment Method ID used for automatic charging. It can be null |
status | string | Subscription status. Can be active or canceled |