Plano de Assinatura
Gerenciamento de planos
A Preme Pay proporciona aos seus usuários a funcionalidade de criar planos de assinatura personalizados. Para personalizar seus planos, primeiro é necessário fazer a criação do seu plano de assinatura. Depois de ter seu plano de assinatura criado, você só precisará vincular os consumidores aderentes, seguindo os passos descritos na seção Assinatura em planos.
A criação do plano permite adição de diferentes períodos de recorrência de pagamento, de acordo com os Códigos de Frenquência para Pagamentos Recorrentes da Preme Pay. Também é possível realizar a parametrização de períodos de carência, período de testes e isenção de pagamento. Isso quer dizer que você pode: • Implementar planos de assinatura durante o período de testes; • Possibilitar que o seu consumidor comece a pagar o plano de assinatura a partir de um prazo específico; • Incluir usuários necessários para ter acesso ao pacote de plano de assinatura, com isenção de pagamento.
O Plano de Assinatura pode ser associado a consumidores nacionais e internacionais.
Códigos de Frequência para Pagamentos Recorrentes
ID
Status
0
Diário
1
Semanal
2
Mensal
3
Trimestral
4
Semestral
5
Anual

Criar Plano de Assinatura

https://api.premepay.com/v1/stores/{storeId}/plans
Você pode criar um plano de assinatura para todas as transações pagas com Cartão de Crédito utilizando a rota acima.
Parâmetro
Tipo
Descrição
Obrigatório
name
string
Nome do plano
Sim
description
string
Descrição
Sim
frequency
integer
Frequência
Sim
paymentTypes
array[integer]
Tipo do pagamento
Sim
0
Cartão de Crédito
1
Boleto Bancário
amount
decimal
Valor
Sim
currency
string
Código alfa da moeda a ser processada. Exemplo: "GBP", "USD", "CAD"
Sim (para Planos Internacionais )
gracePeriod
integer
Período de carência
Sim

Exemplo de Requisição

Este é um exemplo de como a sua requisição para criar um plano de assinatura deve parecer. Este é o primeiro passo necessário para adicionar seus consumidores em um plano de assinatura recorrente.
{
"name": "Plano Mensal",
"description": "Descrição Plano Mensal",
"frequency": 2,
"paymentTypes": [
0
],
"amount": 67.25,
"gracePeriod": 7
}

Respostas

201: Created

Esta é a resposta para os casos em que sua requisição seja bem sucedida.
Status
Significado
0
Ativo
1
Cancelado
{
"id": 972,
"name": "Plano Mensal",
"description": "Descrição Plano Mensal",
"frequency": 2,
"paymentTypes": [
0
],
"amount": 67.25,
"gracePeriod": 7,
"status": 0
}

400: Bad Request

Esta é a resposta para os casos em que o servidor não processa a requisição devido a um erro encontrado. Alguns exemplos que podem resultar neste erro são uma URL digitada incorretamente, sintaxe malformada ou requisição de roteamento inválida.
{
"errors": [
{
"message": "Error description"
}
]
}

401: Unauthorized

Esta é a resposta para os casos em que a solicitação não foi bem sucedida porque não possui credenciais de autenticação válidas para o recurso de destino. Caso seja necessário, você pode rever o nosso processo de autenticação.
{
"error": {
"message": "Unauthorized"
}
}

403: Forbidden

Esta é a resposta para os casos em que a solicitação foi proibida. Isso acontece quando o servidor consegue entender o pedido da requisição, mas não autoriza a emissão de uma resposta de aprovação.
{
"error": {
"message": "Forbidden"
}
}

500: Internal Server Error

Esta é a resposta para os casos em que ocorre um erro interno no servidor.
{
"error": {
"message": "Internal server error"
}
}

Listar Planos de Assinatura

https://api.premepay.com/v1/stores/{storeId}/plans
Através da rota acima você receberá uma lista de todos os seus planos de assinatura cadastrados. Esta é uma lista para visualização.
Confira abaixo as respostas possíveis da API da Preme Pay para essa requisição.

Respostas

200: Ok

Esta é a resposta para os casos em que sua requisição seja bem sucedida.
[
{
"id": 972,
"name": "Plano Mensal",
"description": "Descrição Plano Mensal",
"frequency": 2,
"paymentTypes": [
0
],
"amount": 67.25,
"gracePeriod": 7,
"status": 0
}
]

401: Unauthorized

Esta é a resposta para os casos em que a solicitação não foi bem sucedida porque não possui credenciais de autenticação válidas para o recurso de destino. Caso seja necessário, você pode rever o nosso processo de autenticação.
{
"error": {
"message": "Unauthorized"
}
}

403: Forbidden

Esta é a resposta para os casos em que a solicitação foi proibida. Isso acontece quando o servidor consegue entender o pedido da requisição, mas não autoriza a emissão de uma resposta de aprovação.
{
"error": {
"message": "Forbidden"
}
}

500: Internal Server Error

Esta é a resposta para os casos em que ocorre um erro interno no servidor.
{
"error": {
"message": "Internal server error"
}
}

Excluir Plano de Assinatura

https://api.premepay.com/v1/stores/{storeId}/plans/{planId}
Você tem a possibilidade de excluir permanentemente um plano de assinatura. Tenha atenção ao realizar essa requisição já que a ação não pode ser revertida.
Ao solicitar a exclusão de um plano de assinatura, imediatamente será também desvinculado qualquer consumidor que esteja associado a este plano.
A ação de excluir um plano de assinatura é permanente e não pode ser revertida.

Respostas

200: Ok

Esta é a resposta para os casos em que sua requisição seja bem sucedida.
{
"message": "Plan deleted"
}

400: Bad Request

Esta é a resposta para os casos em que o servidor não processa a requisição devido a um erro encontrado. Alguns exemplos que podem resultar neste erro são uma URL digitada incorretamente, sintaxe malformada ou requisição de roteamento inválida.
{
"errors": [
{
"message": "Error description"
}
]
}

401: Unauthorized

Esta é a resposta para os casos em que a solicitação não foi bem sucedida porque não possui credenciais de autenticação válidas para o recurso de destino. Caso seja necessário, você pode rever o nosso processo de autenticação.
{
"error": {
"message": "Unauthorized"
}
}

403: Forbidden

Esta é a resposta para os casos em que a solicitação foi proibida. Isso acontece quando o servidor consegue entender o pedido da requisição, mas não autoriza a emissão de uma resposta de aprovação.
{
"error": {
"message": "Forbidden"
}
}

404: Not found

Esta é a resposta para os casos em que seu usuário não foi encontrado. Este é um código de resposta HTTP que indica que houve comunicação entre a requisição e o servidor, entretanto o servidor não conseguiu encontrar o que foi requerido.
{
"error": {
"message": "Plan not found"
}
}

500: Internal Server Error

Esta é a resposta para os casos em que ocorre um erro interno no servidor.
{
"error": {
"message": "Internal server error"
}
}
Copy link
Outline
Criar Plano de Assinatura
Listar Planos de Assinatura
Excluir Plano de Assinatura