Criar uma assinatura

POST https://sandbox.staging.justa.com.vc/payment-provider/api/subscription/default

Este end-point tem como objetivo realizar a criação de uma assinatura e suas cobranças recorrentes.

Resposta da requisição

Variável	Tipo	Descrição
id	Number	Identificador da assinatura
status	SubscriptionStatus	Status atual da assinatura
customer	SubscriptionCustomer	Dados do cliente da assinatura
type	String	Tipo da recorrência. Atualmente apenas "DEFAULT"
creationDate	Date	Data de criação da assinatura
firstCharge	Date	Data da primeira cobrança a ser realizada
plan	PlanResponse	Plano da recorrência
chargeDay	Number	Dia da cobrança das cobranças recorrentes - nulo em caso de Plano semanal (period = WEEKLY)
creditCard	CreditCard	Dados mascarados retornados do cartão de crédito
charges	ChargeResponse[ ]	Lista das cobranças recorrentes

SubscriptionStatus

Variável	Descrição
GENERATED	A assinatura gerada, mas ainda não foi confirmada. Aguardando processo de validação do cartão de crédito
ACTIVE	A assinatura está ativa e as cobranças serão realizadas normalmente
PAYED	A assinatura paga completamente
TO_CANCEL	A assinatura cancelada, mas ainda não foi possível cancelar todas as cobranças
CANCELED	A assinatura e suas cobranças foram canceladas
BLOCKED	A assinatura bloqueada por falha no pagamento

SubscriptionCustomer

Variável	Tipo	Descrição
name	String	Nome do assinante da recorrência
phone	String	Número do telefone do assinante da recorrência
email	String	Endereço de e-mail do assinante da recorrência
legalDocument	String	Documento legal do assinante da recorrência
birthDate	Date	Data de aniversário do assinante da recorrência

PlanResponse

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

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

Variável	Tipo	Descrição
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

ChargeResponse

Variável	Tipo	Descrição
id	Number	Id da cobrança que foi buscada
order	String	Número de ordem da cobrança
description	String	Descrição da cobrança
softDescriptor	String	Descrição dos dados de fatura do cartão de crédito do cliente
date	Date	Data da cobrança
totalValue	Number	Valor total da cobrança recorrente
subscriptionId	Number	Identificador da assinatura da qual a cobrança pertence
status	ChargeStatus	Status atual da cobrança
installment	Number	Número da parcela a qual a determinada cobrança se refere
reference	String	Número de referencia da cobrança de recorrência

ChargeStatus

Variável	Descrição
PAYED	Cobrança paga
TO_CANCEL	Cobrançaem processo de cancelada dado o cancelamento de uma assinatura
CANCELED	Cobrança cancelada dado o cancelamento de uma assinatura
FAILED	Todas as tentativas de cobrança falharam
RETRY	A tentativa de cobrança falhou e deve ser realizada novamente
PENDING	A cobrança está pendente e deverá ser realizada na sua data
BLOCKED	A cobrança está bloqueada tendo em devido a falta de pagamento

CreditCard

Variável	Tipo	Descrição
flag	String	Bandeira do cartão
card	String	Número mascarado do cartão
holder	String	Nome no cartão