support
Volver a la documentación
Buscar
Categoria
Tags
parámetros principalesdesplegar todo
subscriptionId
shopId
paymentMethodToken
orderId
metadata
[1]
:
effectDate
cancelDate
initialAmount
initialAmountNumber
amount
currency
pastPaymentsNumber
totalPaymentsNumber
rrule
description
Pruébame
Documentación

Respuesta de la suscripción

Objeto que contiene información relativa a una suscripción.

Referencia de la respuesta

subscriptionId

Identificador de la recurrencia.

Formato

shopId

Identificación de la tienda.

Formato

paymentMethodToken

Token asociado a un medio de pago.

Formato

orderId

Referencia de pedido definida por el vendedor. No admite los caracteres UTF-8.

Formato

metadata

Valores personalizados adjuntos a la transacción, en formato json.

Ejemplo de llamada

Por ejemplo, para transmitir un valor personalizado, agregue a su solicitud:

{
    "metadata": {
        "MyValueKey": "1234"
    }
}

Este valor se devolverá en el objeto de transacción recién creado.

También puede utilizar los metadatos " orderInfo ", " orderInfo2 " y " orderInfo3 " para transmitir la información adicional sobre el pedido.

Estos datos se muestran en el Back Office Vendedor, en la información de la transacción (pestaña Extra ).

Formato

effectDate

Fecha de inicio de la suscripción en formato ISO 8601 definido por W3C.

Formato

cancelDate

Fecha de cancelación de la suscripción.

Formato

initialAmount

Monto de los primeros vencimientos. Su valor debe ser un entero positivo (por ejemplo: 1234 por EUR 12.34).

Formato

initialAmountNumber

Número de cuotas a las que se aplicará el monto definido en initalAmount.

Formato

amount

Monto de los vencimientos de la recurrencia, excepto las posiblemente definidas por.

El valor se expresa en la fracción monetaria más pequeña de la divisa.

Formato

currency

La moneda utilizada para el pago de cuotas de suscripción. Código alfabético un mayúsculas según ISO 4217 alpha-3.

Ejemplo: "EUR" para el euro.

Valores posibles

. Los valores posibles son:

Moneda CODIFICACIÓN ISO 4217 Unidad fraccionaria
Dollar australien (036) AUD
Dólar canadiense (124) CAD 2
Corona danesa (208) DKK 2
Yen (392) JPY 0
Corona noruega (578) NOK 2
Corona sueca (752) SEK 2
Franco suizo (756) CHF 2
Libra esterlina (826) GBP 2
Dólar estadounidense (840) USD 2
Euro (978) EUR 2

Formato

pastPaymentsNumber

Número de desembolsos vencidos.

Formato

totalPaymentsNumber

Número total de pagos.

Formato

rrule

Descripción de la regla de la suscripción bajo la forma de rrule (RFC-5545).

Para más información sobre cómo administrar una RRULE:

  • Especificación de una RRULE
  • Generador de RRULE
  • Ejemplos de reglas de recurrencia

Pour des raisons techniques, il est impossible de définir des périodes d'abonnement inférieures à une journée.
Les mots clés "SECONDLY" / "MINUTELY" / "HOURLY" ne sont donc pas pris en compte.

Formato

description

Descripción asociada a la suscripción.

Formato