Convenciones generales
Paginación
Los endpoints de listado (GET /plans, GET /subscriptions, GET /charges, GET /customers) aceptan limit y offset como parámetros de query y devuelven la información de paginación junto con los datos.
El valor máximo de limit es 100. Valores mayores deben rechazarse o serán truncados por la API.
Según el recurso, la respuesta puede venir como:
{ "data": [ ... ], "total": 0, "limit": 20, "offset": 0 }
o
{ "data": [ ... ], "pagination": { "total": 0, "limit": 20, "offset": 0 } }
Casing de parámetros y campos
Atención: Nombres de campos
La casing de query params y campos de body no es uniforme entre recursos. Verificar la tabla de cada endpoint antes de integrar:
| Recurso | Query params de filtro | Campos de body |
|---|---|---|
| Plans | camelCase (pricingType, billingFrequency, externalReference) | snake_case (pricing_type, billing_frequency, merchant_id) |
| Subscriptions | camelCase (planId, customerId, createdAfter, createdBefore) | snake_case (pause_until, cancel_at_period_end, payment_method_id) |
| Charges | snake_case (subscription_id, created_after, created_before) | — |
| Customers | camelCase (createdAfter) | — |
Manejo de errores
Ver Manejo de errores.