---
title: "Suscribir a un cliente"
method: POST
path: "/subscriptions/subscription"
tags: ["Subscripciones", "Subscriptions"]
---

# Suscribir a un cliente

`POST /subscriptions/subscription`

Suscribe a un cliente a un plan, dado el ID externo del plan y el cliente, entre otros. Si el parámetro `trial_available` del plan es `false`, se realiza un cobro inmediatamente tras suscribir al cliente.

Si alguno de los parámetros (UUID de servicio o tarjeta, por ejemplo) es incorrecto la subscripción se registrará pero el pago no podrá realizarse. En este caso el `status` será `FAILED_NOTIFICATION`. Un ejemplo de la notificación enviada al `notification_url` del Producto es el siguiente:

~~~
{
    "payment_id": "5dfa00a4229c1a127749ae9e",
    "subscription": "5dfa00a4229c1a127749ae9d",
    "plan": "plan_external_id",
    "product": "product_external_id",
    "customer": "customer_external_id",
    "company": "FF255421-F4B7-47E9-9816-949F5F03DE6F",
    "status": "FAILED_NOTIFICATION",
    "payment_date": "2019-12-18T10:34:12.640Z",
    "payment_number": 1,
    "attempt": 1,
    "amount": 1,
    "currency": "978"
}
~~~

![sub_diag_seq_1](https://paylands-web-assets.s3-eu-west-1.amazonaws.com/docs/subscripciones_diag_seq_subscripcion_fallida.png "Registro de subscripción fallido")

Si todos los parámetros son correctos, el pago se realizará y Paylands enviará la notificación habitual a la `post_url` indicada en la Subscripción. También se enviará una notificación a la `notification_url` del Producto. Un ejemplo de esta notificación se detalla en la segunda respuesta de ejemplo a este endpoint.

![sub_diag_seq_2](https://paylands-web-assets.s3-eu-west-1.amazonaws.com/docs/subscripciones_diag_seq_subscripcion_exitosa.png "Registro de subscripción exitoso")

## Parameters

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

## Request body

- object
  - `signature` Signature, required — unresolved $ref
  - `plan` ExternalId, required — unresolved $ref
  - `customer` ExternalId, required — unresolved $ref
  - `additional_data` AdditionalData, required — unresolved $ref
  - `total_payment_number` TotalPaymentNumber, required — unresolved $ref
  - `payment_attempts_limit` number, required — Número máximo de intentos para cobrar una suscripción. Si el cobro de una suscripción falla X veces consecutivas, la suscripción se cancela.
  - `initial_date` string, nullable — Por defecto es la fecha actual. Si se indica permite especificar el momento en el que se realizará el primer pago.

## Response `200`

Ejemplo de notificación enviada al endpoint indicado en el `payment_url` del Producto.

- object
  - `status` object
    - `amount` Amount, required — unresolved $ref
    - `attempt` Attempt, required — unresolved $ref
    - `company` string, required — ID externo otorgado por el comercio para identificar de forma única a una compañía.
    - `currency` Currency, required — unresolved $ref
    - `customer` ExternalId, required — unresolved $ref
    - `payment_date` PaymentDate, required — unresolved $ref
    - `payment_id` Id, required — unresolved $ref
    - `payment_number` PaymentNumber, required — unresolved $ref
    - `plan` ExternalId, required — unresolved $ref
    - `product` ExternalId, required — unresolved $ref
    - `status` 'CREATED' | 'ISSUED' | 'DENIED' | 'FAILED_NOTIFICATION' | 'PAID', required — El estado actual de la subscripción.
    - `subscription` Id, 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)