Planos - 3run01/marketplace GitHub Wiki

O serviço de planos é um conjunto de webservices que disponibiliza operação de venda recorrente através de cartão de crédito, boleto e wallet, com base em políticas de cobrança pré-definidas, como frequência da cobrança, valor, forma de pagamento, período de carência e tolerância em caso de atraso.

Um plano define como assinaturas serão vendidas, renovadas e faturadas. Por exemplo, uma academia pode possuir um "Plano mensal" que é renovado automaticamente todo mês, ou um "Plano bimestral", renovado automaticamente a cada dois meses.

Na criação de planos é possível informar a frequência (frequency) de cobrança do plano, podendo ser diário, mensal, semanal ou anual, bem como o intervalo (interval) de cobrança com base na frequência definida, ou seja, caso a frequência seja mensal e o intervalo dois (02) a cobrança será feita a cada dois meses.

Planos são gerenciados por marketplace, sendo possível criar múltiplos planos com diferentes políticas de cobrança, cada qual com seu valor em centavos, formas de pagamentos permitidas, período de carência para primeira cobrança e prazo de tolerância em caso de atraso no pagamento.

O objeto plano

frequency (string), (Obrigatório) - Frequencia de cobrança (Diário = dialy, Mensal = monthly, Semanal = weekly, Anual = annually).
interval (integer), (Obrigatório) - intervalo entre frequencia de cobrança.
amount (integer), (Obrigatório) - Valor do plano (Ex: R$ 10,00 = 10 ou R$ 10,50 = 10.50).
description (string), (Obrigatório) - Descrição do plano.
name (string), (Obrigatório) - Nome do plano.
grace_period (integer) - perído (dias) de carência para a primeira cobrança do plano.
tolerance_period (integer) - perído de tolerancia caso haja falha de pagamento.
duration (integer) - tempo de duração do plano em relação à frequencia escolhida.

Criar plano

Cria um objeto plano.

Curl --request POST\
--header "Content-Type: application/json" \
--Authorization Bearer SEU TOKEN \
--url api/v1/plans \

--data'{
	"frequency":"monthly",
	"amount":"10",
	"description": "DESCRIÇÃO DO PLANO",
	"name": "NOME DO PLANO",
	"interval": "1",
	"grace_period" : "0",
	"tolerance_period":"0",
	"duration":"0",
	"currency":"BRL"
}'

Alterar plano

Altera um objeto plano

Curl --request PUT\
--header "Content-Type: application/json" \
--Authorization Bearer SEU TOKEN \
--url api/v1/plans \
--data'{
	"frequency":"monthly",
	"amount":"15",
	"description": "DESCRIÇÃO DO PLANO",
	"name": "NOME DO PLANO",
	"interval": "1",
	"grace_period" : "0",
	"tolerance_period":"0",
	"duration":"0",
	"currency":"BRL"
}'

Buscar plano

Retorna um objeto plano.

Curl --request GET\
--header "Content-Type: application/json" \
--Authorization Bearer SEU TOKEN \
--url api/v1/plans/{plan_id} \

Listar planos

Lista todos os planos cadastrado em sua conta.

Curl --request GET\
--header "Content-Type: application/json" \
--Authorization Bearer SEU TOKEN \
--url api/v1/plans/ \

Remover plano

Remove um objeto plano

Curl --request DELETE\
--header "Content-Type: application/json" \
--Authorization Bearer SEU TOKEN \
--url api/v1/plans/{plan_id} \
⚠️ **GitHub.com Fallback** ⚠️