Skip to main content
GET
Obter um preço
Retorna o objeto completo identificado pelo ID, quando ele pertence à conta da chave. Requer prices:read ou read. Veja campos, relacionamentos e eventos.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

ID público do preço na conta.

Pattern: ^prc_[a-z0-9]{16}$

Response

Operação concluída

id
string
required

Identificador público estável. Use o valor retornado pela API nas consultas e relacionamentos; não derive IDs de nomes.

Pattern: ^prc_[a-z0-9]{16}$
category
enum<string>
required

Categoria: one_time (compra única), subscription (assinatura), lead_magnet (gratuito) ou pwyw (cliente escolhe o valor).

Available options:
one_time,
subscription,
lead_magnet,
pwyw
created_at
string<date-time>
required

Data e hora da criação, em ISO 8601 com fuso horário. Somente leitura.

currency
enum<string>
required

Moeda do preço: BRL ou USD, sempre em maiúsculas. Valores monetários são expressos em centavos dessa moeda.

Available options:
BRL,
USD
is_active
boolean
required

Indica se a oferta está ativa. Desativar preserva o histórico dos pedidos que a utilizaram.

metadata
object
required

Objeto JSON livre para referências da integração, limitado a 16 KB. Ao enviar, substitui todo o metadata anterior; use {} para limpar. Não aceita null.

min_price
integer | null
required

Valor mínimo em centavos, não negativo. Obrigatório para pwyw; pode ser null nas outras categorias.

name
string
required

Nome da oferta exibido no painel. Pode vir vazio quando não informado; se enviado, deve ser não vazio.

object
string
required

Tipo do objeto retornado. O valor é fixo para este recurso.

Allowed value: "price"
package_size
integer
required

Quantidade de unidades por pacote. Inteiro maior ou igual a 1.

product
string
required

ID do produto ao qual o preço pertence, na mesma conta. Obrigatório na criação; não pode ser alterado.

Pattern: ^pro_[a-z0-9]{16}$
renewal_interval_quantity
integer | null
required

Número de unidades entre renovações. Inteiro positivo para subscription; pode ser null nas outras categorias.

renewal_interval_unit
enum<string> | null
required

Unidade da renovação: day, week, month ou year. Obrigatória para subscription, junto da quantidade.

Available options:
day,
week,
month,
year,
null
scheme
enum<string>
required

Modelo do preço: standard (unitário), package (pacote), graduated (faixas progressivas) ou volume (faixa pelo volume total).

Available options:
standard,
package,
graduated,
volume
setup_fee
integer | null
required

Valor da taxa inicial, em centavos e não negativo. Pode ser null quando não configurado.

setup_fee_enabled
boolean | null
required

Indica se há taxa inicial configurada. Pode ser null. Se true em uma assinatura, setup_fee é obrigatório.

suggested_price
integer | null
required

Valor sugerido em centavos. Em pwyw, quando informado, deve ser maior ou igual a min_price. Pode ser null.

tiers
object[]
required

Faixas para graduated e volume. Nesses modelos, envie uma lista não vazia, com limites crescentes e a última faixa sem limite (up_to: null).

trial_interval_quantity
integer | null
required

Quantidade de unidades do período de teste. Inteiro positivo quando configurado; null sem teste.

trial_interval_unit
enum<string> | null
required

Unidade do período de teste: day, week, month ou year. Pode ser null. Para subscription, envie unidade e quantidade juntas.

Available options:
day,
week,
month,
year,
null
unit_amount
integer
required

Valor unitário inteiro, em centavos: 4990 representa R$ 49,90 em BRL. Deve ser não negativo; lead_magnet exige zero.

unit_amount_decimal
string | null
required

Valor unitário decimal em centavos, como string com ponto e até 12 casas decimais. Pode ser null. Máximo 2147483647.

updated_at
string<date-time>
required

Data e hora da última alteração, em ISO 8601 com fuso horário. Somente leitura.

usage_aggregation
enum<string> | null
required

Agregação de uso: sum (soma), last_during_period (último no período), last_ever (último conhecido) ou max (máximo). Null quando não configurada.

Available options:
sum,
last_during_period,
last_ever,
max,
null
used
boolean
required

Indica se o preço já foi vinculado a checkout ou pedido. Quando true, somente name, metadata e is_active podem ser editados pela API. Somente leitura.