v1

latestOpenAPI 3.1.02026-07-245178279.0 KB

Planes

Crear un Plan

Este endpoint permite a los comercios crear un nuevo plan de suscripción. Un plan define las condiciones bajo las cuales los usuarios pueden suscribirse, incluyendo detalles como periodicidad, precios y beneficios. Este endpoint es esencial para configurar productos o servicios recurrentes que los comercios ofrezcan a sus clientes.

post/api/v1/merchants/plans

Headers

X-API-keystring required

Clave de autenticación para acceder a la API.

Request body

amountnumber required

Precio del plan por ciclo de facturación. Debe expresarse en céntimos, por ejemplo si el importe es de 19,99 dólares se representará como 1999 que significa 19 dólares céntimos.

auto_renewboolean required

Indica si el plan se renueva automáticamente.

currencystring required

Moneda en la que se cobrará el plan. Debe expresarse en céntimos, por ejemplo si el importe es de 10,00 dólares se representará como 1000 que significa 10 dólares 0 céntimos.

descriptionstring

Descripción del plan.

interval_lengthinteger required

Longitud del intervalo de facturación.

interval_unitstring required

Unidad de tiempo para el intervalo de facturación.

namestring required

Nombre del plan.

plan_codestring required

Código único del plan.

price_modelstring required

Modelo de precios del plan.

setup_feenumber required

Cargo inicial para el plan.

tagsstring[]

Etiquetas asociadas al plan.

total_billing_cyclesinteger required

Número total de ciclos de facturación.

Example request

{
  "amount": 1999,
  "auto_renew": true,
  "currency": "USD",
  "description": "A descr plan for customers",
  "interval_length": 1,
  "interval_unit": "months, days",
  "name": "BASIC Plan",
  "plan_code": "plan-005",
  "price_model": "FIXED",
  "setup_fee": 1000,
  "tags": [
    "promocion_2024_12"
  ],
  "total_billing_cycles": 12
}

Response

Respuesta exitosa.

amountnumber

Precio del plan por ciclo de facturación. Debe expresarse en céntimos, por ejemplo si el importe es de 19,99 dólares se representará como 1999 que significa 19 dólares céntimos.

auto_renewboolean

Indica si el plan se renueva automáticamente.

currencystring

Moneda en la que se cobrará el plan. Debe expresarse en céntimos, por ejemplo si el importe es de 10,00 dólares se representará como 1000 que significa 10 dólares 0 céntimos.

descriptionstring

Descripción del plan.

interval_lengthinteger

Longitud del intervalo de facturación.

interval_unitstring

Unidad de tiempo para el intervalo de facturación.

merchant_idstring

ID único del comercio.

namestring

Nombre del plan.

plan_codestring

Código único del plan.

price_modelstring

Modelo de precios del plan.

setup_feenumber

Cargo inicial para el plan.

tagsstring[]

Etiquetas asociadas al plan.

total_billing_cyclesinteger

Número total de ciclos de facturación.

Example response

{
  "amount": 1999,
  "auto_renew": true,
  "currency": "USD",
  "description": "A descr plan for customers",
  "interval_length": 1,
  "interval_unit": "months, days",
  "merchant_id": "8a68caf3-2efb-4df0-8242-04bb4785c944",
  "name": "BASIC Plan",
  "plan_code": "plan-005",
  "price_model": "FIXED",
  "setup_fee": 1000,
  "tags": [
    "promocion_2024_12"
  ],
  "total_billing_cycles": 12
}