Subscription representan un acuerdo de cobro recurrente para un cliente. Contienen ítems de suscripción que definen qué se cobra y con qué frecuencia.
{
"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"
}
| Atributo | Tipo | Descripción |
|---|---|---|
id | string | Identificador único de la Subscription |
object | string | Identificador del tipo de objeto. Su valor siempre será subscription |
billing_cycle_anchor | string | Timestamp ISO 8601 que alinea la generación de invoices |
collection_method | string | Cómo se maneja el pago. Puede ser charge_automatically o send_invoice |
created_at | string | Fecha de creación, usando ISO 8601 |
customer | string | ID del Customer asociado a esta suscripción |
items | array | Lista de objetos de ítems de suscripción |
items[].id | string | Identificador único del ítem de suscripción |
items[].object | string | Identificador del tipo de objeto. Su valor siempre será subscription_item |
items[].price | hash | Detalles de precio del ítem |
items[].price.currency | string | Código ISO de la moneda. Por ahora, solo soportamos CLP |
items[].price.product | hash | Información del producto |
items[].price.product.name | string | Nombre del producto |
items[].price.recurring | hash | Configuración de recurrencia del cobro |
items[].price.recurring.interval | string | Frecuencia de cobro. Por ahora, solo soportamos month |
items[].price.recurring.interval_count | integer | Número de intervalos entre cobros |
items[].price.unit_amount | integer | Monto del cobro por unidad, representado como un entero |
items[].quantity | integer | Cantidad del ítem |
metadata | hash | Conjunto de pares clave-valor que puedes adjuntar a un objeto. Esto puede ser útil para almacenar información adicional sobre el objeto en un formato estructurado. |
mode | string | Indica si la Subscription está en modo live o en modo test |
payment_method | string | ID del Payment Method usado para el cobro automático. Puede ser null |
status | string | Estado de la suscripción. Puede ser active o canceled |