Sign in

v1

latestOpenAPI 3.1.02026-07-24750514.9 KB

Criar cupom

post/coupons

Headers

Authorizationstring required

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

x-idempotency-keystring

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).

Request body

reference_idstring

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

namestring

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

descriptionstring

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

status'ACTIVE' | 'INACTIVE'

Status do cupom: ACTIVE ou INACTIVE.

redemption_limitinteger

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

exp_atstring date

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

Response

200

idstring
reference_idstring
namestring
descriptionstring
statusstring
redemption_limitinteger
exp_atstring
in_useboolean
created_atstring
updated_atstring

Example response

{
  "id": "COUP_8ADDC40F-17B0-4655-A124-4DEAEB2F5FDC",
  "reference_id": "123456",
  "name": "SandboxCoupon",
  "description": "Sandbox Coupon",
  "discount": {
    "value": "10",
    "type": "AMOUNT"
  },
  "status": "ACTIVE",
  "duration": {
    "type": "ONCE"
  },
  "redemption_limit": 10,
  "exp_at": "2022-12-20",
  "created_at": "2022-10-25T15:21:21.091-03:00",
  "updated_at": "2022-10-25T15:21:21.091-03:00",
  "links": [
    {
      "rel": "SELF",
      "href": "http://sandbox.api.assinaturas.pagseguro.com/coupons/COUP_8ADDC40F-17B0-4655-A124-4DEAEB2F5FDC",
      "media": "application/json",
      "type": "GET"
    }
  ]
}