Cancel subscription with the Recharge API

Cancels an active subscription and returns it. Recharge may email the customer and the store owner about it, unless send_email is false.

Identifier
recharge_cancel_subscription

The request

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

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

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
idintegerYesId of an active subscription from List subscriptions.
cancellation_reasonstringYesReason for the cancellation.
cancellation_reason_commentsstringNoComment on the reason.
send_emailbooleanNoFalse keeps Recharge from sending the cancellation email.

Supported connections

Your customer connects their Recharge 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/recharge_cancel_subscription. It becomes your agent's tool definition with no conversion.

Other Recharge 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.