API Reference
Log In

Criar um plano

Este endpoint tem como objetivo realizar a criação de um plano, passo necessário para a criação de uma assinatura. Para geração de um plano, é necessário enviar apenas os dados obrigatórios presentes no formulário de criação.

Resposta da requisição

VariávelTipoDescrição
idNumberIdentificador único do plano
statusPlanStatusStatus do plano
nameStringNome do plano
descriptionStringDescrição do plano
periodicValueNumberValor base a ser cobrado nas parcelas do plano em centavos
durationNumberTempo de duração do plano, sendo nulo = infinito
periodPlanPeriodPeriodicidade do plano
serviceOfferedStringServiço oferecido pelo plano

PlanStatus

VariávelTipoDescrição
ACTIVEStringO plano está ativo e pode ser usado normalmente
INACTIVEStringO plano está inativo e não pode aparecer para o cliente como opção
BLOCKEDStringO plano está bloqueado para uso

PlanPeriod

Tipo
WEEKLYStringCobranças realizadas semanalmente
MONTHLYStringCobranças realizadas mensalmente
QUARTERLYStringCobranças realizadas trimestralmente
SEMIANNUALStringCobranças realizadas semestralmente
YEARLYStringCobranças realizadas anualmente
Language
Authorization
Header
Click Try It! to start a request and see the response here!