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

# Criar um cupom

`POST /coupons/create`

Permite que você crie um novo cupom que pode ser usado por seus clientes para aplicar descontos.

**Alternativa**: Você também pode criar e gerenciar seus cupons pelo [Dashboard da AbacatePay](https://app.abacatepay.com/cupons).

## Request body

- Coupon — Os dados do seu cupom.
  - `code` string, required — Identificador único do cupom
  - `notes` string — Descrição sbre o cupom
  - `maxRedeems` number — Quantidade de vezes em que o cupom pode ser resgatado. -1 Significa que esse cupom pode ser resgatado sem limites
  - `discountKind` 'PERCENTAGE' | 'FIXED', required — Tipo de desconto aplicado, porcentagem ou fixo
  - `discount` number, required — Valor de desconto a ser aplicado
  - `metadata` object — Objeto chave valor para metadados do cupom

## Response `200`

Cupom criado com sucesso.

- object
  - `data` CouponResponse — Os dados do seu cupom.
    - `id` string, required — Identificador único do cupom
    - `notes` string — Descrição sobre o cupom
    - `maxRedeems` integer — Quantidade de vezes em que o cupom pode ser resgatado. -1 significa ilimitado.
    - `redeemsCount` integer — Quantidade de vezes que o cupom já foi resgatado.
    - `discountKind` 'PERCENTAGE' | 'FIXED', required — Tipo de desconto aplicado, porcentagem ou fixo
    - `discount` number, required — Valor de desconto a ser aplicado
    - `devMode` boolean — Indica se o cupom foi criado em ambiente de testes.
    - `status` 'ACTIVE' | 'INACTIVE' | 'EXPIRED', required — Status atual do cupom.
    - `createdAt` string, date-time, required — Data de criação do cupom.
    - `updatedAt` string, date-time, required — Data de atualização do cupom.
    - `metadata` object — Objeto chave valor para metadados do cupom
  - `error` string, nullable
  - `success` boolean — Se a requisição obteve sucesso ou não.

## Other responses

- `401` — Não autorizado. Falha na autenticação.

---

[API](https://skmtc.net/abacatepay/apis/api-abacatepay.md) · [All operations](https://skmtc.net/abacatepay/apis/api-abacatepay/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/abacatepay/api-abacatepay/revisions/6b89a7fa70f5/schema)