Nesta página
https://api.premepay.com/v1/stores/{storeId}/subscriptions
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.
<aside> 💡 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
</aside>
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.
Ao criar uma Assinatura em um Plano, será efetuado de imediato a primeira cobrança para o respectivo meio de pagamento indicado, ou seja, para assinaturas criadas utilizando cartão de crédito, será efetuado a primeira cobrança inicial baseada no valor indicado, sendo as proximas realizadas de acordo com a frequência indicada. Para casos onde a Assinatura foi criada utilizando os meios de pagamento Boleto ou Pix, este será enviado ao Cliente, também seguindo a frequência indicada.
| 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 |
splits |
array<object> | Divisão | Não |
splitRuleId |
Obrigatório se houver Splits associados | ||
metadata |
dictionary<key, value> | Utilizado para salvar informações variadas em formato dicionário <chave, valor> | Não |
daysBetweenRetries |
integer | Número de dias entre as retentativas de cobrança | Não |
maxRetries |
integer | Número máximo de retentativas | Não |
| Status | Significado |
|---|---|
| active | Ativo |
| canceled | Cancelado |
| pending | Pendente |
Este é um exemplo de como a sua requisição para adicionar uma assinatura em um plano de assinatura deve parecer.
201: Created
400: Bad Request
401: Não autorizado
403: Proibido
500: Internal Server Error
Conteúdo Relacionado
<aside> <img src="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/52c5ff42-e8bf-45d3-81d1-b6e05786a688/POST.png" alt="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/52c5ff42-e8bf-45d3-81d1-b6e05786a688/POST.png" width="40px" /> POST - Criar Plano de Assinatura
</aside>
<aside> <img src="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/e3aeb85f-a7e2-40f4-b805-7e883e3d72e2/DELETE.png" alt="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/e3aeb85f-a7e2-40f4-b805-7e883e3d72e2/DELETE.png" width="40px" /> DELETE - Excluir Assinatura em Plano
</aside>
