Saltar al contenido principal
GET
List Subscriptions
Los elementos de la lista son un resumen, no la suscripción completaCada elemento incluye los campos necesarios para mostrar una cuadrícula, incluidos current_period_start/current_period_end. Todo lo demás (availability, retries, metadata, trial_period, payments, pending_plan_change, billing_phases y el resto de El objeto de suscripción) solo lo devuelve Consultar suscripción. Llámalo por cada elemento cuando necesites alguno de ellos.
merchant_reference no es un filtro en este endpointEnviarlo no tiene efecto: el parámetro se ignora y se devuelve la página completa, sin filtrar. Para buscar una suscripción por referencia del comercio, conserva el id que recibiste al crearla, o recorre las páginas de este endpoint y haz la coincidencia del lado del cliente.

Alcance y orden

La lista siempre está limitada a la única cuenta indicada en el encabezado X-Account-Code: no existe una variante entre cuentas. Los resultados se ordenan por created_at en orden descendente, por lo que una suscripción creada mientras recorres las páginas puede desplazar elementos entre los límites de página. Para un recorrido estable, filtra con created_at_to fijado en el momento en que empezaste. Los filtros se pueden combinar y todos son opcionales; cada uno reduce aún más el conjunto de resultados. Si no se define ninguno, se devuelven las suscripciones en todos los estados, incluidas las CANCELED y COMPLETED.

Autorizaciones

public-api-key
string
header
predeterminado:<Your public-api-key>
requerido
private-secret-key
string
header
predeterminado:<Your private-secret-key>
requerido

Encabezados

X-Account-Code
string
requerido

El account_id que se encuentra en tu Dashboard de Yuno (UUID). Obligatorio: la lista siempre se limita a una sola cuenta. Omitirlo devuelve 400 INVALID_PARAMETERS ("x-account-code header is required.").

Parámetros de consulta

customer_id
string

Filtra por el cliente que es dueño de la suscripción (customer_payer.id, UUID). Un valor que no es un UUID devuelve 400 BAD_REQUEST ("Invalid customer_id.").

Ejemplo:

"3t04911d-5df9-429e-8488-ad41abea1a2c"

status
string

Filtra por estado. Acepta varios valores separados por comas, que coinciden con cualquiera de ellos: ACTIVE,PAUSED. Los valores deben escribirse exactamente como en Estados de la suscripción; un valor desconocido devuelve 400 BAD_REQUEST ("Invalid status: FOO.").

Ejemplo:

"ACTIVE,PAUSED"

plan_id
string

Filtra por el plan al que está vinculada la suscripción (UUID). Un plan sin suscriptores, o uno que no existe, devuelve una lista vacía, no un error. Un valor que no es un UUID devuelve 400 BAD_REQUEST ("Invalid plan_id.").

Ejemplo:

"00000000-0000-4000-8000-000000000001"

created_at_from
string

Devuelve solo las suscripciones creadas en este instante o después (ISO 8601 con desfase, inclusive). Un valor que no se puede interpretar devuelve 400 BAD_REQUEST ("Invalid created_at_from.").

Ejemplo:

"2024-01-01T00:00:00Z"

created_at_to
string

Devuelve solo las suscripciones creadas en este instante o antes (ISO 8601 con desfase, inclusive). Un valor que no se puede interpretar devuelve 400 BAD_REQUEST ("Invalid created_at_to.").

Ejemplo:

"2024-12-31T23:59:59Z"

payment_method_type
string

Filtra por el tipo de método de pago de la suscripción, por ejemplo CARD.

Ejemplo:

"CARD"

page
integer
predeterminado:1

Número de página con índice desde 1. Debe ser >= 1, de lo contrario 400 BAD_REQUEST ("The page must be greater than or equal to 1.").

Rango requerido: x >= 1
size
integer
predeterminado:20

Tamaño de página. Debe estar entre 1 y 100 inclusive, de lo contrario 400 BAD_REQUEST ("The size must be greater than or equal to 1." si es demasiado bajo, "The size must be at most 100." si es demasiado alto).

Rango requerido: 1 <= x <= 100

Respuesta

200

items
object[]
pagination
object