put https://integrador.staging.justa.com.vc/payment-provider/api/subscription-plan/
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ável | Tipo | Descrição |
---|---|---|
id | Number | Identificador único do plano |
status | PlanStatus | Status do plano |
name | String | Nome do plano |
description | String | Descrição do plano |
periodicValue | Number | Valor base a ser cobrado nas parcelas do plano em centavos |
duration | Number | Tempo de duração do plano, sendo nulo = infinito |
period | PlanPeriod | Periodicidade do plano |
serviceOffered | String | Serviço oferecido pelo plano |
PlanStatus
Variável | Tipo | Descrição |
---|---|---|
ACTIVE | String | O plano está ativo e pode ser usado normalmente |
INACTIVE | String | O plano está inativo e não pode aparecer para o cliente como opção |
BLOCKED | String | O plano está bloqueado para uso |
PlanPeriod
Tipo | ||
---|---|---|
WEEKLY | String | Cobranças realizadas semanalmente |
MONTHLY | String | Cobranças realizadas mensalmente |
QUARTERLY | String | Cobranças realizadas trimestralmente |
SEMIANNUAL | String | Cobranças realizadas semestralmente |
YEARLY | String | Cobranças realizadas anualmente |