Cupons
A API de Pagamento Recorrente do PagBank possibilita que você crie cupons de desconto para oferecer aos assinantes. Esses cupons podem proporcionar descontos em valores inteiros ou percentuais e podem incluir uma data de vencimento ou um limite máximo de uso por assinatura.
Número de cupons por assinatura
Cada assinatura aceita a aplicação de um único cupom por vez.
Status do cupom
Os cupons associados ao serviço de Pagamento Recorrente do PagBank podem assumir dois estados:
- ATIVO (Active): O cupom está ativo e válido para ser aplicado em novas assinaturas.
- INATIVO (Inactive): O cupom atingiu o limite máximo de uso e não está mais disponível. Você também tem a opção de desativar os cupons se desejar.
Endpoints
Para gerenciar os cupons, a API de assinaturas do PagBank fornece os seguintes endpoints:
- Criar Cupom: Crie novos cupons de desconto para oferecer aos seus assinantes. Você utilizará o
id
desses cupons no momento da criação ou atualização de uma assinatura, caso deseje fornecer um desconto ao seu cliente. - Consultar por ID: Obtenha detalhes específicos de um cupom usando seu identificador único.
- Listar Cupons: Visualize a lista completa de todos os cupons de descontos criados em sua conta.
- Inativar Cupom: Desative um cupom para que esse não esteja mais disponível para novas utilizações.
- Ativar Cupom: Ative um cupom previamente inativo para permitir sua utilização em assinaturas.
Objeto Cupom
A API de Cupons utiliza o objeto Cupom. Para identificar todos os parâmetros, seus respectivos tipos e exemplos de cada parâmetro do objeto, acesse Objeto Cupom.
Updated 9 months ago