API
Topics

Versioning

All requests will use your account API settings, unless you send a X-Recharge-Version header to specify the version.
You can use the same token to make calls to all versions. When no version is specified it will default to the default version on your store.

VersionHeader valueStatusRelease notes
V2v2 or 2021-11LatestWhat’s new in V2
2021-012021-01Supported

V2 was previously called 2021-11

V2 is the new name for the version that used to be called 2021-11. It is the same API: same endpoints, same requests and same responses. Only the name changed.

X-Recharge-Version: v2 and X-Recharge-Version: 2021-11 both work and behave identically. The value is not case sensitive, so V2 works too.

If you already send 2021-11

You don’t need to change anything. 2021-11 keeps working, and everything in this reference is available to you, including everything marked New. You can switch the header to v2 whenever you like.

The version attribute on webhooks and async batches, and a store’s default version, still read 2021-11 for V2. When you create or update a webhook you can send v2 or 2021-11 as its version; both are saved and returned as 2021-11.

Everything added to the reference in V2 is marked New throughout these docs and listed in What’s new in V2.

Selecting a version
curl 'https://api.rechargeapps.com/subscriptions' \
  -H 'X-Recharge-Version: v2' \
  -H 'X-Recharge-Access-Token: your_api_token'
The previous name still works
curl 'https://api.rechargeapps.com/subscriptions' \
  -H 'X-Recharge-Version: 2021-11' \
  -H 'X-Recharge-Access-Token: your_api_token'