Update subscription with the Stripe API
Updates a subscription, for example to cancel it at the end of the current period with cancel_at_period_end, or to undo that. Changing the items or prices of the subscription is not available here.
- Identifier
- stripe_update_subscription
The request
POST https://connect.reportei.com/api/tools/stripe_update_subscription/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"subscription": "<subscription>"
}
}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 |
|---|---|---|---|
| subscription | string | Yes | Id of the subscription, starting with sub_, from List subscriptions or Search subscriptions. |
| cancel_at_period_end | boolean | No | true cancels the subscription at the end of the current period, and false undoes a cancellation scheduled this way. |
| cancel_at | integer | No | Unix timestamp, in seconds, at which the subscription is canceled. A date before the end of the current period prorates according to proration_behavior. |
| description | string | No | Description of the subscription, shown to the customer. |
| trial_end | string | No | End of the trial, as a Unix timestamp in seconds, or now to end the trial right away. |
| collection_method | string | No | charge_automatically charges the default payment method of the customer; send_invoice emails each invoice with payment instructions and needs days_until_due.Values: charge_automatically, send_invoice |
| days_until_due | integer | No | Days the customer has to pay each invoice. Only with collection_method send_invoice. |
| proration_behavior | string | No | How a change that affects the billing is prorated: create_prorations (the default) adds the proration to the next invoice, always_invoice invoices it right away and none skips it.Values: always_invoice, create_prorations, none |
Supported connections
Your customer connects their Stripe 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/stripe_update_subscription. It becomes your agent's tool definition with no conversion.
Other Stripe tools
- Search customersGETSearches the customers with the Stripe search query language, by email, name, phone, creation date or metadata. The response has data, has_more and next_page; send next_page as page to get the next page. A customer created or updated in the last minute may not show up yet.
- Get customerGETReturns one customer, with name, email, phone, address, balance in cents and invoice settings. A deleted customer comes back with only id and deleted set to true.
- Create customerPOSTCreates a customer. No field is required, but Stripe sends invoices and receipts only to customers with an email. Address, tax ids and metadata are not available here.
- Update customerPOSTUpdates the name, email, phone or description of a customer. Fields not sent stay as they are.
- Search chargesGETSearches the charges, which are the payment attempts with their status, amount, refunds and disputes, with the Stripe search query language. Amounts are in the smallest unit of the currency, like cents. The response has data, has_more and next_page; send next_page as page to get the next page.
- List subscriptionsGETLists the subscriptions, newest first, optionally of one customer, one price or one status. Without status, canceled subscriptions are left out. Each subscription has its prices in items.data. Page with starting_after while has_more is true.
- Search subscriptionsGETSearches the subscriptions by status, creation date, cancellation date or metadata with the Stripe search query language, which fits questions like new or canceled subscriptions in a period. The response has data, has_more and next_page; send next_page as page to get the next page.
- Search invoicesGETSearches the invoices by customer, subscription, status, date, total or number with the Stripe search query language. Amounts are in the smallest unit of the currency, like cents. The response has data, has_more and next_page; send next_page as page to get the next page.
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