v1

latestOpenAPI 3.1.02026-07-245178279.0 KB

Planes

Obtener una lista de planes

Este endpoint proporciona una lista de planes de suscripción registrados, permitiendo aplicar filtros como estado (activo/inactivo) o etiquetas personalizadas. Es ideal para obtener una vista general o específica de los planes disponibles en el sistema.

get/api/v1/merchants/plans

Query parameters

tagstring

Example:promocion_2024_12

Filtro por etiqueta asociada al plan.

status'active' | 'inactive'

Example:active

Filtro por estado del plan.

pageinteger

Example:1

Número de la página.

sizeinteger

Example:10

Tamaño de la página.

Headers

X-API-keystring required

Clave de autenticación para acceder a la API.

Response

Lista de planes obtenida exitosamente.

pageinteger

Número de la página actual.

sizeinteger

Tamaño de la página.

Example response

{
  "data": [
    {
      "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
    }
  ],
  "page": 1,
  "size": 10
}