# Simplo

> Documentação da API Simplo — cobrança e assinaturas para o Brasil.

## Docs

- [Cancelar assinatura](https://docs.besimplo.com/api-reference/assinaturas/cancelar-assinatura.md): Cancela imediatamente uma assinatura existente, encerrando todas as cobranças pendentes
- [Consultar assinatura](https://docs.besimplo.com/api-reference/assinaturas/consultar-assinatura.md): Consultar dados de uma assinatura existente na sua conta
- [Criar nova assinatura](https://docs.besimplo.com/api-reference/assinaturas/criar-nova-assinatura.md): Criar nova assinatura na sua conta conectando um Cliente e um Preço existentes
- [Finalizar checkout da assinatura](https://docs.besimplo.com/api-reference/assinaturas/finalizar-checkout-da-assinatura.md): Ativa uma assinatura fornecendo um método de pagamento e efetuando a cobrança.
- [Criar nova sessão de checkout](https://docs.besimplo.com/api-reference/checkout/criar-nova-sessão-de-checkout.md): Criar nova sessão de checkout na sua conta. A sessão permite que um cliente complete um pagamento ou assinatura através de uma interface web.
- [Atualizar cliente](https://docs.besimplo.com/api-reference/clientes/atualizar-cliente.md): Atualizar dados de um cliente existente na sua conta
- [Consultar cliente](https://docs.besimplo.com/api-reference/clientes/consultar-cliente.md): Consultar dados de um cliente existente na sua conta
- [Criar novo cliente](https://docs.besimplo.com/api-reference/clientes/criar-novo-cliente.md): Criar novo cliente na sua conta
- [Listar todas as faturas](https://docs.besimplo.com/api-reference/faturas/listar-todas-as-faturas.md): Retorna uma lista paginada de faturas.
- [Visão geral da API](https://docs.besimplo.com/api-reference/introducao.md): Endpoint base, formato das respostas e onde encontrar a referência completa de cada recurso.
- [Atualizar preço](https://docs.besimplo.com/api-reference/preços/atualizar-preço.md): Atualiza um preço existente.
- [Buscar preço](https://docs.besimplo.com/api-reference/preços/buscar-preço.md): Retorna um preço pelo ID
- [Criar preço](https://docs.besimplo.com/api-reference/preços/criar-preço.md): Cria um novo preço associado a um produto.
- [Listar preços](https://docs.besimplo.com/api-reference/preços/listar-preços.md): Retorna uma lista paginada de preços da conta.
- [Atualizar produto](https://docs.besimplo.com/api-reference/produtos/atualizar-produto.md): Atualiza um produto existente.
- [Buscar produto](https://docs.besimplo.com/api-reference/produtos/buscar-produto.md): Retorna um produto pelo seu ID (UUID).
- [Criar produto](https://docs.besimplo.com/api-reference/produtos/criar-produto.md): Cria um novo produto que pode ter preços associados.
- [Listar produtos](https://docs.besimplo.com/api-reference/produtos/listar-produtos.md): Retorna uma lista paginada de produtos da conta.
- [Criar reembolso](https://docs.besimplo.com/api-reference/reembolsos/criar-reembolso.md): Cria um reembolso para um pagamento existente. O reembolso será processado de acordo com o método de pagamento: - **Cartão de crédito**: Reembolso síncrono, status final retornado imediatamente. - **PIX**: Reembolso assíncrono, status inicial será "refunding" e atualizado via webhook quando concluíd…
- [Cobranca criada](https://docs.besimplo.com/api-reference/webhooks/cobranca-criada.md): Emitido quando uma nova cobranca e criada. O campo `data.payment_intent.due_at` indica a data de vencimento.
- [Cobranca estornada](https://docs.besimplo.com/api-reference/webhooks/cobranca-estornada.md): Emitido quando uma cobranca e estornada com sucesso.
- [Cobranca rejeitada](https://docs.besimplo.com/api-reference/webhooks/cobranca-rejeitada.md): Emitido quando uma cobranca e rejeitada pelo gateway de pagamento.
- [Fatura cancelada](https://docs.besimplo.com/api-reference/webhooks/fatura-cancelada.md): Emitido quando uma fatura e cancelada.
- [Fatura criada](https://docs.besimplo.com/api-reference/webhooks/fatura-criada.md): Emitido quando uma nova fatura e gerada para um cliente.
- [Fatura paga](https://docs.besimplo.com/api-reference/webhooks/fatura-paga.md): Emitido quando uma fatura e paga com sucesso. O campo `data.invoice.paid_at` indica o momento do pagamento.
- [Erros e respostas HTTP](https://docs.besimplo.com/conceitos/erros.md): Códigos que a API retorna, formato das mensagens de erro e como tratar cada situação.
- [Paginação](https://docs.besimplo.com/conceitos/paginacao.md): Como percorrer listas grandes de clientes, faturas e outros recursos sem perder dados.
- [Webhooks](https://docs.besimplo.com/conceitos/webhooks.md): Receba notificações em tempo real quando faturas são pagas, reembolsadas ou recusadas.
- [Autenticação](https://docs.besimplo.com/guias/autenticacao.md): Como autenticar suas requisições, tipos de chave e boas práticas de segurança.
- [Comece em 10 minutos](https://docs.besimplo.com/guias/comece-agora.md): Do zero ao primeiro link de checkout: criar cliente, produto, preço e sessão de checkout em uma sequência única.
- [Bem-vindo à API Simplo](https://docs.besimplo.com/guias/introducao.md): Cobre seus clientes e gerencie assinaturas com uma API simples, em português, pensada para o Brasil.

## OpenAPI Specs

- [openapi](https://docs.besimplo.com/api-reference/openapi.yml)