v1

latestOpenAPI 3.1.02026-07-24820248.4 KB

Editar Subscription

put/subscriptions/{id}

Path parameters

idstring required

ID de la Subscription entregado en su creación.

Headers

x-account-keystring

Llave única que identifica la Cuenta de cobro

Request body

product_idstring

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.

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.

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

{"stackTrail":"paths:/subscriptions/{id}:put:responses:200:content:application/json:schema:properties:amount","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/subscriptions/{id}:put:responses:200:content:application/json:schema:properties:due_day","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/subscriptions/{id}:put:responses:200:content:application/json:schema:properties:receipt_product_code","oasType":"schema","type":"unknown"}

Example response

{
  "id": "sub_K3a1P1_p_t5UHJHJXmpkQYmqXCHvXrNi",
  "product_id": "92792",
  "customer": "cus_M2aYvh3QOfVylcre5gIMyIhYPrHBKfw2",
  "pac_mandate_id": "500196",
  "metadata": {
    "car_brand": "Toyota"
  }
}