Listar suscripciones

GET

https://app.recurrente.com/api/subscriptions

GET

/api/subscriptions

$ curl https://app.recurrente.com/api/subscriptions \
>      -H "X-SECRET-KEY: <apiKey>"

200Retrieved

1 [
2   {
3     "id": "su_nehndm7j",
4     "description": "One Free-Testable Banana",
5     "status": "active",
6     "created_at": "2024-01-15T09:30:00Z",
7     "updated_at": "2024-01-15T09:30:00Z",
8     "current_period_start": "2024-01-15T09:30:00Z",
9     "current_period_end": "2024-01-15T09:30:00Z",
10     "tax_name": "string",
11     "tax_id": "string",
12     "resumes_on": "2023-01-15",
13     "next_payment_attempt_at": "2024-01-15T09:30:00Z",
14     "payment_retries": 0,
15     "metadata": {},
16     "test_clock_id": "string",
17     "default_payment_method": {
18       "id": "pay_m_7v5ie3pw",
19       "type": "card",
20       "card": {
21         "last4": "4242",
22         "network": "visa"
23       }
24     },
25     "subscriber": {
26       "id": "us_rdctav2g",
27       "first_name": "string",
28       "last_name": "string",
29       "full_name": "Fela Kuti",
30       "email": "test@user.com",
31       "phone_number": "string"
32     },
33     "checkout": {
34       "id": "string"
35     },
36     "product": {
37       "id": "string"
38     },
39     "transfer_setups": [
40       {
41         "id": "tr_4a7b9c8d",
42         "status": "pending",
43         "amount_in_cents": 1,
44         "amount_percent": 1.1,
45         "currency": "string",
46         "recipient_id": "ac_123456",
47         "purpose": "fund_split"
48       }
49     ]
50   }
51 ]

Lista todas las suscripciones de tu cuenta con paginación, ordenadas de la más reciente a la más antigua.

Authentication

X-SECRET-KEYstring

Tu clave secreta de API.

Una llave de cuenta (sk_live_..., sk_test_...) opera sobre su propia cuenta y, con X-ACCOUNT-ID, sobre sus cuentas conectadas.

Una llave de organización (sk_org_live_..., sk_org_test_...) alcanza todas las cuentas de una organización y solo sirve para leer: saldos, movimientos y reportes. Para operar sobre una cuenta debe nombrarla con X-ACCOUNT-ID; omitirlo en una lectura devuelve todas las cuentas de la organización. Cualquier otro endpoint responde 403 con code: organization_key_unsupported.

Tu clave secreta de API. Una llave de cuenta (`sk_live_...`, `sk_test_...`) opera sobre su propia cuenta y, con `X-ACCOUNT-ID`, sobre sus cuentas conectadas. Una llave de organización (`sk_org_live_...`, `sk_org_test_...`) alcanza todas las cuentas de una organización y solo sirve para leer: saldos, movimientos y reportes. Para operar sobre una cuenta debe nombrarla con `X-ACCOUNT-ID`; omitirlo en una lectura devuelve todas las cuentas de la organización. Cualquier otro endpoint responde `403` con `code: organization_key_unsupported`.

Query parameters

pageintegerOptional>=1Defaults to 1

Número de página (empezando en 1)

itemsintegerOptional1-100Defaults to 10

Elementos por página

Response

Lista de suscripciones

idstringOptional

ID único de la suscripción

descriptionstringOptional

Descripción de la suscripción

statusenumOptional

Estado de la suscripción

created_atdatetimeOptional

Fecha de creación

updated_atdatetimeOptional

Última actualización

current_period_startdatetime or nullOptional

Inicio del período de facturación actual

current_period_enddatetime or nullOptional

Fin del período de facturación actual

tax_namestring or nullOptional

Nombre fiscal del suscriptor

tax_idstring or nullOptional

ID fiscal del suscriptor

resumes_ondate or nullOptional

Fecha de reactivación automática (si está pausada)

next_payment_attempt_atdatetime or nullOptional

Próximo intento de cobro automático (solo cuando el estado es past_due)

payment_retriesintegerOptional

Número de reintentos de cobro realizados para el período actual. Recurrente intenta cobrar una vez al día por 15 días antes de cancelar la suscripción.

metadatastring or double or booleanOptional

Metadata persistida durante todo el ciclo de vida de la suscripción y expuesta en sus webhooks.

test_clock_idstring or nullOptional

ID del test clock heredado del Customer. Solo está presente en un Sandbox nombrado.

default_payment_methodobject or nullOptional

Método de pago predeterminado de la suscripción

subscriberobjectOptional

checkoutobject or nullOptional

productobjectOptional

transfer_setupslist of objectsOptional

Transferencias automáticas recurrentes de esta suscripción. En cada cobro exitoso, cada una transfiere su amount_percent del total de la factura a la cuenta destinataria.