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

ParameterTypeRequiredDescription
customerstringYesId of the customer who pays, starting with cus_, from List customers or Create customer.
billingTypestringYesHow the customer pays each payment. UNDEFINED lets the payer choose among the methods enabled on the account.Values: BOLETO, PIX, CREDIT_CARD, UNDEFINED
valuenumberYesAmount of each payment, in reais, for example 19.9.
nextDueDatestringYesDue date of the first payment, in YYYY-MM-DD.
cyclestringYesHow often a payment is generated. BIWEEKLY is every two weeks and BIMONTHLY every two months.Values: WEEKLY, BIWEEKLY, MONTHLY, BIMONTHLY, QUARTERLY, SEMIANNUALLY, YEARLY
descriptionstringNoDescription of the subscription, shown to the payer.
endDatestringNoLast due date of the subscription, in YYYY-MM-DD. Without it and maxPayments, the subscription has no end.
maxPaymentsintegerNoMaximum number of payments the subscription generates.
externalReferencestringNoIdentifier of the subscription in your own system, usable as a filter in List subscriptions.
discountobjectNoDiscount for paying each payment early.
interestobjectNoInterest for paying after the due date. Leave it out to keep the interest set on the account, because sending it overrides that setting.
fineobjectNoFine 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

See all 12 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.