Skip to main content
Atualiza os campos de um desconto existente de uma sub-organização filha. Apenas os campos informados são alterados (PATCH parcial). Não é possível alterar type, amount, basis_points, currency ou duration após a criação.

​
Autenticação

Requer Organization Access Token (OAT) da organização pai via header Authorization: Bearer.

​
Parâmetros de Path

​
orgId
string
required
Identificador único da sub-organização filha.
​
id
string
required
Identificador único do desconto a ser atualizado.

​
Corpo da Requisição

Todos os campos são opcionais. Envie apenas os campos que deseja alterar.
​
name
string
Novo nome descritivo do desconto.
​
code
string
Novo código de cupom. Use null para remover o código e tornar o desconto automático.
​
starts_at
string
Nova data de início de validade no formato ISO 8601.
​
ends_at
string
Nova data de expiração no formato ISO 8601. Use null para remover a expiração.
​
max_redemptions
integer
Novo limite máximo de usos. Use null para uso ilimitado.
​
duration_in_months
integer
Novo número de meses quando duration é repeating.
​
products
array
Nova lista de IDs de produtos aos quais o desconto se aplica.
​
user_metadata
object
Novos metadados customizados em formato chave-valor.
​
internal_reference
string
Nova referência interna.

​
Resposta

Retorna o objeto do desconto atualizado.

​
Exemplo

curl -X PATCH "https://api.chargefy.io/api/v1/sdk/organizations/org_01j9abc333/discounts/disc_01j9xyz111" \
  -H "Authorization: Bearer $CHARGEFY_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Desconto Black Friday",
    "ends_at": "2024-11-30T23:59:59Z",
    "max_redemptions": 500
  }'

​
Resposta de Exemplo

{
  "id": "disc_01j9xyz111",
  "organization_id": "org_01j9abc333",
  "name": "Desconto Black Friday",
  "type": "percentage",
  "code": "LANCAMENTO20",
  "duration": "once",
  "duration_in_months": null,
  "basis_points": 2000,
  "max_redemptions": 500,
  "redemptions_count": 12,
  "starts_at": null,
  "ends_at": "2024-11-30T23:59:59Z",
  "created_at": "2024-10-15T10:00:00Z",
  "modified_at": "2024-10-20T14:30:00Z",
  "deleted_at": null
}

​
Erros

StatusDescrição
400Campo inválido ou tentativa de alterar campos imutáveis
403Token não pertence à organização pai da orgId
404Desconto não encontrado ou não pertence à orgId