API
You’re viewing the reference for API version 2021-01.See the latest version, V2 →
Recharge API / 2021-01supported

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.

Base URL
https://api.rechargeapps.com
Authentication
X-Recharge-Access-Token
Version header
X-Recharge-Version: 2021-01
GET/subscriptions
curl 'https://api.rechargeapps.com/subscriptions?limit=5' \
  -H 'X-Recharge-Version: 2021-01' \
  -H 'X-Recharge-Access-Token: your_api_token'
16resources
86endpoints
5languages

Start with the fundamentals

How requests are authenticated, versioned, paginated and sorted.

Core Resources

AddressesAddresses represents one of the many shipping locations a customer may have. Subscriptions are tied to a given address. Each…7 endpointsChargesA charge is the representation of a financial transaction linked to the purchase of an item (past or future). It can be a…9 endpointsCheckoutsThe checkout resource allows to create unique checkout experiences. We currently support Stripe , Apple Pay , Google Pay , and…5 endpointsCustomersThe Customer object holds account and billing information. Email is unique on the customer; no two customers for a store can have…7 endpointsDiscountsDiscounts can be applied to checkout, or can be applied directly to an address. Depending on configuration they allow for single…9 endpointsMetafieldsWe now have metafields endpoint on our API! Metafields feature allows you to add additional information to other resources. They…6 endpointsNotificationsThe Customer Notifications API is used to dispatch email notifications to customers within Recharge. The API uses your configured…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 of…9 endpointsProductsDeprecated: The products endpoints in 2021-01 API version are deprecated. Please use the Plans endpoints in the 2021-11 API to…GuideShopThe shop endpoint includes basic info about your Recharge store setup.2 endpointsSubscriptionsSubscriptions are individual items a customer receives on a recurring basis. A subscription is a product added to an address. If…13 endpoints

Webhooks

Async Batch

Admin Resources

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).

Base URL
https://api.rechargeapps.com