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 Identificador único da sub-organização filha cujos descontos serão listados.
Parâmetros de Query Termo de busca para filtrar descontos por nome ou código.
Quando true, retorna apenas descontos arquivados (deletados). Padrão: false.
Quantidade máxima de resultados por página. Padrão: 100.
Deslocamento para paginação. Padrão: 0.
Campo de ordenação. Valores aceitos: created_at, name, redemptions_count. Padrão: created_at.
Direção da ordenação. Valores aceitos: asc, desc. Padrão: desc.
Resposta Lista de descontos da sub-organização. Identificador único do desconto.
Identificador da organização à qual o desconto pertence.
Tipo do desconto. Valores: fixed (valor fixo em centavos) ou percentage (percentual em basis points).
Código de cupom. null para descontos automáticos.
Duração da aplicação do desconto. Valores: once, forever, repeating.
Número de meses de duração quando duration é repeating. null caso contrário.
Valor do desconto em centavos. Presente apenas quando type é fixed.
Moeda do desconto (ex: brl). Presente apenas quando type é fixed.
Percentual do desconto em basis points (ex: 1000 = 10%). Presente apenas quando type é percentage.
Limite máximo de usos. null para uso ilimitado.
Total de usos realizados.
Data de início de validade no formato ISO 8601. null se não configurado.
Data de expiração no formato ISO 8601. null se não expira.
Data e hora de criação no formato ISO 8601.
Informações de paginação. Total de descontos encontrados.
Limite por página utilizado.
Exemplo 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 } }
