Criar um código de desconto

curl -X POST "https://api.chargefy.io/v1/discount-codes" \
  -H "Authorization: Bearer {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
    "discount_id": "disc_tzHVjHHC1Z1grKnU"
  }'

{
  "id": "dcode_qmKc9PBLPnLvyMZo",
  "object": "discount_code",
  "code": "BLACK20",
  "created_at": "2026-05-21T12:00:00Z",
  "customer": "cus_V9jjwFMM9P5kPEmV",
  "discount": "disc_tzHVjHHC1Z1grKnU",
  "expires_at": null,
  "first_time_transaction": true,
  "is_active": true,
  "livemode": true,
  "max_redemptions": 500,
  "max_redemptions_per_customer": 1,
  "metadata": {},
  "minimum_amount": 10000,
  "minimum_amount_currency": "brl",
  "redemptions_count": 0,
  "updated_at": null,
  "valid": true
}

Cria um discount_code para um discount existente. Se code não for enviado, um código é gerado automaticamente. Só discount_id é obrigatório. Sem code, a Chargefy gera um código de 10 caracteres sozinha. Todo o resto tem default.

Attributes

string

Código público. Aceita letras, números e hífens; é normalizado para maiúsculas. Precisa ser único na organização — código já existente retorna 409. Quando omitido, um código de 10 caracteres é gerado automaticamente.

string

Cliente específico (cus_*) que pode resgatar este código. Precisa existir na organização — senão 404. Padrão: null (qualquer cliente pode usar).

string

required

ID do desconto (disc_*). Precisa existir na organização — senão 404.

string

Data ISO 8601 de expiração do código. Não pode ser posterior ao expires_at do discount pai — senão 400. Padrão: null.

boolean

default:"false"

Quando true, restringe o resgate a clientes sem atividade de cobrança anterior. Padrão: false.

boolean

default:"true"

Se o código nasce ativo. Padrão: true.

integer

Limite total de aplicações deste código (inteiro positivo). Não pode exceder o max_redemptions do discount pai — senão 400. Padrão: null.

integer

Limite de aplicações por cliente para este código (inteiro positivo). Padrão: null.

object

Objeto livre para correlação. Padrão: {}.

integer

Valor mínimo da compra em centavos (inteiro positivo). Padrão: null.

string

Moeda do valor mínimo, código ISO de 3 letras (normalizado para minúsculas). Obrigatório quando minimum_amount é enviado; senão 400.

O que a Chargefy resolve sozinha

Sem code, gera um código de 10 caracteres (letras maiúsculas e números, sem caracteres ambíguos).
code enviado é normalizado para maiúsculas.
Limites do código são validados contra o discount pai (expires_at e max_redemptions não podem excedê-lo).
first_time_transaction nasce false, is_active nasce true e redemptions_count nasce 0.

Cenários de criação

(a) Código gerado automaticamente

Só o desconto pai. A Chargefy gera um código de 10 caracteres — use quando o código não precisa ser memorável (link direto, e-mail individual).

curl -X POST "https://api.chargefy.io/v1/discount-codes" \
  -H "Authorization: Bearer {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
    "discount_id": "disc_tzHVjHHC1Z1grKnU"
  }'

(b) Código escolhido, com limites de campanha

code aceita letras, números e hífen, e é normalizado para maiúsculas na comparação. Os limites são independentes: max_redemptions é o total do código, max_redemptions_per_customer é por cliente, e minimum_amount exige minimum_amount_currency.

curl -X POST "https://api.chargefy.io/v1/discount-codes" \
  -H "Authorization: Bearer {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
    "code": "BEMVINDO10",
    "discount_id": "disc_tzHVjHHC1Z1grKnU",
    "max_redemptions": 100,
    "max_redemptions_per_customer": 1,
    "minimum_amount": 5000,
    "minimum_amount_currency": "brl"
  }'

(c) Código exclusivo de um cliente

customer restringe o resgate a um único cliente; first_time_transaction limita a quem ainda não comprou.

curl -X POST "https://api.chargefy.io/v1/discount-codes" \
  -H "Authorization: Bearer {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
    "customer": "cus_V9jjwFMM9P5kPEmV",
    "discount_id": "disc_tzHVjHHC1Z1grKnU",
    "first_time_transaction": true
  }'

Resposta

{
  "id": "dcode_qmKc9PBLPnLvyMZo",
  "object": "discount_code",
  "code": "BLACK20",
  "created_at": "2026-05-21T12:00:00Z",
  "customer": "cus_V9jjwFMM9P5kPEmV",
  "discount": "disc_tzHVjHHC1Z1grKnU",
  "expires_at": null,
  "first_time_transaction": true,
  "is_active": true,
  "livemode": true,
  "max_redemptions": 500,
  "max_redemptions_per_customer": 1,
  "metadata": {},
  "minimum_amount": 10000,
  "minimum_amount_currency": "brl",
  "redemptions_count": 0,
  "updated_at": null,
  "valid": true
}

curl -X POST "https://api.chargefy.io/v1/discount-codes" \
  -H "Authorization: Bearer {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
    "discount_id": "disc_tzHVjHHC1Z1grKnU"
  }'

{
  "id": "dcode_qmKc9PBLPnLvyMZo",
  "object": "discount_code",
  "code": "BLACK20",
  "created_at": "2026-05-21T12:00:00Z",
  "customer": "cus_V9jjwFMM9P5kPEmV",
  "discount": "disc_tzHVjHHC1Z1grKnU",
  "expires_at": null,
  "first_time_transaction": true,
  "is_active": true,
  "livemode": true,
  "max_redemptions": 500,
  "max_redemptions_per_customer": 1,
  "metadata": {},
  "minimum_amount": 10000,
  "minimum_amount_currency": "brl",
  "redemptions_count": 0,
  "updated_at": null,
  "valid": true
}

Fundamentos da API

Objetos de sistema

Webhooks e eventos

SDKs

MCP

Criar um código de desconto

Attributes

O que a Chargefy resolve sozinha

Cenários de criação

(a) Código gerado automaticamente

(b) Código escolhido, com limites de campanha

(c) Código exclusivo de um cliente

Resposta

​Attributes

​O que a Chargefy resolve sozinha

​Cenários de criação

​(a) Código gerado automaticamente

​(b) Código escolhido, com limites de campanha

​(c) Código exclusivo de um cliente

​Resposta

Attributes

O que a Chargefy resolve sozinha

Cenários de criação

(a) Código gerado automaticamente

(b) Código escolhido, com limites de campanha

(c) Código exclusivo de um cliente

Resposta