Skip to main content
curl -X POST "https://api.chargefy.io/v1/discounts" \
  -H "Authorization: Bearer {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Black Friday 20%",
    "percent_off_basis_points": 2000,
    "type": "percentage"
  }'
{
  "id": "disc_123",
  "object": "discount",
  "amount_off": null,
  "applies_to": {
    "products": [
      "prod_123"
    ]
  },
  "created_at": "2026-05-21T12:00:00Z",
  "currency": null,
  "duration": "once",
  "duration_in_months": null,
  "expires_at": null,
  "is_active": true,
  "livemode": true,
  "max_redemptions": 500,
  "metadata": {
    "campaign": "black_friday"
  },
  "name": "Black Friday 20%",
  "percent_off_basis_points": 2000,
  "redemptions_count": 0,
  "starts_at": null,
  "type": "percentage",
  "updated_at": null,
  "valid": true
}
Cria um discount. Para um cupom digitável pelo comprador, crie depois um discount_code com discount_id.

Autenticação

A API key da própria organização atua diretamente. A API key de plataforma exige o header Organization: <organization_id> apontando para uma organização conectada ativa.

Attributes

amount_off
integer
Valor fixo em centavos. Obrigatório quando type=fixed.
applies_to
object
Escopo do desconto. Use products com IDs prod_*; array vazio aplica a todos os produtos. Quando há produtos definidos, o abatimento é calculado somente sobre o subtotal das linhas elegíveis.
currency
string
Código ISO de 3 letras minúsculas. Obrigatório quando type=fixed.
duration
string
default:"once"
once, forever ou repeating.
duration_in_months
integer
Obrigatório quando duration=repeating.
expires_at
string
Data ISO 8601 de expiração.
max_redemptions
integer
Limite total de aplicações.
metadata
object
Objeto livre para correlação.
name
string
required
Nome do desconto.
percent_off_basis_points
integer
Percentual em basis points. Obrigatório quando type=percentage.
starts_at
string
Data ISO 8601 a partir da qual o desconto passa a valer.
type
string
required
percentage ou fixed.
curl -X POST "https://api.chargefy.io/v1/discounts" \
  -H "Authorization: Bearer {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Black Friday 20%",
    "percent_off_basis_points": 2000,
    "type": "percentage"
  }'

Resposta

200 OK com o objeto discount completo.
{
  "id": "disc_123",
  "object": "discount",
  "amount_off": null,
  "applies_to": {
    "products": [
      "prod_123"
    ]
  },
  "created_at": "2026-05-21T12:00:00Z",
  "currency": null,
  "duration": "once",
  "duration_in_months": null,
  "expires_at": null,
  "is_active": true,
  "livemode": true,
  "max_redemptions": 500,
  "metadata": {
    "campaign": "black_friday"
  },
  "name": "Black Friday 20%",
  "percent_off_basis_points": 2000,
  "redemptions_count": 0,
  "starts_at": null,
  "type": "percentage",
  "updated_at": null,
  "valid": true
}