API Reference
Log In

Atualizar um plano

Esta requisição é utilizado para os casos em que é necessário alterar algum dos campos presente em um plano.

Os campos disponível para atualiazação são (name, description, serviceOffered, periodicValue, duration, period).

📘

A atualização não afeta plano presentes em assinaturas

As atualizações em planos não irão afetar os planos já vinculados a uma assinatura, e sim as futuras assinaturas que virão a ser vinculados a este plano.
Para alterar um plano já presente em uma assinatura, acesse a pagina de alteração de plano atrelado a uma assintura.

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!