HomeGuíasAPI ReferenceChangelog
Log In
API Reference
  1. Recursos principales
  2. Subscriptions

Crear Subscription

post
https://api.trytoku.com/subscriptions

Crea una Subscription o actualiza la existente si coincide el identificador.

Se usa para dar de alta el cobro de un producto a un Customer. Es idempotente por (Account, product_id): si ya existe una Subscription con ese product_id, se actualiza y la respuesta es 200; si es nueva, se crea y la respuesta es 201. Para un cobro recurrente envía is_recurring=true junto con la configuración de recurrencia (frecuencia, intervalo, monto, día de vencimiento).

Límite de tasa: 20 solicitudes por segundo. Al superarlo, la API responde 429. Ver Límites de tasa.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
number
≥ 0

Monto de cada Invoice de la Subscription, en la unidad mínima de la moneda.

integer
≥ 0

Días de anticipación con los que se crea cada Invoice antes de su vencimiento.

string
enum

Moneda de la Subscription en formato ISO 4217.

Allowed:
string
required

Identificador público del Customer (cus_...) dueño de la Subscription.

integer
1 to 31

Día de vencimiento de las Invoices. Para las frecuencias mensual y anual es el día del mes (1–31); para la semanal, el día de la semana (1 = lunes).

date

Fecha hasta la cual la Subscription genera Invoices. Si es null, no tiene término.

string
enum

Unidad con la que avanza el ciclo de cobro. Se combina con interval, que dice cada cuántas de esas unidades se cobra, y determina cómo se lee due_day: daily cobra todos los días y no lo usa; weekly lo interpreta como día de la semana, de 1 (lunes) a 7 (domingo); monthly y yearly lo interpretan como día del mes y lo recortan al último día cuando el mes es más corto —un due_day 31 cae el 28 en febrero y el ciclo siguiente vuelve al 31—.

Allowed:
integer
1 to 52

Número de unidades de frequency entre cada Invoice (por ejemplo, 2 con frecuencia mensual genera una Invoice cada dos meses).

boolean
Defaults to false

Indica si la Subscription es recurrente, es decir, si genera Invoices de forma periódica y automática.

integer
≥ 1

Número máximo de Invoices activas (impagas) que la recurrencia mantiene en simultáneo.

metadata
object
string

Identificador del mandato PAC asociado a la Subscription.

string
required
length ≥ 1

Identificador del producto de la organización asociado a la Subscription.

string
length ≤ 8
Headers
string

Llave de API de una Account, para operar sobre esa Account en lugar de la principal.

date

Versión del API para esta petición, como cualquier fecha YYYY-MM-DD. Fija el contrato de la respuesta; si se omite, se deriva de la fecha de creación de la organización.

Responses

Updated 5 days ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 days ago

Did this page help you?