Skip to main content
GET
/
api
/
v1
/
prices
Listar preços
curl --request GET \
  --url https://besimplo.com/api/v1/prices \
  --header 'Authorization: <api-key>'
{
  "object": "list",
  "url": "/api/v1/prices",
  "has_more": false,
  "data": [
    {
      "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
    }
  ]
}

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

Query Parameters

​
active
boolean

Filtrar por status ativo/inativo

​
product_id
string

Filtrar pelo ID do produto, no formato TypeID com prefixo prod_.

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

"prod_01h455vb4pex5vsknk084sn02q"

​
type
enum<string>

Filtrar por tipo de cobrança

Available options:
one_time,
recurring
​
limit
integer
default:20

Resultados por página

Required range: 1 <= x <= 100
​
page
string

Cursor para próxima página

Response

Lista de preços

​
object
enum<string>
required

Tipo do objeto. Sempre "list" para listas.

Available options:
list
Example:

"list"

​
url
string<uri-reference>
required

URL do recurso solicitado.

Example:

"/api/v1/prices"

​
has_more
boolean
required

Indica se há mais resultados disponíveis para paginação.

Example:

false

​
data
object[]
required

Array de objetos Price.