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

ParameterTypeRequiredDescription
address_idintegerYesId 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_idobjectYesProduct 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.
quantityintegerYesNumber of units in each order.
next_charge_scheduled_atstringYesDate of the first charge, as YYYY-MM-DD.
order_interval_unitstringYesUnit of the order and charge frequencies.Values: day, week, month
order_interval_frequencyintegerYesNumber of order_interval_unit between orders, such as 1 for a monthly order.
charge_interval_frequencyintegerYesNumber 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_monthintegerNoDay of the month the orders are created on, when order_interval_unit is month.
order_day_of_weekintegerNoDay of the week the orders are created on, when order_interval_unit is week.
expire_after_specific_number_of_chargesintegerNoNumber of charges after which the subscription expires. Without it, the subscription runs until it is cancelled.
pricestringNoPrice of one unit, such as 10.00.
product_titlestringNoName of the product.
propertiesarrayNoLine 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

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.