# Usar boletos com assinaturas Saiba como usar boletos com assinaturas. Aprenda a configurar o [boleto](https://docs.stripe.com/payments/boleto.md) como *forma de pagamento* (PaymentMethods represent your customer's payment instruments, used with the Payment Intents or Setup Intents APIs). O boleto é uma guia com um número gerado que pode ser obtido pelos *clientes* (Customer objects represent customers of your business. They let you reuse payment methods and give you the ability to track multiple payments) em caixas eletrônicos, bancos, portais de bancos online ou agências autorizadas. ## Habilitar boleto Antes de iniciar a integração, acesse **Gerenciar pagamentos que exigem confirmação** em [Configurações de assinaturas e e-mails](https://dashboard.stripe.com/settings/billing/automatic) e habilite **Enviar um link hospedado pela Stripe para os clientes confirmarem os pagamentos quando necessário**. Acesse as [configurações de formas de pagamento](https://dashboard.stripe.com/settings/payment_methods) e ative o Boleto como forma de pagamento. Clique em **Configurar** para definir o prazo de validade da guia. ## Escolher o método de cobrança Você pode definir o método de cobrança no Dashboard ou [API](https://docs.stripe.com/api/invoices/create.md#create_invoice-collection_method). Para faturas, é possível escolher entre enviar uma fatura ou cobrar automaticamente o cliente. Se estiver usando o API, os valores `send_invoice` e `charge_automatically` determinam o método de cobrança. | | Enviar fatura | Cobrar automaticamente | | ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Quando usar | - O cliente não definiu a forma de pagamento preferida para pagar faturas ou assinaturas. Neste caso, você quer oferecer a opção de usar um cartão de crédito ou boleto. - Faltam dados importantes do cliente, necessários para usar o boleto (nome completo, endereço e ID fiscal). | - O cliente já optou por pagar faturas e assinaturas usando boletos. - Você tem os dados do cliente necessários para criar uma fatura que usa boleto (nome completo, endereço e ID fiscal). | | Experiência do cliente | - O cliente precisa informar novamente os dados pessoais (nome completo, endereço e ID fiscal) para cada fatura enviada ou novo período de serviço de assinatura. Esse método de cobrança não considera a forma de pagamento padrão associada ao cliente. | - O cliente configurou boleto como forma de pagamento padrão. Ele recebe um e-mail com um boleto sempre que você envia uma fatura ou ocorre um período de serviço de assinatura. | | Datas de validade e vencimento | - A fatura precisa ter uma data de vencimento. - A Stripe cria o boleto assim que o cliente informa os dados necessários, independentemente da data de vencimento da fatura. Como os boletos têm uma data de vencimento própria (o padrão é 3 dias), a data de vencimento da fatura e a data de validade do boleto nem sempre são iguais. O boleto pode expirar antes ou depois do vencimento da fatura. | - A fatura não tem uma data de vencimento. - A Stripe cria o boleto quando o comerciante cria a fatura com uma data de validade (o padrão é 3 dias). | ## Criar um cliente Crie um cliente para cada novo usuário ou empresa que você deseja faturar. Na criação do cliente, configure um [perfil mínimo de cliente](https://docs.stripe.com/payments/boleto/set-up-subscription.md#customer-profile) para ajudar a criar faturas mais úteis e habilite o Smart Retries (se você for usuário do [Invoicing Plus](https://stripe.com/invoicing/pricing)). Depois de configurar o cliente, você pode emitir faturas avulsas ou criar *assinaturas* (A Subscription represents the product details associated with the plan that your customer subscribes to. Allows you to charge the customer on a recurring basis). > Antes de criar um cliente, verifique se ele ainda não existe no Dashboard. Criar várias entradas para o mesmo cliente pode causar problemas posteriormente, como quando você precisa reconciliar o histórico de transações ou coordenar formas de pagamento salvas. #### Dashboard Você pode criar e gerenciar clientes na página [Clientes](https://dashboard.stripe.com/customers) quando não quiser usar código para criar um cliente ou se quiser cobrar manualmente uma fatura avulsa do cliente. > Também é possível criar um cliente no Dashboard durante a criação da fatura. ### Criar um cliente Quando cria um cliente, você pode definir dados da conta e de faturamento, como **E-mail**, **Nome** e **País**, assim como o idioma preferido, a moeda e outros dados importantes do cliente. A página **Clientes** também permite realizar estas atividades: - Filtrar clientes - Excluir clientes - Ver todos os clientes - Exportar uma lista de dados dos clientes Para criar um cliente: 1. Verifique se o cliente já não existe. 1. Clique em **Adicionar cliente** ou pressione **N** na página **Clientes**. 1. É obrigatório informar o **Nome** e o **E-mail da conta** do cliente. 1. Clique em **Adicionar cliente** no diálogo. ### Editar um cliente Para editar o perfil de um cliente: 1. Encontre o cliente que deseja modificar e clique no nome na página **Clientes**. 1. Na página de informações da conta, selecione **Ações** > **Editar dados**. 1. Faça as alterações no perfil do cliente. 1. Clique em **Atualizar cliente**. ### Excluir um cliente Para excluir um cliente: 1. Encontre o cliente que deseja excluir na página **Clientes**. 1. Clique na caixa de seleção ao lado do nome do cliente e depois em **Excluir**. Também é possível clicar na página de dados do cliente e selecionar **Ações** > **Excluir cliente**. #### API Antes de criar um cliente, verifique se ele ainda não existe. Por exemplo, passe um endereço de e-mail para a API [listar todos os clientes](https://docs.stripe.com/api/customers/list.md). ```curl curl -G https://api.stripe.com/v1/customers \ -u "<>:" \ -d email={EMAIL_ADDRESS} ``` Saiba como criar um cliente que usa boleto como forma de pagamento. Consulte [criar um cliente](https://docs.stripe.com/api/customers/create.md) para ver todos os detalhes. #### Enviar uma fatura por e-mail ```curl curl https://api.stripe.com/v1/customers \ -u "<>:" \ --data-urlencode "email=joao@exemplo.com" \ -d "description=My first test customer" ``` #### Cobrar automaticamente o cliente ### Configurar o cliente Para criar um cliente com `name`, `email` e `description`, adicione este código: ```curl curl https://api.stripe.com/v1/customers \ -u "<>:" \ -d "name=João da Silva" \ --data-urlencode "email=joao@exemplo.com" \ -d "description=My first test customer" ``` ### Criar a forma de pagamento boleto Para criar a forma de pagamento boleto, adicione este código: ```curl curl https://api.stripe.com/v1/payment_methods \ -u "<>:" \ -d type=boleto \ -d "boleto[tax_id]=000.000.000-00" \ -d "billing_details[name]=João da Silva" \ --data-urlencode "billing_details[email]=joao@exemplo.com" \ -d "billing_details[address][line1]=1234 Av. Paulista" \ -d "billing_details[address][city]=São Paulo" \ -d "billing_details[address][state]=SP" \ -d "billing_details[address][postal_code]=01310-000" \ -d "billing_details[address][country]=BR" ``` ### Anexar a forma de pagamento boleto a um cliente Para anexar a forma de pagamento boleto a um cliente, adicione este código: ```curl curl https://api.stripe.com/v1/payment_methods/{{PAYMENT_METHOD_ID}}/attach \ -u "<>:" \ -d customer={{CUSTOMER_ID}} ``` ### Configurar a forma de pagamento padrão para esse cliente Para definir a forma de pagamento padrão do cliente como boleto, adicione este código: ```curl curl https://api.stripe.com/v1/customers/{{CUSTOMER_ID}} \ -u "<>:" \ -d "invoice_settings[default_payment_method]={{PAYMENT_ID}}" ``` ## Criar um produto e preço Defina todas as ofertas de negócios e produtos em um só lugar. Os *produtos* (Products represent what your business sells—whether that's a good or a service) definem o que você vende e os *preços* (Prices define how much and how often to charge for products. This includes how much the product costs, what currency to use, and the interval if the price is for subscriptions) acompanham quanto e com que frequência você cobra. Entidade central da Stripe que funciona com *assinaturas* (A Subscription represents the product details associated with the plan that your customer subscribes to. Allows you to charge the customer on a recurring basis), *faturas* (Invoices are statements of amounts owed by a customer. They track the status of payments from draft through paid or otherwise finalized. Subscriptions automatically generate invoices, or you can manually create a one-off invoice) e o [Checkout](https://docs.stripe.com/payments/checkout.md). Os preços habilitam estes casos de uso: - Um provedor de software que cobra uma tarifa de configuração avulsa sempre que um usuário cria uma nova assinatura. - Uma loja de e-commerce que envia uma caixa de produtos regularmente aos clientes por US$ 10 por mês e quer permitir que os clientes comprem complementos avulsos. - Uma firma de serviços profissionais que agora pode criar uma lista padrão de serviços e criar faturas a partir dessa lista em vez de digitar cada item manualmente. - Uma organização sem fins lucrativos que permite aos doadores definir um valor de doação recorrente personalizado por cliente. Gerencie o catálogo de produtos usando produtos e preços. Os produtos definem o que você vende e os preços definem quanto e com que frequência você cobra. Gerencie produtos e seus preços no Dashboard ou pela API. #### Dashboard Se você usou o Dashboard em uma *área restrita* (A sandbox is an isolated test environment that allows you to test Stripe functionality in your account without affecting your live integration. Use sandboxes to safely experiment with new features and changes) para configurar sua empresa, copie cada um dos produtos para o modo de produção usando **Copiar para modo de produção** na [página Catálogo de produtos](https://dashboard.stripe.com/products). Use nossas bibliotecas oficiais para acessar a API Stripe em seu aplicativo. 1. Acesse a página **Catálogo de produtos** e clique em **Adicionar produto**. 1. Defina se quer criar um **Produto de compra avulsa** ou um **Produto de compra avulsa recorrente**. 1. Atribua um nome e preço ao produto. #### API Saiba como criar [produtos](https://docs.stripe.com/api/products.md) e [preços](https://docs.stripe.com/api/prices.md). > Para obter orientações completas sobre como começar a usar o [Stripe CLI](https://docs.stripe.com/stripe-cli.md) ou a API, consulte o [guia de integração completa do Invoicing](https://docs.stripe.com/invoicing/integration.md). ### Criar um produto Para criar um produto, informe o nome dele: ```curl curl https://api.stripe.com/v1/products \ -u "<>:" \ -d "name=Gold Special" ``` ### Criar um preço [Preços](https://docs.stripe.com/api.md#prices) definem quanto e com que frequência cobrar os produtos. Você define o custo do produto, a moeda a ser usada e o intervalo de cobrança (quando o preço refere-se a uma assinatura). Assim como os produtos, se você tem poucos preços, é preferível gerenciá-los no Dashboard. Use o valor unitário para expressar preços na menor unidade da moeda, neste caso, centavos (10 USD são 1.000 centavos, portanto, o valor unitário é 1000). Se não for preciso criar um preço para seu produto, você também pode usar o parâmetro [value](https://docs.stripe.com/api/invoiceitems/create.md#create_invoiceitem-amount) durante a criação do item da fatura. Para criar um preço e atribuí-lo ao produto, passe o ID, o valor unitário e a moeda do produto. Neste exemplo, o preço do produto “Gold Special” é US$ 10: ```curl curl https://api.stripe.com/v1/prices \ -u "<>:" \ -d "product={{PRODUCT_ID}}" \ -d unit_amount=1000 \ -d currency=usd ``` ## Criar uma assinatura Você pode criar e atualizar assinaturas no Dashboard ou na API. Use a API quando você precisa gerenciar um grande número de assinaturas ou quer gerenciá-las automaticamente. > Veja nosso guia de integração para saber como [criar uma integração de assinaturas completa](https://docs.stripe.com/billing/subscriptions/build-subscriptions.md). #### Dashboard ### Criar uma assinatura Para criar uma assinatura: 1. Acesse a página **Pagamentos** > **Assinaturas**. 1. Clique em **+Criar assinatura**. 1. Encontre ou adicione um cliente. 1. Informe os dados de preço e produto. É possível adicionar outros produtos, um cupom ou uma avaliação gratuita à assinatura. Na seção Opções **avançadas**, você pode criar [limites para uso medido](https://docs.stripe.com/products-prices/pricing-models.md#usage-based-pricing) ou adicionar campos de [fatura personalizados](https://docs.stripe.com/invoicing/customize.md). Quando terminar, clique em **Agendar assinatura** ou **Iniciar assinatura**. Quando agendar uma assinatura, você pode iniciá-la imediatamente, no próximo mês ou personalizá-la. Você pode encerrar a assinatura imediatamente, após um número de ciclos ou personalizar uma data. ### Editar uma assinatura Para editar uma assinatura: 1. Acesse a página **Pagamentos** > **Assinaturas**. 1. Encontre a assinatura que deseja modificar e clique no menu de navegação (⋯) e em **Atualizar assinatura**. Também é possível clicar em ✏ edit icon ao lado do nome da assinatura. Nesse menu, você também pode: - **Cancelar a assinatura**: Selecione uma data para cancelar a assinatura imediatamente, no final do período atual ou em uma data personalizada. Também é possível selecionar a opção para reembolsar o último pagamento da assinatura e criar uma [nota de crédito](https://docs.stripe.com/invoicing/dashboard/credit-notes.md) para seu registro. - **Suspender a cobrança de pagamentos**: Selecione a duração da suspensão (indefinida ou terminando em uma data personalizada) e como as faturas devem se comportar durante a suspensão. - **Compartilhar link de atualização de pagamento**: Gere um link que o cliente possa usar para [atualizar a forma de pagamento da assinatura](https://docs.stripe.com/billing/subscriptions/payment-methods-setting.md#update-payment-method). 1. Faça as alterações na assinatura. 1. Clique em **Atualizar assinatura**. ### Excluir uma assinatura Não é possível excluir um objeto de assinatura, mas você pode cancelá-lo ou suspender a cobrança de pagamentos. Consulte [Editar uma assinatura](https://docs.stripe.com/payments/boleto/set-up-subscription.md#edit-susbscription) para obter mais detalhes. #### API ### Criar uma assinatura Quando você cria uma [assinatura](https://docs.stripe.com/api/subscriptions.md), pode enviar faturas por e-mail ao cliente ou cobrar o cliente automaticamente a cada ciclo. #### Enviar uma fatura por e-mail Para criar uma assinatura e enviar uma fatura por e-mail ao cliente a cada período, insira a seguinte programação: ```curl curl https://api.stripe.com/v1/subscriptions \ -u "<>:" \ -d customer={{CUSTOMER_ID}} \ -d "items[0][price]={{RECURRING_PRICE_ID}}" \ -d collection_method=send_invoice \ -d payment_behavior=default_incomplete \ -d "payment_settings[payment_method_types][0]=card" \ -d "payment_settings[payment_method_types][1]=boleto" \ -d days_until_due=3 ``` #### Cobrar automaticamente o cliente Para criar uma assinatura e cobrar automaticamente o cliente a cada período, insira a seguinte programação: ```curl curl https://api.stripe.com/v1/subscriptions \ -u "<>:" \ -d customer={{CUSTOMER_ID}} \ -d "items[0][price]={{RECURRING_PRICE_ID}}" \ -d collection_method=charge_automatically \ -d payment_behavior=default_incomplete \ -d off_session=true ``` ### Usar sessões do Checkout Você também pode criar uma assinatura usando as [sessões do Checkout](https://docs.stripe.com/api/checkout/sessions.md). A Stripe envia ao cliente um boleto gerado previamente ao endereço de e-mail em cada ciclo de assinatura. ```curl curl https://api.stripe.com/v1/checkout/sessions \ -u "<>:" \ -d mode=subscription \ -d customer={{CUSTOMER_ID}} \ -d "line_items[0][price]={{RECURRING_PRICE_ID}}" \ -d "line_items[0][quantity]=1" \ -d "payment_method_options[boleto][expires_after_days]=3" \ --data-urlencode "success_url=https://example.com/success" ``` ### Usar assinaturas programadas Alguns clientes podem desejar agendar a assinatura para começar no futuro ou contratar somente um ano de serviço por vez. As [programações de assinatura](https://docs.stripe.com/api/subscription_schedules.md) permitem configurar fases com um preço recorrente para começar no futuro ou configurá-las para terminar em uma data específica. Se quiser agrupar compras avulsas com o começo de uma fase, faça-o usando `add_invoice_items` em uma fase: #### curl ```bash curl https://api.stripe.com/v1/subscription_schedules \ -u <>: \ -d customer="{{CUSTOMER_ID}}" \ -d start_date=1775001600 \ -d "phases[0][items][0][price]={{RECURRING_PRICE_ID}}" \ -d "phases[0][add_invoice_items][0][price]={{PRICE_ID}}" ``` Isso agenda uma assinatura de US$ 10 por mês para começar no futuro e sua primeira fatura incluirá uma tarifa avulsa de US$ 20. Se você configurar `add_invoice_items` em fases futuras, os itens de fatura não serão gerados até o início dessa fase. Se você definir `add_invoice_items` na fase atual, os itens serão gerados imediatamente. ## See also - [Como funcionam as assinaturas](https://docs.stripe.com/billing/subscriptions/overview.md)