Skip to main content
POST
Criar nova versão

Autorizações

Authorization
string
header
obrigatório

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

Cabeçalhos

Idempotency-Key
string

Chave única por operação (um UUID serve). Repetir com a mesma chave devolve a resposta original.

Parâmetros de caminho

productID
string<uuid>
obrigatório

ID do produto.

Corpo

application/json
billingCycle
enum<string> | null

Ciclo de cobrança: weekly, monthly ou annual. Obrigatório para subscription e prepaid.

Opções disponíveis:
weekly,
monthly,
annual,
null
basePrice
string | null

Preço base em texto decimal ("49.90"): o valor fixo da compra ou da recorrência.

grants
object[]

Créditos de uso que a versão concede, um item por medidor. on: cycle credita a cada novo período da assinatura; on: payment credita quando o pagamento confirma.

Resposta

Versão criada em draft.

Uma versão do produto: o retrato do preço. Uma versão publicada nunca muda; para mudar o preço, crie outra.

id
string<uuid>
productId
string<uuid>
version
integer

Número sequencial da versão (1, 2, 3…).

billingCycle
enum<string> | null

weekly, monthly ou annual; null em produtos sem recorrência.

Opções disponíveis:
weekly,
monthly,
annual,
null
basePrice
string | null

Preço base em texto decimal; null em produto só de uso.

status
enum<string>

draft (editável), published (vendável, preço fixo) ou archived.

Opções disponíveis:
draft,
published,
archived
isDefault
boolean

Se esta é a versão que o comprador recebe quando nada indica outra. Uma versão publicada com isDefault: false é uma oferta: só é vendida por um link de pagamento criado com productVersionId.

publishedAt
string<date-time> | null
commitmentAmount
string | null

Mínimo cobrado por ciclo, em texto decimal; null sem mínimo.

commitmentResets
boolean

true: o mínimo não usado se perde no fim do ciclo. false: passa para o seguinte.

consumptionFloor
string | null

Saldo abaixo do qual o registro de uso é recusado. Veja VersionConsumption.floor.

grants
object[]

Créditos de uso que a versão concede.