---
title: "Obtener una subscripción"
method: GET
path: "/subscriptions/subscription/{subscription_id}"
tags: ["Subscripciones", "Subscriptions"]
---

# Obtener una subscripción

`GET /subscriptions/subscription/{subscription_id}`

Obtener una subscripción por su ID.

## Path parameters

- `subscription_id` string, required

## Parameters

- `#/paths/~1/get/parameters/0` — unresolved $ref

## Response `200`

OK

- object
  - `subscription` Subscription
    - `id` string, required — El ID único de la subscripción.
    - `active` boolean, required — Indica si la subscripción está activa o no.
    - `status` 'CREATED' | 'ISSUED' | 'DENIED' | 'FAILED_NOTIFICATION' | 'PAID', required — El estado actual de la subscripción.
    - `total_payment_number` number, required — Número total de pagos que se realizarán a lo largo de la suscripción.
    - `total_payment_charged` number, required — Número total de pagos que se han hecho hasta la fecha.
    - `payment_attempts_limit` TotalPaymentNumber, required — unresolved $ref
    - `first_charge_date` string, required — La fecha en la que se realizará o realizó el primer cobro.
    - `next_charge_date` string, required — La fecha en la que se realizará el próximo cobro.
    - `additional_data` object, required — Datos adicionales para procesar el pago.
      - `customer_ext_id` ExternalId, required — unresolved $ref
      - `operative` Operative, required — unresolved $ref
      - `source_uuid` Uuid, required — unresolved $ref
      - `service` ServiceUuid, required — unresolved $ref
      - `url_post` UrlPost — unresolved $ref
      - `additional` Additional — unresolved $ref
    - `created_at` Created, required — unresolved $ref
    - `updated_at` UpdatedAt, required — unresolved $ref
    - `plan` Plan, required — El plan establece muchas variables que pueden utilizarse para personalizar el intervalo, importe y tiempo de prueba de una subscripción.
      - `amount` number, required — Cantidad a cobrar, en la moneda fraccionaria elegida. Una cantidad de 100 utilizando la moneda Euro es igual a 1€.
      - `created_at` Created, required — unresolved $ref
      - `external_id` string, required — ID externo otorgado por el comercio para identificar de forma única a un plan.
      - `interval` number, required — Intervalo en la unidad indicada en el campo `interval_type` que determina cada cuánto tiempo debe cobrarse la subscripción.
      - `interval_offset` number — Intervalo en la unidad indicada en el campo `interval_offset_type` que determina la unidad de tiempo que dura el periodo de prueba de la subscripción.
      - `interval_offset_type` 'DAILY' | 'WEEKLY' | 'MONTHLY' | 'YEARLY' — Unidad de tiempo que determina la unidad de tiempo que dura el periodo de prueba de la subscripción. Requerido si se indica el campo `interval_offset`.
      - `interval_type` 'DAILY' | 'WEEKLY' | 'MONTHLY' | 'YEARLY', required — Unidad de tiempo que determina la unidad de tiempo que dura el periodo de prueba de la subscripción. Requerido si se indica el campo `interval_offset`.
      - `name` string, required — Nombre del plan.
      - `product` Product, required — El producto de la subscripción. A esta entidad se asocian planes.
        - `created_at` Created, required — unresolved $ref
        - `external_id` string, required — ID externo otorgado por el comercio para identificar de forma única a un producto.
        - `name` string, required — Nombre del producto.
        - `notification_url` string — URL que recibirá una notificación HTTP cuando el pago cambie de estado.
        - `sandbox` boolean, required — Indica sí el producto pertenece al entorno de sandbox.
        - `updated_at` UpdatedAt, required — unresolved $ref
      - `trial_available` boolean — Por defecto, false. Indica si hay periodo de prueba. Hasta que éste no termine no se realizará el primer cobro.
      - `updated_at` string, required — Fecha de última actualización de la entidad.
    - `payments` SubscriptionPayment[]
      - `amount` Amount, required — unresolved $ref
      - `attempt` string, required — El número de intentos desde el último intento de pago de subscripción exitoso.
      - `created_at` Created, required — unresolved $ref
      - `id` string, required — El ID único del pago de la subscripción.
      - `payment_date` string, required — Fecha en la que se procesará o procesó el pago.
      - `payment_details` string, nullable — Cadena de texto en formato JSON con información adicional del pago en Paylands.
      - `payment_number` string, required — El número del pago de la subscripción.
      - `status` 'OK' | 'KO', required — Status del pago de la subscripción.
      - `updated_at` UpdatedAt, required — unresolved $ref

---

[API](https://skmtc.net/paylands/apis/documentacio-n-de-paylands.md) · [All operations](https://skmtc.net/paylands/apis/documentacio-n-de-paylands/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/paylands/documentacio-n-de-paylands/revisions/6bf9c0ba354b/schema)