Skip to main content

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.

A referência da API é gerada automaticamente a partir do nosso schema OpenAPI 3.1. Use o menu lateral para navegar pelos endpoints.

​
Endpoint base

https://besimplo.com/api/v1
Todas as requisições autenticadas usam o header: 
Authorization: ApiKey live_xxxxxxxxxxxxxxxx
Saiba mais sobre autenticação.

​
Formato

  • Requisições: JSON (Content-Type: application/json).
  • Respostas: JSON em UTF-8.
  • Datas: ISO 8601 ou Unix timestamp em segundos (varia por campo — veja a referência).
  • Valores monetários: inteiros em centavos (R$ 99,90 = 9990).
  • Moedas: código ISO 4217 em maiúsculas (BRL).

​
Recursos principais

Clientes

Cadastre e gerencie quem paga.

Produtos

Defina o que você vende.

Preços

Configure quanto e com que frequência cobrar.

Assinaturas

Conecte clientes a planos recorrentes.

Faturas

Liste e consulte cobranças geradas.

Reembolsos

Devolva pagamentos total ou parcialmente.

Checkout

Páginas de pagamento hospedadas.

Webhooks

Eventos enviados ao seu servidor.

​
Schema OpenAPI

A definição completa está disponível como OpenAPI 3.1 YAML — útil se você quer gerar clientes próprios, importar no Postman ou Insomnia.

​
Convenções

  • IDs seguem o padrão TypeID: prefixo descritivo + ULID em base32 (cus_01h455vb4pex5vsknk084sn02p).
  • Recursos relacionados retornam por id apenas — você expande chamando o endpoint do recurso quando precisar.
  • Paginação por cursor em todos os endpoints de listagem. Veja Paginação.