Assinatura em Planos
Saiba como fazer o gerenciamento dos seus planos de assinatura já existentes.
Ao ter um Plano de Assinatura cadastrado, você poderá gerenciar usuários associados a este Plano de Assinatura. Adicionar o seu consumidor em um plano de assinatura, atualizar uma assinatura e realizar uma exclusão de assinatura são algumas das possibilidades de gerenciamento. O Plano de Assinatura contempla os mercados nacionais e internacionais.
Você já possui um Plano de Assinatura? Você poderá cadastrar usuários em Planos de Assinaturas depois de ter um Plano de Assinatura existente. Aprenda a criar um Plano de Assinatura aqui.

Adicionar Assinatura em Plano

https://api.premepay.com/v1/stores/{storeId}/subscriptions
Utilizando a rota acima você pode adicionar uma assinatura em um plano de pagamento. Lembre que esta ação apenas será válida quando você possuir um plano de assinatura cadastrado. Para Planos Internacionais, o elemento "currency" deve ser inserido no corpo da requisição.
Parâmetro
Tipo
Descrição
Obrigatório
fingerprint
string
Identificador único da sessão do usuário
Não
includeFeeTransfer
boolean
Indica se taxas devem ser repassadas ao consumidor
Não
planId
integer
Identificador do plano
Sim
customerId
integer
Identificador do consumidor
Sim
currency
string
Código alfa da moeda a ser processada. Exemplo: "GBP", "USD", "CAD"
Sim (para Planos Internacionais )
payment
object
Informações do pagamento
Sim
type
string
Tipo de pagamento
Sim
credit
Cartão de Crédito
boleto
Boleto Bancário
pix
Pix
cardId
integer
Identificador do cartão
Obrigatório se type for credit

Exemplo de Requisição

Este é um exemplo de como a sua requisição para adicionar uma assinatura em um plano de assinatura deve parecer.
{
"fingerPrint": "db69792c-3b10-11eb-adc1-0242ac120002",
"includeFeeTransfer": false,
"planId": 94651,
"customerId": 2345,
"payment": {
"type": "credit",
"cardId": 76564
}
}

Respostas

200: Created

Esta é a resposta para os casos em que sua requisição seja bem sucedida.
Status
Significado
active
Ativo
canceled
Cancelado
pending
Pendente
{
"id": 326,
"paymentType": "Credit",
"lastPayment": "2020-11-19T12:56:44.9751303Z",
"nextPayment": "2020-11-20T12:56:46.7298388Z",
"status": "Active",
"createdOn": "2020-11-19T12:56:44.919751Z",
"plan": {
"id": 1111,
"name": "Plano Mensal",
"amount": 99.00,
"gracePeriod": 0,
"frequency": "Monthly",
"status": "Active"
},
"customer": {
"id": 2345,
"firstName": "Jorge Noah",
"surname": "Barbosa",
"identificationNumber": "90202017940",
"birthdate": "1975-10-10",
"email": "[email protected]",
"phone": "(48) 998711234"
},
"orders": [
{
"id": 198564,
"storeId": 7591,
"number": "P278050",
"includeFeeTransfer": false,
"amount": 275.50,
"netAmount": 270.00,
"fee": 5.50,
"description": "Descrição da venda",
"status": "Succeded",
"createdOn": "2020-07-24T13:35:03.145Z",
"customer": {
"id": 2345,
"firstName": "Jorge Noah",
"surname": "Barbosa",
"birthdate": "1975-10-10",
"identificationNumber": "90202017940",
"email": "[email protected]",
"phone": "(48) 998711234"
},
"payment": {
"id": 197485,
"number": "b10da7c0347b40cc8c34664cb60445c0",
"amount": 275.50,
"type": "Credit",
"installments": 5,
"card": {
"cardBrand": "Visa",
"holderName": "Jorge Noah Barbosa",
"expirationMonth": 2,
"expirationYear": 2026,
"firstDigits": "4539",
"lastDigits": "5497"
},
"fraudScore": {
"score": 37.06
},
"createdOn": "2020-07-24T13:35:03.145Z",
"status": "Succeded"
}
}
]
}

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"
}
],
"status": 400,
"detail": "Error details"
}

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.
{
"status": 401
}

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.
{
"status": 403
}

500: Internal Server Error

