v1

latestOpenAPI 3.1.02026-07-245178279.0 KB

Planes

Obtener un plan

Este endpoint recupera los detalles de un plan de suscripción específico. Es útil para verificar las condiciones y configuraciones de un plan antes de ofrecerlo a los usuarios.

get/api/v1/merchants/plans/{plan_code}

Path parameters

plan_codestring required

Example:plan-005

Código único del plan que se desea consultar.

Headers

X-API-keystring required

Clave de autenticación para acceder a la API.

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
}