post/v3/plans

Request

  • Base URL
    https://gateway-154.netpaydev.com/gateway-ecommerce
  • URL
    https://gateway-154.netpaydev.com/gateway-ecommerce/v3/plans
  • Auth
    none required

Headers

Content-Typestring

application/json

Authorizationstring

SecretKey

Request body

amountnumber double required

Monto o precio base del plan

currencystring required

Divisa

frecuencyinteger required

Número de veces que se cobrará el plan según el intervalo de tiempo especificado

intervalstring required

Intervalo de tiempo en el que se cobrará el plan (DAILY, WEEKLY, MONTHLY, YEARLY)

namestring required

Nombre del plan

trialDaysinteger required

Días de prueba del plan

expiryCountinteger required

Número de veces que se cobrará la suscripción

variableAmountboolean required

Bandera que indica si el plan es de monto variable o no

dayStartPaymentinteger required
selfRetriesboolean required

Bandera que indica los intentos de cobro automáticos en caso de fallo

selfRenewalboolean required

Bandera que indica si el plan se renovará de forma automática

terminalViewboolean required
identifierstring required

Identificador del plan (definido por el comercio)

Response

201

idstring
namestring
amountinteger
currencystring
intervalstring
frecuencyinteger
trialDaysinteger
expiryCountinteger
activeboolean
variableAmountboolean
selfRetriesboolean
selfRenewalboolean
terminalViewboolean
deprecatedboolean
dayStartPaymentinteger
identifierstring
nextBillingStartstring
createdAtstring

Example response

{
  "id": "kcyHG_yPHGoSgE9GLydZGnTWxasplE",
  "name": "Plan Gimnasio 2",
  "amount": 300,
  "currency": "MXN",
  "interval": "MONTHLY",
  "frecuency": 1,
  "expiryCount": 12,
  "active": true,
  "variableAmount": true,
  "selfRetries": true,
  "selfRenewal": true,
  "dayStartPayment": 1,
  "identifier": "plan-gimnasio-2",
  "nextBillingStart": "2020-08-01T15:56:57.839+0000",
  "createdAt": "2020-07-31T15:56:57.835+0000"
}

Changes