Skip to main content
POST
A oferta é o que o cliente compra. Ela nasce com um checkout_url pronto para compartilhar. Uma oferta é de um dos dois tipos:
  • one_time: cobrança única. Só precisa de name e amount.
  • recurring: assinatura. Precisa de interval e da régua de ciclos (cycles).
id
string
required
O id (uuid) do produto que recebe a oferta.

Parâmetros da Requisição

type
string
required
Tipo da oferta. Valores: one_time, recurring.
name
string
required
Nome da oferta (ex.: “Mensal”, “Anual”, “Vitalício”). Máximo: 80 caracteres.
amount
integer
Valor em centavos. Obrigatório para one_time. Mínimo: 100 (R$ 1,00).Exemplo: 39900 = R$ 399,00
interval
string
Cadência da assinatura. Obrigatório para recurring.Valores: monthly, quarterly, half-yearly, yearly.
trial_days
integer
Dias de teste grátis antes da primeira cobrança. Mínimo: 1 | Máximo: 365.
cycles
array
A régua de preços. Obrigatória para recurring. Uma lista de faixas, de 1 a 50, contígua a partir do ciclo 1.
A régua tem que ser uma escada válida, senão a resposta é 422:
  • começa no ciclo 1;
  • é contígua (cada faixa começa em end + 1 da anterior);
  • não se sobrepõe, e cada faixa tem start <= end;
  • só a última faixa pode ter end: null.

Resposta

id
string
UUID da oferta.
hash
string
Hash público da oferta (base do checkout_url).
type
string
one_time ou recurring.
name
string
Nome da oferta.
is_active
boolean
Se a oferta está ativa (ver arquivar/restaurar).
amount
integer
O preço em centavos. Em recurring, é a faixa estável (a última da régua), útil para exibir “a partir de”.
currency
string
Sempre BRL.
interval
string
A cadência, em recurring; null em one_time.
trial_days
integer
Dias de teste.
cycles
array
A régua devolvida faixa a faixa (vazia em one_time). end: null na última = “em diante”.
checkout_url
string
O link pronto de checkout. /s/{hash} para recurring, /c/{hash} para one_time.

E agora?

O checkout_url já funciona: compartilhe e receba. Para vender por API (você já tem cliente e cartão), use o id da oferta como offer_id em POST /charges/subscriptions.