Create subscription with the Asaas API
Creates 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.
- Identifier
- asaas_create_subscription
The request
POST https://connect.reportei.com/api/tools/asaas_create_subscription/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"customer": "<customer>",
"billingType": "BOLETO",
"value": 1,
"nextDueDate": "<nextDueDate>",
"cycle": "WEEKLY"
}
}Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| customer | string | Yes | Id of the customer who pays, starting with cus_, from List customers or Create customer. |
| billingType | string | Yes | How the customer pays each payment. UNDEFINED lets the payer choose among the methods enabled on the account.Values: BOLETO, PIX, CREDIT_CARD, UNDEFINED |
| value | number | Yes | Amount of each payment, in reais, for example 19.9. |
| nextDueDate | string | Yes | Due date of the first payment, in YYYY-MM-DD. |
| cycle | string | Yes | How often a payment is generated. BIWEEKLY is every two weeks and BIMONTHLY every two months.Values: WEEKLY, BIWEEKLY, MONTHLY, BIMONTHLY, QUARTERLY, SEMIANNUALLY, YEARLY |
| description | string | No | Description of the subscription, shown to the payer. |
| endDate | string | No | Last due date of the subscription, in YYYY-MM-DD. Without it and maxPayments, the subscription has no end. |
| maxPayments | integer | No | Maximum number of payments the subscription generates. |
| externalReference | string | No | Identifier of the subscription in your own system, usable as a filter in List subscriptions. |
| discount | object | No | Discount for paying each payment early. |
| interest | object | No | Interest for paying after the due date. Leave it out to keep the interest set on the account, because sending it overrides that setting. |
| fine | object | No | Fine for paying after the due date. Leave it out to keep the fine set on the account, because sending it overrides that setting. |
Supported connections
Your customer connects their Asaas account once, with one of the modes below. The same connection serves every tool of the toolkit.
API key
Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.
The response
On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.
Ready for AI agents
This tool's input is a JSON Schema, available at GET /api/tools/asaas_create_subscription. It becomes your agent's tool definition with no conversion.
Other Asaas tools
- 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.
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