RErecurrente
subscriptions

Obtener una suscripción

Changed on

Obtén los detalles de una suscripción específica.

get/subscriptions/{id}

Request

Path parameters

idstring required

ID de la suscripción

Response

Detalles de la suscripción

idstring

ID único de la suscripción

descriptionstring

Descripción de la suscripción

status'active' | 'paused' | 'past_due' | 'cancelled'

Estado de la suscripción

created_atstring date-time

Fecha de creación

updated_atstring date-time

Última actualización

current_period_startstring date-time nullable

Inicio del período de facturación actual

current_period_endstring date-time nullable

Fin del período de facturación actual

tax_namestring nullable

Nombre fiscal del suscriptor

tax_idstring nullable

ID fiscal del suscriptor

resumes_onstring date nullable

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

next_payment_attempt_atstring date-time nullable

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. Recurrente intenta cobrar una vez al día por 15 días antes de cancelar la suscripción.

test_clock_idstring nullable

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

application_fee_percentnumber double nullable

Comisión de plataforma como porcentaje del total de cada factura. null cuando la suscripción no paga comisión.

Changes

  • 33bad9197d59Revision changes
    • info

      added the optional property to the response with the status

  • 3d76463f9fd8Revision changes
    • warning

      deleted the header request parameter X-SECRET-KEY

    • info

      the endpoint scheme security secretKey was added to the API