Skip to main content
PATCH
/
api
/
v1
/
prices
/
{id}
Atualizar preço
curl --request PATCH \
  --url https://besimplo.com/api/v1/prices/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "price": {
    "active": false,
    "description": "Plano Mensal Atualizado",
    "external_code": "price_updated_code",
    "card_installments_enabled": true,
    "max_card_installments": 6
  }
}
'
{
  "id": "price_01h455vb4pex5vsknk084sn02q",
  "object": "price",
  "active": true,
  "live_mode": true,
  "created": 1704672000,
  "currency": "brl",
  "product": "prod_01h455vb4pex5vsknk084sn02q",
  "type": "recurring",
  "unit_amount": 2990,
  "card_installments_enabled": false,
  "max_card_installments": 1,
  "description": "Plano Mensal Premium",
  "unit_amount_decimal": "2990",
  "recurring": {
    "interval": "month",
    "interval_count": 1
  },
  "external_code": "price_premium_monthly",
  "effective_max_card_installments": 1,
  "installment_selection_available": false
}

Documentation Index

Fetch the complete documentation index at: https://docs.besimplo.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

A chave de API usada para autenticar a requisição e identificar a sua conta.

Exemplo: Authorization: ApiKey my-secure-key

Path Parameters

​
id
string
required

ID do preço, no formato TypeID com prefixo price_.

Pattern: ^price_[0-9a-z]{26}$
Example:

"price_01h455vb4pex5vsknk084sn02q"

Body

application/json

Dados do preço que serão atualizados

​
price
object
required

Response

Preço atualizado

​
id
string
required
read-only

ID único do preço, no formato TypeID com prefixo price_.

Pattern: ^price_[0-9a-z]{26}$
Example:

"price_01h455vb4pex5vsknk084sn02q"

​
object
enum<string>
required

Tipo do objeto. Sempre 'price'.

Available options:
price
Example:

"price"

​
active
boolean
required

Se o preço está ativo para novas compras.

Example:

true

​
live_mode
boolean
required

Indica ambiente de produção (true) ou sandbox (false). Dados de sandbox são limpos periodicamente.

Example:

true

​
created
integer<int64>
required
read-only

Timestamp Unix de quando o preço foi criado.

Example:

1704672000

​
currency
enum<string>
required

Moeda do valor. Sempre 'brl' (Real brasileiro).

Available options:
brl
Example:

"brl"

​
product
string
required

ID do produto associado, no formato TypeID com prefixo prod_.

Pattern: ^prod_[0-9a-z]{26}$
Example:

"prod_01h455vb4pex5vsknk084sn02q"

​
type
enum<string>
required

Tipo de cobrança:

  • one_time: Cobrança única.
  • recurring: Cobrança recorrente.
Available options:
one_time,
recurring
Example:

"recurring"

​
unit_amount
integer
required

Valor em centavos. R$ 29,90 = 2990. Máximo R$ 9.999,99.

Required range: 0 <= x <= 999999
Example:

2990

​
card_installments_enabled
boolean
required

Indica se este preço permite parcelamento no cartão de crédito. Regras:

  • preços avulsos podem permitir parcelamento
  • recorrências diárias e semanais não podem permitir parcelamento
  • recorrências mensais exigem pelo menos 2 meses para permitir parcelamento
Example:

false

​
max_card_installments
integer
required

Máximo de parcelas aceitas no cartão. Regras:

  • quando card_installments_enabled=false, o valor efetivo é 1
  • preços recorrentes não podem exceder a recorrência em meses, com limite global de 12
  • o valor mínimo por parcela é R$ 5,00
Required range: 1 <= x <= 12
Example:

1

​
description
string | null

Nome amigável do preço.

Example:

"Plano Mensal Premium"

​
unit_amount_decimal
string

Valor em centavos como string.

Example:

"2990"

​
recurring
object

Configuração de recorrência (apenas para type=recurring).

​
external_code
string | null

Código externo para idempotência.

Example:

"price_premium_monthly"

​
effective_max_card_installments
integer
read-only

Máximo efetivo de parcelas aceitas no cartão após aplicar as regras de recorrência e valor mínimo.

Required range: 1 <= x <= 12
Example:

1

​
installment_selection_available
boolean
read-only

Indica se a seleção de parcelas está disponível para o preço.

Example:

false