Criar plano

ℹ️

Antes de usar este endpoint, recomendamos fortemente que você leia a documentação completa da recorrência.

Ela explica em detalhes como funcionam os modelos de plano (fixo e personalizado), configurações de cobrança imediata, comportamento por meio de pagamento, regras de desconto e cancelamento de assinaturas.

Compreender esses conceitos evita falhas na integração e garante que sua solução utilize o sistema de assinaturas de forma eficiente, segura e aderente às boas práticas da plataforma.


🚧

Limitações

  • Esse mecanismo não possui ambiente de Sandbox.

Exemplos de requisições

{
    "PlanOption": 1,
    "PlanFrequence": 1,
    "Name": "Plano Básico",
    "Amount": "19.90",
    "Description": "Plano básico com propagandas",
    "ChargeDay": 10,
    "SubscriptionTax": 5.5,
    "SubscriptionLimit": 12,
    "IsImmediateCharge": true,
    "IsProRata": true,
    "DaysBeforeChargeDateExpiration": 5,
    "PenaltyAmount": 2,
    "InterestAmount": 1,
    "DaysDue": 10,
    "IsRetryCharge": true,
    "CallbackUrl": "https://webhook.site/b0c49583-b905-4426-b4c7-7e857385d201",
    "BillingCycle": 60
}
{
    "PlanOption": 2,
    "PlanFrequence": 1,
    "Name": "Plano Básico",
    "Amount": "19.90",
    "Description": "Plano básico com propagandas",
    "SubscriptionTax": 5.5,
    "SubscriptionLimit": 12,
    "IsImmediateCharge": true,
    "DaysBeforeChargeDateExpiration": 5,
    "PenaltyAmount": 2,
    "InterestAmount": 1,
    "DaysDue": 10,
    "IsRetryCharge": true,
    "CallbackUrl": "https://webhook.site/b0c49583-b905-4426-b4c7-7e857385d201",
    "BillingCycle": 60
}

Body Params
integer
required
integer
required
string
required
double
required
integer
integer
string
double
integer
boolean
Defaults to false
boolean
Defaults to false
integer
integer
string
integer
string
double
double
integer
date
double
boolean
Defaults to false
Responses

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