Asaas tools
The 12 Asaas operations your product runs on your customer's account through Connect. All of them use the same endpoint, POST /api/tools/{tool}/execute.
- List customersGETLists the customers (payers) of the account, optionally filtered by name, email, CPF or CNPJ, group or external reference. The response has data, totalCount and hasMore; page with offset and limit while hasMore is true.
- Get customerGETReturns one customer, with name, CPF or CNPJ, email, phones, address and notification setting.
- Create customerPOSTCreates a customer, the payer of payments and subscriptions. name and cpfCnpj are required. There is no city field: Asaas takes the city from postalCode.
- Update customerPUTUpdates a customer. Fields not sent stay as they are.
- List paymentsGETLists the payments (cobrancas), optionally filtered by customer, subscription, status, billing type, payment date or external reference. Values are in reais. The response has data, totalCount and hasMore; page with offset and limit while hasMore is true.
- Get paymentGETReturns one payment, with status, value, net value, due date, payment date and the links invoiceUrl (the payment page) and bankSlipUrl (the boleto).
- Create paymentPOSTCreates a payment (cobranca) for a customer, by boleto, Pix or credit card, one-time or in installments. The response has invoiceUrl, the payment page to send to the payer, and Asaas may notify the customer according to the customer notification settings.
- Update paymentPUTUpdates a payment that is still pending or overdue; the customer cannot change. Send billingType, value and dueDate even when they stay the same, with the current values from Get payment. A new value or due date may notify the customer.
- Delete paymentDELETERemoves a payment, which can no longer be paid; it can be restored in Asaas. It does not refund an amount already paid, and removing a payment of a subscription does not end the subscription.
- List subscriptionsGETLists the subscriptions, optionally filtered by customer, status, billing type or external reference. The payments a subscription generates come from List payments with the subscription filter. Page with offset and limit while hasMore is true.
- Create subscriptionPOSTCreates a subscription for a customer, which generates one payment per cycle, the first one due on nextDueDate. The payments show up in List payments with the subscription filter.
- Update subscriptionPUTUpdates a subscription. Changes apply to the payments not generated yet, unless updatePendingPayments is true. status INACTIVE suspends the subscription and keeps its payments, and ACTIVE reactivates it with a new nextDueDate.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.

Conta Azul