Recharge tools
The 12 Recharge operations your product runs on your customer's account through Connect. All of them use the same endpoint, POST /api/tools/{tool}/execute.
- 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.
- Create subscriptionPOSTCreates 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.
- 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.
- List chargesGETLists the charges of the store, past and upcoming, with status, scheduled_at, processed_at, totals, customer and line items. Processed charges older than 90 days are not returned. Sorted by id ascending by default; up to 250 per page: pass the next_cursor of the response as cursor.
- Get chargeGETReturns one charge with status, dates, totals, discounts, shipping and the line items, whose purchase_item_id is the subscription. A processed charge older than 90 days returns an error.
- Skip chargePOSTSkips a queued charge for the given subscriptions and returns the charge.
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
