Consulta um cupom

GET/v1/coupons/{couponId}

Autentique com o header SelectKey: a chave sk_test_ opera no sandbox, a sk_live_ em produção. Como autenticar.

Parâmetros do caminho

couponIdstringobrigatório
Identificador público (dis_/coup_…)

Respostas

200Sucesso

idstringobrigatório
Identificador público (dis_/coup_…)
codestringobrigatóriopode ser nulo
O código que o comprador digita.
namestringobrigatóriopode ser nulo
Nome do cupom.
typestringobrigatório
flat (um valor fixo) ou percentage.
Valores:flatpercentage
scopestringobrigatório
Numa assinatura: firstCharge (só a primeira cobrança) ou recurring (todo ciclo, até recurringCycles).
Valores:firstChargerecurring
valuenumberobrigatório
Em percentage, o percentual (0–100); em flat, o valor em reais (decimal).
enabledbooleanobrigatório
Se o cupom pode ser usado.
endDatestringobrigatóriopode ser nulo
Até quando o cupom vale; null = sem fim.
initDatestringobrigatóriopode ser nulo
A partir de quando o cupom vale; null = sem início.
createdAtstringobrigatório
Quando o recurso foi criado (ISO 8601, UTC).
updatedAtstringobrigatório
Quando o recurso foi atualizado pela última vez (ISO 8601, UTC).
usageLimitintegerobrigatóriopode ser nulo
Número total de usos permitidos; null ou 0 = ilimitado.
isCumulativebooleanobrigatório
Se pode ser combinado com outros cupons.
maxCartItemsintegerobrigatóriopode ser nulo
Número máximo de itens; null = sem limite.
minCartItemsintegerobrigatóriopode ser nulo
Número mínimo de itens; null = sem mínimo.
maxCartAmountintegerobrigatóriopode ser nulo
Valor máximo do carrinho (centavos); null = sem limite.
minCartAmountintegerobrigatóriopode ser nulo
Valor mínimo do carrinho (centavos); null = sem mínimo.
usageQuantityintegerobrigatóriopode ser nulo
Usos permitidos por cliente; null ou 0 = ilimitado.
allowedItemIdsany[]obrigatóriopode ser nulo
Ids das variantes a que o cupom se restringe; null = qualquer item.
recurringCyclesintegerobrigatóriopode ser nulo
Com scope=recurring: quantos ciclos ganham o desconto; null = todos os ciclos.
redemptionsCountintegerobrigatório
Quantas vezes o cupom foi usado (reservas e confirmados). Esgota quando usageLimit > 0 e isto chega lá.
allowedCustomerIdsany[]obrigatóriopode ser nulo
Ids dos clientes a que o cupom se restringe; null = qualquer cliente.
limitOneUsePerCustomerbooleanobrigatório
Cada cliente pode usar o cupom uma vez.

401Não autenticado (credencial ausente ou inválida)

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

403Sem permissão

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

404Não encontrado

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

500Erro interno do servidor

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

AnteriorValida um cupom contra um carrinho (prévia do desconto)PróximaAtualiza um cupom