Skip to main content
GET
GET /subscription devuelve una lista paginada de tus suscripciones. Filtra por estado, correo o nombre del cliente, plan, bandera de tarjeta o rango de fecha de creación para acotar los resultados. Los resultados se devuelven en orden cronológico inverso por fecha de creación. Filtra y pagina con los parámetros de consulta del panel de arriba (created_from/created_to son límites de fecha ISO 8601 inclusivos sobre createdAt). Forma de la respuesta:
Combina created_from y created_to con status=past_due para identificar a los suscriptores que se volvieron morosos dentro de una ventana específica — útil para campañas de recuperación dirigidas.

Autorizaciones

Authorization
string
header
requerido

Your secret API key: Bearer prv_production_xxx (production) or Bearer prv_sandbox_xxx (sandbox).

Parámetros de consulta

merchantCode
string
requerido

Your merchant account identifier.

status
string

Filter by status: pending, trialing, active, past_due, suspended, cancelled, paused, completed.

email
string

Partial, case-insensitive match on customer email.

customer_name
string

Partial, case-insensitive match on customer name.

plan_id
string

Filter to one plan ID.

card_brand
string

Filter by card brand, e.g. visa, mastercard, amex.

created_from
string

ISO 8601 date lower bound (inclusive) on creation date.

created_to
string

ISO 8601 date upper bound (inclusive) on creation date.

page
integer

Page number, starting at 1. Default 1.

per_page
integer

Results per page. Default 20, max 200.

Respuesta

200 - application/json

List of subscriptions

data
object[]
total
integer

Total subscriptions matching the filters, across all pages.

page
integer

Current page number.

per_page
integer

Page size applied.