Listar suscripciones | Documentación API de Recurrente

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

[
  {
    "id": "su_nehndm7j",
    "description": "One Free-Testable Banana",
    "status": "active",
    "created_at": "2024-01-15T09:30:00Z",
    "updated_at": "2024-01-15T09:30:00Z",
    "current_period_start": "2024-01-15T09:30:00Z",
    "current_period_end": "2024-01-15T09:30:00Z",
    "tax_name": "string",
    "tax_id": "string",
    "resumes_on": "2023-01-15",
    "next_payment_attempt_at": "2024-01-15T09:30:00Z",
    "payment_retries": 0,
    "default_payment_method": {
      "id": "pay_m_7v5ie3pw",
      "type": "card",
      "card": {
        "last4": "4242",
        "network": "visa"
      }
    },
    "subscriber": {
      "id": "us_rdctav2g",
      "first_name": "string",
      "last_name": "string",
      "full_name": "Fela Kuti",
      "email": "test@user.com",
      "phone_number": "string"
    },
    "checkout": {
      "id": "string"
    },
    "product": {
      "id": "string"
    }
  }
]

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

Authentication

X-PUBLIC-KEYstring

Tu llave pública de API

X-SECRET-KEYstring

Tu llave secreta de API

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

idstring

ID único de la suscripción

descriptionstring

Descripción de la suscripción

statusenum

Estado de la suscripción

Allowed values:

created_atdatetime

Fecha de creación

updated_atdatetime

Última actualización

current_period_startdatetime or null

Inicio del período de facturación actual

current_period_enddatetime or null

Fin del período de facturación actual

tax_namestring or null

Nombre fiscal del suscriptor

tax_idstring or null

ID fiscal del suscriptor

resumes_ondate or null

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

next_payment_attempt_atdatetime or null

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

payment_retriesinteger

Número de reintentos de cobro realizados para el período actual

default_payment_methodobject or null

Método de pago predeterminado de la suscripción

subscriberobject

checkoutobject or null

productobject