Esta é a resposta para os casos em que ocorre um erro interno no servidor.
{
"status": 500,
"detail": "Error details"
}

Detalhes da Assinatura

https://api.premepay.com/v1/stores/{storeId}/subscriptions/{subscriptionId}
Com a API da Preme Pay e a rota acima você pode visualizar os detalhes de uma assinatura.

Respostas

200: Ok

Esta é a resposta para os casos em que sua requisição seja bem sucedida.
{
"id": 326,
"paymentType": "Credit",
"lastPayment": "2020-11-19T12:56:44.9751303Z",
"nextPayment": "2020-11-20T12:56:46.7298388Z",
"status": "Active",
"createdOn": "2020-11-19T12:56:44.919751Z",
"plan": {
"id": 1111,
"name": "Plano Mensal",
"amount": 99.00,
"gracePeriod": 0,
"frequency": "Monthly",
"status": "Active"
},
"customer": {
"id": 2345,
"firstName": "Jorge Noah",
"surname": "Barbosa",
"identificationNumber": "90202017940",
"birthdate": "1975-10-10",
"email": "[email protected]",
"phone": "(48) 998711234"
},
"orders": [
{
"id": 198564,
"storeId": 7591,
"number": "P278050",
"includeFeeTransfer": false,
"amount": 275.50,
"netAmount": 270.00,
"fee": 5.50,
"description": "Descrição da venda",
"status": "Succeded",
"createdOn": "2020-07-24T13:35:03.145Z",
"customer": {
"id": 2345,
"firstName": "Jorge Noah",
"surname": "Barbosa",
"birthdate": "1975-10-10",
"identificationNumber": "90202017940",
"email": "[email protected]",
"phone": "(48) 998711234"
},
"payment": {
"id": 197485,
"number": "b10da7c0347b40cc8c34664cb60445c0",
"amount": 275.50,
"type": "Credit",
"installments": 5,
"card": {
"cardBrand": "Visa",
"holderName": "Jorge Noah Barbosa",
"expirationMonth": 2,
"expirationYear": 2026,
"firstDigits": "4539",
"lastDigits": "5497"
},
"fraudScore": {
"score": 37.06
},
"createdOn": "2020-07-24T13:35:03.145Z",
"status": "Succeded"
}
}
]
}

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.
{
"status": 401
}

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.
{
"status": 403
}

500: Internal Server Error

Esta é a resposta para os casos em que ocorre um erro interno no servidor.
{
"status": 500,
"detail": "Error details"
}

Listar Assinaturas

https://api.premepay.com/v1/stores/{storeId}/plans/{planId}/subscriptions
Através da rota acima você poderá visualizar uma lista de todas as assinaturas. 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": 52468,
"customerId": 10123,
"paymentType": 0,
"lastPayment": null,
"nextPayment": "2020-07-27T22:33:35.226Z",
"status": 0,
"createdOn": "2020-07-20T22:33:35.226Z"
}
]

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"
}
}

Atualizar Assinatura

https://api.premepay.com/v1/stores/{storeId}/customers/{customersId}
Sempre que for necessário realizar a atualização de uma assinatura, seja porque seu consumidor mudou a forma de pagamento ou porque houve outro pedido de alteração, você pode utilizar esta rota.

Exemplo de Requisição

Este é um exemplo de como a sua requisição para atualizar assinatura deve parecer.
{
"planId": 973
}

Respostas

201: Created

Esta é a resposta para os casos em que sua requisição seja bem sucedida.
Status
Significado
0
Ativo
1
Cancelado
2
Pendente
{
"id": 52468,
"customerId": 10123,
"paymentType": 0,
"lastPayment": null,
"nextPayment": "2020-07-27T22:33:35.226Z",
"status": 0,
"createdOn": "2020-07-20T22:33:35.226Z"
}

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": "Subscription 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"
}
}

Excluir Assinatura

https://api.premepay.com/v1/stores/{storeId}/plans/{planId}/subscriptions/{subscriptionId}
Você tem a possibilidade de excluir permanentemente uma assinatura. Tenha atenção ao realizar essa requisição já que a ação não pode ser revertida.
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": "Subscription 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": "Subscription 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
Adicionar Assinatura em Plano
Detalhes da Assinatura
Listar Assinaturas
Atualizar Assinatura
Excluir Assinatura