GET /api/v1/sdk/organizations/:orgId/discounts

Lista todos os descontos de uma sub-organização filha, gerenciados pela organização pai autenticada.

Lista os descontos criados para uma sub-organização filha. A organização autenticada deve ser a organização pai da orgId informada. Suporta filtros por busca textual, status de arquivamento, paginação e ordenação.

​

Autenticação

Requer Organization Access Token (OAT) da organização pai via header Authorization: Bearer. A organização autenticada deve ser a organização pai da orgId informada.

​

Parâmetros de Path

orgId · string · required

Identificador único da sub-organização filha cujos descontos serão listados.

​

Parâmetros de Query

query · string

Termo de busca para filtrar descontos por nome ou código.

is_archived · boolean

Quando true, retorna apenas descontos arquivados (deletados). Padrão: false.

limit · integer

Quantidade máxima de resultados por página. Padrão: 100.

offset · integer

Deslocamento para paginação. Padrão: 0.

sort_by · string

Campo de ordenação. Valores aceitos: created_at, name, redemptions_count. Padrão: created_at.

sort_order · string

Direção da ordenação. Valores aceitos: asc, desc. Padrão: desc.

​

Resposta

items · array

Lista de descontos da sub-organização.

Show items[]

id · string

Identificador único do desconto.

organization_id · string

Identificador da organização à qual o desconto pertence.

name · string

Nome do desconto.

type · string

Tipo do desconto. Valores: fixed (valor fixo em centavos) ou percentage (percentual em basis points).

code · string

Código de cupom. null para descontos automáticos.

duration · string

Duração da aplicação do desconto. Valores: once, forever, repeating.

duration_in_months · integer

Número de meses de duração quando duration é repeating. null caso contrário.

amount · integer

Valor do desconto em centavos. Presente apenas quando type é fixed.

currency · string

Moeda do desconto (ex: brl). Presente apenas quando type é fixed.

basis_points · integer

Percentual do desconto em basis points (ex: 1000 = 10%). Presente apenas quando type é percentage.

max_redemptions · integer

Limite máximo de usos. null para uso ilimitado.

redemptions_count · integer

Total de usos realizados.

starts_at · string

Data de início de validade no formato ISO 8601. null se não configurado.

ends_at · string

Data de expiração no formato ISO 8601. null se não expira.

created_at · string

Data e hora de criação no formato ISO 8601.

pagination · object

Informações de paginação.

Show pagination

total · integer

Total de descontos encontrados.

limit · integer

Limite por página utilizado.

offset · integer

Deslocamento utilizado.

​

Exemplo

cURL

curl -X GET "https://api.chargefy.io/api/v1/sdk/organizations/org_01j9abc333/discounts?limit=20&sort_by=created_at&sort_order=desc" \
  -H "Authorization: Bearer $CHARGEFY_ACCESS_TOKEN"

​

Resposta de Exemplo

{
  "items": [
    {
      "id": "disc_01j9xyz111",
      "organization_id": "org_01j9abc333",
      "name": "Desconto de Lançamento",
      "type": "percentage",
      "code": "LANCAMENTO20",
      "duration": "once",
      "duration_in_months": null,
      "basis_points": 2000,
      "max_redemptions": 100,
      "redemptions_count": 12,
      "starts_at": "2024-11-01T00:00:00Z",
      "ends_at": "2024-12-31T23:59:59Z",
      "created_at": "2024-10-15T10:00:00Z"
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 20,
    "offset": 0
  }
}