Create Plan

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Descripción de la respuesta recibida

idUnique idString
namePlan NameString
amountPlan amountNumber
currencyPlan Currency(only MXN)String
intervalIntervals in which the subscription will be executedInt
frecuencyPlan Frecuency(daily,weekly,monthly,yearly)String
trialDaysTrial days of a planInt
expiryCountIndicates the number of times the subscription will be executedString
activeIndicates if plan is activeBoolean
variableAmountIndicates if the price of the plan can vary in each charging periodBoolean
selfRetriesIndicates if the plan will be reinstated if billing failsBoolean
selfRenewalIndicates if the plan will be renewedBoolean
terminalViewindicates whether the plan will appear on the smart terminalBoolean
deprecatedThe plan can no longer receive subscriptions, but it still operatesBoolean
dayStartPaymentindicates the day you will start collecting (only applies for variable amount)Int
identifierUnique user-provided indicatorString
nextBillingStartNext Billing of PlanString
createdAtCreation dateString
Body Params
double
required
Defaults to 300

Monto o precio base del plan

string
required
Defaults to MXN

Divisa

int32
required
Defaults to 1

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

string
required
Defaults to MONTHLY

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

string
required
Defaults to Plan Gimnasio 2

Nombre del plan

int32
required
Defaults to 0

Días de prueba del plan

int32
required
Defaults to 12

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

boolean
required
Defaults to false

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

int32
required
Defaults to 1
boolean
required
Defaults to true

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

boolean
required
Defaults to true

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

boolean
required
Defaults to false
string
required
Defaults to plan-gimasio-2

Identificador del plan (definido por el comercio)

Headers
string
Defaults to SecretKey

SecretKey

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json