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 API Simplo dá controle total sobre cobranças, produtos, preços, assinaturas, faturas e checkout — tudo via REST, JSON e autenticação por chave de API. Se você já conhece APIs de billing, vai se sentir em casa. Se é a primeira vez, comece pelo guia rápido — em alguns minutos você cria seu primeiro cliente e gera uma fatura paga.

O que dá pra fazer

Cobrar clientes

Cadastre clientes, emita faturas avulsas, gere boletos, cartões e Pix.

Gerenciar assinaturas

Crie planos recorrentes, troque de plano, pause, cancele e reative.

Receber pagamentos via Checkout

Hospede o checkout no domínio do Simplo ou redirecione direto para o link.

Reagir a eventos

Receba webhooks quando faturas são pagas, reembolsadas ou recusadas.

Endpoint base

https://besimplo.com/api/v1
Toda chamada autenticada usa o header Authorization: ApiKey sua-chave-aqui. Saiba mais sobre autenticação.

Próximos passos

1

Crie sua conta

Cadastre-se em besimplo.com e gere sua primeira chave de API no painel.
2

Faça a primeira chamada

Siga o guia rápido para criar um cliente, um produto e uma fatura em menos de 10 minutos.
3

Configure webhooks

Aponte uma URL pública para receber eventos. Veja o guia de webhooks.
4

Vá para produção

Troque sua chave de sandbox pela chave de produção e ative seu meio de pagamento.
Toda a API responde em português brasileiro nas mensagens de erro e nas descrições. Identificadores são em inglês (createCustomer, listInvoices) para padronização técnica.