Skip to main content
curl -X GET "https://api.chargefy.io/v1/discounts?limit=20" \
  -H "Authorization: Bearer {{API_KEY}}"
{
  "object": "list",
  "data": [
    {
      "id": "disc_123",
      "object": "discount",
      "amount_off": null,
      "applies_to": {
        "products": []
      },
      "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": null,
      "metadata": {},
      "name": "Black Friday 20%",
      "percent_off_basis_points": 2000,
      "redemptions_count": 0,
      "starts_at": null,
      "type": "percentage",
      "updated_at": null,
      "valid": true
    }
  ],
  "has_more": false,
  "url": "/v1/discounts"
}
Lista discounts da organização atuante, ordenados por created_at decrescente.

Parâmetros de query

limit
integer
default:"10"
Quantidade de itens por página. Entre 1 e 100.
starting_after
string
ID do desconto que delimita o início da próxima página.
ending_before
string
ID do desconto que delimita o fim da página anterior.
is_active
boolean | string
Quando omitido, retorna apenas is_active=true. Envie false para inativos ou all para incluir ambos.
type
string
Filtra por percentage ou fixed.
query
string
Busca por nome.
curl -X GET "https://api.chargefy.io/v1/discounts?limit=20" \
  -H "Authorization: Bearer {{API_KEY}}"

Resposta

{
  "object": "list",
  "data": [
    {
      "id": "disc_123",
      "object": "discount",
      "amount_off": null,
      "applies_to": {
        "products": []
      },
      "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": null,
      "metadata": {},
      "name": "Black Friday 20%",
      "percent_off_basis_points": 2000,
      "redemptions_count": 0,
      "starts_at": null,
      "type": "percentage",
      "updated_at": null,
      "valid": true
    }
  ],
  "has_more": false,
  "url": "/v1/discounts"
}