Skip to main content
POST
/
api
/
v1
/
checkout
/
sessions
Criar nova sessão de checkout
curl --request POST \
  --url https://besimplo.com/api/v1/checkout/sessions \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "session": {
    "success_url": "https://example.com/success",
    "line_items": [
      {
        "price_id": "price_01h455vb4pex5vsknk084sn02q",
        "quantity": 1
      }
    ],
    "external_code": "CHECKOUT-SESSION-XYZ",
    "customer_id": "cus_01h455vb4pex5vsknk084sn02p",
    "customer": "<unknown>",
    "mode": "subscription",
    "return_url": "https://example.com/return",
    "metadata": []
  }
}
'
{ "live_mode": true, "customer": { "id": "cus_01h455vb4pex5vsknk084sn02p" }, "invoice": { "id": "in_01h455vb4pex5vsknk084sn02q" }, "subscription": { "id": "sub_01h455vb4pex5vsknk084sn02s" }, "amount": 9990, "currency": "brl", "url": "https://besimplo.com/checkout/sessions/cs_01h455vb4pex5vsknk084sn02q?session_id=cs_01h455vb4pex5vsknk084sn02q" }

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

Body

application/json

Dados da sessão de checkout que será criada

​
session
object
required

Response

Operação realizada com sucesso

​
live_mode
boolean
required

Indica se a requisição foi feita em modo produção.

Example:

true

​
customer
object
required
​
invoice
object
required
​
amount
integer
required

Valor total em centavos

Example:

9990

​
currency
enum<string>
required

Código da moeda (ISO 4217).

Available options:
brl
Example:

"brl"

​
url
string<uri>
required

URL da sessão de checkout para redirecionar o cliente

Example:

"https://besimplo.com/checkout/sessions/cs_01h455vb4pex5vsknk084sn02q?session_id=cs_01h455vb4pex5vsknk084sn02q"

​
subscription
object | null

Dados da assinatura (apenas presente quando mode é "subscription" e a fatura está associada a uma assinatura)