---
title: "Criar cupom"
method: POST
path: "/coupons"
---

# Criar cupom

`POST /coupons`

## Request

- Base URL: `https://sandbox.api.assinaturas.pagseguro.com`
- URL: `https://sandbox.api.assinaturas.pagseguro.com/coupons`
- Auth: none required

## Headers

- `Authorization` string, required
- `x-idempotency-key` string

## Request body

- object
  - `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**⚠️
    - `type` 'PERCENT' | 'AMOUNT': Tipo do desconto. Selecione `PERCENT`para oferecer um desconto percentual ou `AMOUNT`para oferecer um valor fixo de desconto.
    - `value` integer: Valor de desconto a ser aplicado. <br>⚠️ **Para porcentagem, informe apenas números, de 1 a 100 representando o %.**⚠️ <br>⚠️ ** Para valor fixo informe apenas números (de 1 até 999.999.999) com o valor exato do desconto.**⚠️
  - `status` 'ACTIVE' | 'INACTIVE': Status do cupom: ACTIVE ou INACTIVE.
  - `duration` object: Objeto contendo a duração do cupom. ⚠️**Obrigatório**⚠️
    - `type` 'ONCE' | 'REPEATING' | 'FOREVER': Tipo de frequência do cupom. <br/> `ONCE`: fornece o desconto para uma fatura. <br/>`REPEATING`: repete o desconto por um certo número de faturas. <br/>`FOREVER`: o desconto é válido até que o cupom seja desativado.
    - `occurrences` integer: Define por quantas cobranças de uma assinatura o cupom será aplicado, fornecendo o desconto. ⚠️ **Quando o `duration.type` for `REPEATING` este atributo deve ser informado.** ⚠️
  - `redemption_limit` integer: 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` string, 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`

200

- object
  - `id` string
  - `reference_id` string
  - `name` string
  - `description` string
  - `discount` object
    - `value` string
    - `type` string
  - `status` string
  - `duration` object
    - `type` string
  - `redemption_limit` integer
  - `exp_at` string
  - `in_use` boolean
  - `created_at` string
  - `updated_at` string
  - `links` object[]
    - `rel` string
    - `href` string
    - `media` string
    - `type` string

## Other responses

- `400`: 400

---

[API](https://skmtc.dev/pagbank/apis/assinaturas-sandbox.md) - [All operations](https://skmtc.dev/pagbank/apis/assinaturas-sandbox/llms.txt) - [OpenAPI document](https://skmtc.dev/pagbank/apis/assinaturas-sandbox/revisions/0bf75a563a6b?raw)