Skip to main content
POST
Criar cupom

Autorizações

Authorization
string
header
obrigatório

Chave secreta da conta: Authorization: Bearer sk_test_… ou sk_live_…. Use só no servidor.

Corpo

application/json

Dados de um novo cupom.

code
string
obrigatório

Código do cupom: de 3 a 32 caracteres entre letras maiúsculas, números, _ e - (ex.: BLACKFRIDAY-20).

percentOff
string
obrigatório

Percentual de desconto, em texto decimal, maior que 0 e até 100.

duration
enum<string>
obrigatório

once (só na primeira fatura), repeating (durante durationInCycles ciclos) ou forever (em todas as faturas).

Opções disponíveis:
once,
repeating,
forever
durationInCycles
integer | null

Obrigatório (1 ou mais) quando duration é repeating; omita nos demais casos.

maxRedemptions
integer | null

Limite total de usos. Omita para não limitar.

redeemBy
string<date-time> | null

Prazo final para aplicar o cupom. Omita para não ter prazo.

Resposta

Criado.

Um desconto percentual que o comprador aplica no checkout com o code. Em assinaturas, duration define por quantos ciclos o desconto vale.

id
string<uuid>
obrigatório
code
string
obrigatório

O código que o comprador digita no checkout.

percentOff
string
obrigatório

Percentual de desconto, em texto decimal ("15" = 15%).

duration
enum<string>
obrigatório

once (só na primeira fatura), repeating (durante durationInCycles ciclos) ou forever (em todas as faturas).

Opções disponíveis:
once,
repeating,
forever
timesRedeemed
integer
obrigatório

Quantas vezes o cupom já foi usado.

status
enum<string>
obrigatório

active (aceito no checkout) ou archived (não aceito mais).

Opções disponíveis:
active,
archived
createdAt
string<date-time>
obrigatório
updatedAt
string<date-time>
obrigatório
durationInCycles
integer | null

Quantos ciclos o desconto vale. Só em cupons repeating.

maxRedemptions
integer | null

Quantas vezes o cupom pode ser usado no total. null = sem limite.

redeemBy
string<date-time> | null

Até quando o cupom pode ser aplicado. null = sem prazo.