Create subscription with the Recharge API
Creates a subscription on an address of a customer and returns it. The product needs at least one plan in Recharge. The frequency fields, the first charge date, the variant, the quantity and the address are required.
- Identifier
- recharge_create_subscription
The request
POST https://connect.reportei.com/api/tools/recharge_create_subscription/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"address_id": 1,
"external_variant_id": {},
"quantity": 1,
"next_charge_scheduled_at": "<next_charge_scheduled_at>",
"order_interval_unit": "day",
"order_interval_frequency": 1,
"charge_interval_frequency": 1
}
}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 |
|---|---|---|---|
| address_id | integer | Yes | Id of an address of the customer, from the addresses of Get customer with include addresses, or the address_id of a subscription in List subscriptions. |
| external_variant_id | object | Yes | Product variant in the store platform. The variant id comes from external_variant_id of a subscription in List subscriptions, or from the product page in the store admin. |
| quantity | integer | Yes | Number of units in each order. |
| next_charge_scheduled_at | string | Yes | Date of the first charge, as YYYY-MM-DD. |
| order_interval_unit | string | Yes | Unit of the order and charge frequencies.Values: day, week, month |
| order_interval_frequency | integer | Yes | Number of order_interval_unit between orders, such as 1 for a monthly order. |
| charge_interval_frequency | integer | Yes | Number of order_interval_unit between charges. Equal to order_interval_frequency when each order is paid on its own; a multiple of it for a prepaid subscription. |
| order_day_of_month | integer | No | Day of the month the orders are created on, when order_interval_unit is month. |
| order_day_of_week | integer | No | Day of the week the orders are created on, when order_interval_unit is week. |
| expire_after_specific_number_of_charges | integer | No | Number of charges after which the subscription expires. Without it, the subscription runs until it is cancelled. |
| price | string | No | Price of one unit, such as 10.00. |
| product_title | string | No | Name of the product. |
| properties | array | No | Line item properties of the subscription, such as a color or an engraving text. |
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_create_subscription. It becomes your agent's tool definition with no conversion.
Other Recharge tools
- List subscriptionsGETLists the subscriptions of the store with customer, address, product, quantity, price, frequency, status and next_charge_scheduled_at. Up to 250 per page: pass the next_cursor of the response as cursor to read the next page.
- Get subscriptionGETReturns one subscription with product, quantity, price, frequency, status, cancellation reason and next_charge_scheduled_at.
- Update subscriptionPUTChanges an active subscription and returns it. Changing order_interval_unit, order_interval_frequency or charge_interval_frequency needs all three, recalculates the next charge date and removes skipped and manually changed charges. To move only the next charge, use Set subscription next charge date.
- Cancel subscriptionPOSTCancels an active subscription and returns it. Recharge may email the customer and the store owner about it, unless send_email is false.
- Activate subscriptionPOSTReactivates a cancelled subscription and returns it, clearing the cancellation date and reason.
- Set subscription next charge datePOSTMoves the next charge of a subscription to another date and returns the subscription. When two active subscriptions of the same address end up on the same date, their charges are merged into a new charge with a new id.
- List customersGETLists the customers of the store with email, name, the count of active subscriptions and whether the payment method is valid or in dunning. Filter by email to find one customer. Up to 250 per page: pass the next_cursor of the response as cursor.
- Get customerGETReturns one customer. With include, the response also brings the addresses, subscriptions or payment methods of the customer; the id of each address is the address_id that Create subscription takes.
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
