Skip to main content
POST
Definir preço do cliente

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

customerID
string<uuid>
obrigatório

ID da inscrição do cliente no produto (não o ID do cliente).

Corpo

application/json
meterId
string<uuid> | null
obrigatório

O meter cujo preço você quer substituir. Envie null para a mensalidade fixa, que precisa usar model: flat.

model
enum<string>
obrigatório

Modelo de preço.

Opções disponíveis:
flat,
per_unit,
tiered,
volume,
package
unitAmount
string | null

Preço por unidade, em texto decimal.

tiers
any
padrão:[]

Faixas de preço, para tiered, volume e package.

currency
string

Moeda (por exemplo BRL).

Exemplo:

"BRL"

Resposta

Preço definido.

id
string<uuid>
customerId
string<uuid>

Id da inscrição.

meterId
string<uuid> | null

O meter cujo preço é substituído. Nulo quando o preço é o da mensalidade fixa.

model
enum<string>

Modelo de preço.

Opções disponíveis:
flat,
per_unit,
tiered,
volume,
package
unitAmount
string | null

Preço por unidade, em texto decimal.

tiers
object[]

Faixas de preço, para tiered, volume e package.

currency
string