Sign in
latestOpenAPI 3.0.02026-08-1411579732.4 KB

6bf9c0ba354b

Subscripciones
Subscriptions

Suscribir a un cliente

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

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

post/subscriptions/subscription

Parameters

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

Request body

signatureSignature required— unresolved $ref
planExternalId required— unresolved $ref
customerExternalId required— unresolved $ref
additional_dataAdditionalData required— unresolved $ref
total_payment_numberTotalPaymentNumber required— unresolved $ref
payment_attempts_limitnumber 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_datestring nullable

Por defecto es la fecha actual. Si se indica permite especificar el momento en el que se realizará el primer pago.

Example request

{
  "signature": "121149a0ba5361191d740fa898784a8b",
  "customer": "customer name",
  "plan": "plan",
  "additional_data": {
    "additional": "Datos extra",
    "customer_ext_id": "customer322",
    "operative": "AUTHORIZATION",
    "service": "60A1F4C0-CC58-47A9-A0B9-868F9EF29045",
    "source_uuid": "C10721E7-1404-45DC-8762-351DD9945D1D",
    "url_post": "https://yourdomain.com/subscriptions/notify"
  },
  "initial_date": "2019",
  "payment_attempts_limit": 3,
  "total_payment_number": 3
}

Response

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