Recharge API / V2latest
The Recharge API reference
The Recharge API is primarily a REST API with some RPC endpoints to support common operations. It has predictable, resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and methods.
V2 was previously called 2021-11. It is the same API under a new name. X-Recharge-Version: v2 and X-Recharge-Version: 2021-11 both work. How versioning works
- Base URL
https://api.rechargeapps.com- Authentication
X-Recharge-Access-Token- Version header
X-Recharge-Version: v2or2021-11
curl 'https://api.rechargeapps.com/subscriptions?limit=5' \
-H 'X-Recharge-Version: v2' \
-H 'X-Recharge-Access-Token: your_api_token'31resources
161endpoints
740additions in V2
Start with the fundamentals
How requests are authenticated, versioned, paginated and sorted.
Core Resources
AddressesAn Addresses record represents a shipping address. Each customer can have multiple addresses. Subscriptions are a child object of…8 endpointsBundle productsNewA Bundle Product describes a product that is sold as a bundle: its variants, the collections customers can choose the contents…2 endpointsBundle SelectionsA bundle selection represents the contents within a Bundle linked to an individual Subscription. It can represent the selection…5 endpointsCharge activitiesNewA charge activity is a record of something that happened to a Charge , such as a payment attempt, a payment failure, a skip, a…1 endpointChargesA charge is the representation of a financial transaction linked to the purchase of an item (past or future). It can be a…11 endpointsCheckoutsCheckouts allow you to create, update, and process a Checkout programmatically. Shipping cost and sales tax determination are…13 endpointsCollectionsCollections allow to create and manage a logical list of Products called a Collection . A Collection contains an ordered list of…9 endpointsCreditsThe Credit Account object represents a set of positive and negative credit adjustments that when summed equal an available…11 endpointsCustomer notification preferencesNewNotification preferences record whether a Customer has opted in or out of transactional, promotional and replenishment…2 endpointsCustomer sessionsNewCustomer sessions are short-lived tokens scoped to a single Customer . They allow a storefront or application to act on behalf of…1 endpointCustomersThe Customer object holds account information. Email is unique on the Customer ; no two customers for a store can have the same…7 endpointsDiscountsDiscounts can be applied to a Checkout , or can be applied directly to an Address . Depending on configuration they allow for…5 endpointsEntitlementsA Customer Entitlement represents access to a specific entitlement feature granted to a customer, typically driven by an active…4 endpointsGift purchasesNewA Gift purchase is created when a customer buys a gift for someone else. It links the sender, the recipient and the Credit…3 endpointsMetafieldsMetafields allow users to add additional information to other resources. They can be used for adding custom fields to objects,…5 endpointsNotificationsThe Customer Notifications resource is used to dispatch email notifications to customers within Recharge. The endpoint uses your…1 endpointOnetimesOnetimes represent non-recurring line items on a QUEUED Charge .5 endpointsOrdersAn order is created after a Charge is successfully processed. The Order contains all the same json data as the Charge . In case…6 endpointsPayment methodsThe Payment Method object holds payment and billing information. A Customer may be associated with many Payment Methods , and an…5 endpointsPlansThe Plans resource is used to create and configure the transactional options for the Product (subscription, prepaid, and onetime…9 endpointsProductsRepresentation of the Products from your catalog in Recharge.5 endpointsRetention strategiesNewA Retention strategy is a cancellation reason a customer can choose when cancelling, together with the message and optional…5 endpointsReward creditsNewA Reward credit is store credit issued to a Customer as a reward. Each reward credit keeps track of its initial value, the…3 endpointsStoreThe store endpoint includes ReCharge settings and other store specific information.1 endpointSubscriptionsSubscriptions are individual items a customer receives on a recurring basis. A Subscription is a Product added to an Address .14 endpoints
Webhooks
Webhook endpointsWebhooks are a mechanism for reacting to specific events that are triggered in the Recharge system. For example, a checkout…6 endpointsWebhooks explainedHere you will find what specific action triggers a given webhook. Address webhooks To use these webhooks your API Token must have…GuideWebhook validationWebhooks created through the API are signed using your API Client Secret so you can verify that each request came from Recharge.…Guide
Async Batch
Async batch EndpointsThe Async batches API can be used for processing large volumes of operations asynchronously, in order to reduce aggregate…6 endpointsAsync batch TasksMost commonly, the response from listing tasks on an async_batch id will be identical to the body of a singular request to…3 endpoints
Admin Resources
Token informationThis resource allows a caller to inspect basic information regarding the token in use. It will only return a single object…2 endpointsAccountsThis resource allows a caller to inspect basic information regarding the staff accounts in the store.2 endpointsEventsThis resource allows a caller to inspect recent events in the store.1 endpoint
Related guides: Generate API tokens, Using the API
API and Platforms compatibility
Recharge offers hosted solutions and integrates with various ecommerce platforms to process recurring transactions with the setup of your choice. In order to be compatible with those platforms some of our API resources and endpoints may be limited in use to a subset of platforms. When that is the case we will flag with the help of tags the checkout/platform association for which that feature is compatible.
When there is no restriction of compatibility no tags will appear.
Below is a legend of the tags you may come across:
| Tag | Checkout solution | Ecommerce platform |
|---|---|---|
| BigCommerce | Recharge hosted | BigCommerce |
| Custom | Recharge hosted or API-first | Custom |
| RCS | Recharge hosted | Shopify |
| SCI | Shopify hosted | Shopify |
You may also come across other tags specifying regional restrictions (e.g. USA Only) or new releases (e.g. Alpha, Beta).
https://api.rechargeapps.com