Criar cupom

post https://sandbox.api.assinaturas.pagseguro.com/coupons

Com esse recurso você pode criar cupons de desconto para utilizar em suas assinaturas. Esses cupons podem fornecer um desconto fixo ou percentual. Além disso, você pode definir por quantas faturas esse desconto será válido através do parâmetro duration.

📘
Acesse o guia do serviço de Pagamentos Recorrentes para mais informações sobre seu funcionamento e funcionalidades disponíveis.
Você também pode consultar o guia específico da funcionalidade de cupons.

Body Params

reference_id

string

Identificador do cupom na sua aplicação (Max 65 caracteres).

name

string

Nome do cupom (Max 65 caracteres). ⚠️Obrigatório⚠️

description

string

Descrição do cupom (Max 250 caracteres).

discount

object

Objeto contendo as informações do tipo de desconto do cupom. ⚠️Obrigatório⚠️

status

string

Defaults to ACTIVE

Status do cupom: ACTIVE ou INACTIVE.

duration

object

Objeto contendo a duração do cupom. ⚠️Obrigatório⚠️

redemption_limit

int32

Quantidade de vezes que um cupom pode ser usado em assinaturas até que ele seja inativado automaticamente. ⚠️ Valor deve ser maior que 1. ⚠️

exp_at

date

Data de expiração do cupom. ⚠️A expiração ocorre em D+1. Não é possível selecionar datas anteriores ao momento atual. ⚠️

Headers

Authorization

string

required

Defaults to Bearer <token>

Token de autenticação. Deve ser enviado no formato Bearer <token>.

x-idempotency-key

string

Chave composta de caracteres alfanumérico, exceto caracteres especiais. As chaves são recicladas depois de um intervalo não específico. Com isso, é garantido sua eficiência por 48 horas (Max 200 caracteres).

Responses

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://sandbox.api.assinaturas.pagseguro.com/coupons \
3
     --header 'Authorization: Bearer <token>' \
4
     --header 'accept: application/json' \
5
     --header 'content-type: application/json' \
6
     --data '{"status":"ACTIVE"}'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

📘

200200

400400