API Reference

Crear Subscription

post
https://api.trytoku.com/subscriptions
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

ID del Customer entregado en su creación. No es posible cambiar el Customer de una Subscription ya creada

string
required

Identificador interno del producto que genera el Invoice. Puede ser un número de contrato o de propuesta. Debe ser único por Cuenta de cobro.

string

Identificador del mandato que se pondrá al inscribir un PAC.

string

Clave del producto o servicio para emitir una factura del SAT. Aplica solo para módulo de facturación México.

json

Valores adicionales específicos de cada producto. Son tratados como valores de texto y que no pueden tener más de 256 caracteres cada uno. Debes agregarlos en la webapp de Toku antes de poder utilizarlos aquí.

boolean
Defaults to false

Parámetro que permite crear invoices todos los meses automáticamente. Importante: Al crear invoices automáticamente, estas se crean tomando en cuenta la moneda de la account asociada.

int32

Día del mes para la fecha de vencimiento. Solo aplica en caso de que is_recurring sea true.

float

Monto de la deuda que se generará automáticamente. Solo aplica en caso que is_recurring sea true.

string
enum

Cada cuanto se cobra en deudas generadas automáticamente, se usa en conjunto a interval. Solo aplica en caso que is_recurring sea true.

Ejemplos:

Cobrar mensualmente

  • frequency = 'monthly'
  • interval = 1

Cobrar semestralmente

  • frequency = 'monthly'
  • interval = 6
Allowed:
integer

Multiplicador de cada cuanto se cobra en deudas generadas automáticamente, se usa en conjunto a frequency. Solo aplica en caso que is_recurring sea true.

integer

Cuantos días antes del due_day se genera la deuda. Solo aplica en caso que is_recurring sea true

date

Fecha en la que finaliza automáticamente la suscripción y deja de generar deudas. Solo aplica en caso que is_recurring sea true.

integer

Cantidad máxima de invoices no pagadas que puede tener una suscripción antes de que pause automáticamente su generación de deudas. Solo aplica en caso que is_recurring sea true.

string

Código de la currency a utilizar para deudas generadas automáticamente, si no se entrega se usa el valor por defecto de la account. Solo aplica en caso que is_recurring sea true

Headers
string

Llave única que identifica la Cuenta de cobro

Responses

Updated 9 days ago

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

Updated 9 days ago