Preços
Atualizar um preço
Atualiza um preço.
Atualiza um
price com semântica de merge. Campos de valor são imutáveis:
currency, unit_amount, type, recurring e product_id.
Para mudar valor ou cadência, crie outro preço e desative o antigo.
A resposta direta não carrega diff; quem precisa de diff lê o webhook
price.updated.
Autenticação
A API key da própria organização atua diretamente. A API key de plataforma exige o headerOrganization: <organization_id> apontando para uma organização
conectada ativa dessa plataforma.
Parâmetros de caminho
integer | null
Preço de referência em centavos, maior que
unit_amount, ou null para remover.
Exemplo: 149700 com unit_amount=29700 permite exibir “De R 297”.
Só aparece quando checkout_experience.show_compare_at_amount=true. Não altera
a cobrança. Pode ser editado; sessões já criadas conservam a referência original.string
obrigatório
ID do preço (
price_*).Attributes
Todos os campos são opcionais.boolean
false tira o preço de novos fluxos de compra. true reativa.object
Substitui completamente o
metadata atual quando enviado.string \| null
Rótulo interno. Envie
null para limpar.string
Como o imposto se relaciona ao valor.
Resposta
200 OK com o objeto price completo (mesmo shape de
GET /v1/prices/:id).
Erros comuns
Webhook
A atualização disparaprice.updated
com o price completo em data.object e o diff em data.previous_attributes.
