Sign in

v1

latestOpenAPI 3.1.02026-07-24820248.4 KB

Crear Subscription

post/subscriptions

Headers

x-account-keystring

Llave única que identifica la Cuenta de cobro

Request body

customerstring required

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

product_idstring 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.

pac_mandate_idstring

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

receipt_product_codestring

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

metadatastring 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í.

is_recurringboolean

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.

due_dayinteger

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

amountnumber float

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

frequency'daily' | 'weekly' | 'monthly' | 'yearly'

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
intervalinteger

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.

creation_lead_daysinteger

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

end_datestring 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.

max_active_invoicesinteger

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.

currency_codestring

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

Response

200

idstring
product_idstring
customerstring
pac_mandate_idstring
is_recurringboolean
amountinteger
due_dayinteger

Example response

{
  "id": "sub_K3a1P1_p_t5UHJHJXmpkQYmqXCHvXrNi",
  "product_id": "92792",
  "customer": "cus_M2aYvh3QOfVylcre5gIMyIhYPrHBKfw2",
  "pac_mandate_id": "500196",
  "amount": 1000,
  "due_day": 1,
  "metadata": {
    "var1": "value1",
    "var2": "value2"
  }
}