Skip to main content
POST
/
api
/
v1
/
products
Criar produto
curl --request POST \
  --url https://besimplo.com/api/v1/products \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "product": {
    "name": "Plano Premium",
    "description": "Acesso a todas as funcionalidades premium",
    "active": true,
    "external_code": "prod_premium"
  }
}
'
{
  "id": "prod_01h455vb4pex5vsknk084sn02q",
  "object": "product",
  "active": true,
  "created": 1680893993,
  "live_mode": false,
  "name": "Plano Premium",
  "description": "Acesso a todas as funcionalidades premium",
  "external_code": "prod_premium"
}

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

Body

application/json
​
product
object
required

Response

Produto criado com sucesso

​
id
string
required
read-only

ID único do produto, no formato TypeID com prefixo prod_.

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

"prod_01h455vb4pex5vsknk084sn02q"

​
object
enum<string>
required

Tipo do objeto. Sempre 'product'.

Available options:
product
Example:

"product"

​
active
boolean
required

Se o produto está disponível para compra.

Example:

true

​
created
integer<int64>
required
read-only

Timestamp Unix de quando o produto foi criado.

Example:

1680893993

​
live_mode
boolean
required

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

Example:

false

​
name
string
required

Nome do produto.

Example:

"Plano Premium"

​
description
string | null

Descrição do produto.

Example:

"Acesso a todas as funcionalidades premium"

​
external_code
string | null

Código externo para integração. Deve ser único por conta.

Example:

"prod_premium"