Pular para o conteúdo principal
POST
Publicar 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
obrigatório

ID do produto.

Pattern: ^prod_[0-9A-Za-z]{22}$
Exemplo:

"prod_1d4YogBuw00jAySh5mbUpk"

versionID
string<uuid>
obrigatório

ID da versão do produto.

Corpo

application/json

Opcional. Sem corpo, a versão é publicada como padrão.

default
boolean
padrão:true

true (ou omitido) torna esta a versão padrão do produto. false publica como oferta, vendida só por um link que a indique.

Resposta

A versão publicada.

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>
obrigatório
productId
string
obrigatório
Pattern: ^prod_[0-9A-Za-z]{22}$
Exemplo:

"prod_1d4YogBuw00jAySh5mbUpk"

version
integer
obrigatório

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

status
enum<string>
obrigatório

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

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

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.

commitmentResets
boolean
obrigatório

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

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.

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

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

consumptionFloor
string | null

Limite de créditos abaixo do qual o registro de uso é recusado. Veja VersionConsumption.floor.

grants
object[]

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