Visão geral da API

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

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).

Cadastre e gerencie quem paga.

Defina o que você vende.

Configure quanto e com que frequência cobrar.

Conecte clientes a planos recorrentes.

Liste e consulte cobranças geradas.

Páginas de pagamento hospedadas.

Consulte, filtre pela entrega e reenvie o que não chegou.

Eventos enviados ao seu servidor.

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.

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.