Update subscription with the Asaas API

Updates 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.

Identifier
asaas_update_subscription

The request

POST https://connect.reportei.com/api/tools/asaas_update_subscription/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "id": "<id>"
  }
}

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
idstringYesId of the subscription, starting with sub_, from List subscriptions or Create subscription.
valuenumberNoNew amount of each payment, in reais. A credit card subscription only changes value with card tokenization enabled on the account.
statusstringNoINACTIVE stops generating payments and keeps the existing ones. ACTIVE reactivates the subscription and needs a new nextDueDate.Values: ACTIVE, INACTIVE
nextDueDatestringNoDue date of the next payment not generated yet, in YYYY-MM-DD. It does not move the payments already generated.
billingTypestringNoHow the customer pays each payment. UNDEFINED lets the payer choose among the methods enabled on the account.Values: BOLETO, PIX, CREDIT_CARD, UNDEFINED
cyclestringNoHow 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.
updatePendingPaymentsbooleanNotrue also applies the changes to the pending payments already generated.
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 current setting.
fineobjectNoFine for paying after the due date. Leave it out to keep the current 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_update_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.