Recharge API

Take your store to the next level with Recharge's scalable subscriptions payments solution. With the Recharge API, you can fully customize how subscriptions operate. Recharge provides a RESTful API and event-driven webhooks that allow for complex integration with partners.

Webhooks in Recharge's API are a mechanism for reacting to specified events that are triggered in the system, such as checkout completion, customer activation, or subscription cancellations.

Customizations

Third-party integrations

Use the Recharge API to create better reporting and analytics, fulfillment, loyalty programs, trigger-based emails, and more.

Custom workflows

Optimize your daily activities by automating pricing updates, discount codes, and cancellation flows.

• Develop a product page and custom checkout experience.
• Automate how you communicate with your customers post-checkout.
• Create a custom cancellation flow to reduce churn.

Customer portal

Rebuild your entire customer portal from the ground up. Design and customize how your customers manage their subscriptions and add new functionality specific to your industry.

Access API tokens 

Access tokens are used in token-based authentication to allow an application to access an API. The application receives an access token after a user successfully authenticates and authorizes access, then passes the access token as a credential when it calls the target API. The passed token informs the API that the bearer of the token has been authorized to access the API and perform specific actions specified by the scope that was granted during authorization. Recharge requires an API key for requests to the server. Recharge only accepts requests over HTTPS.

View and create API tokens directly in Recharge: 

1. Select Apps from the merchant portal.
2. Click on API tokens.

The Recharge Terms of Service will display if this is your first time accessing the API tokens page. You must accept the Recharge API Terms of Service before you can create your first API token. 

The Recharge API Terms of Service document governs your access to and use of Recharge's APIs. When you develop on the Recharge platform, you are agreeing to be bound by these terms, therefore, please take a few minutes to review the content before accepting. You can also review the API Terms of Service FAQs for more information. 

1. Check all three terms within the API Terms of Service modal.
2. Click Accept.

You can then proceed with creating an API token after accepting the Recharge API Terms of Service.

Create an API token

Once you have accessed the API Token Creation page, select Create an API Token to generate a new token for your store.

1. Use the Details fields to set a name and contact email for the token.
2. Select No access, Read access, or Read and Write access to set the scope permissions you'd like to grant the token. Access to certain endpoints (ie: payments) require permissions for that end point to be set. 
3. Click Save to create your token.

How to update or review the permission scope for API tokens

To confirm permissions for API tokens are enabled, or if you need to update an API token, check the following:

1. Go to API tokens in the Recharge merchant portal.

   

2. Click on the name of the token you would like to check. This opens the Edit API token page.
3. Under Permission locate the setting you need to edit, then under Scope select from the dropdown menu either No access, Read access, or Read and Write access.

   

4. Review the settings and click the Save button.

Enable API Token permissions for other users

By default, the store owner is the only one with the ability to create and manage API tokens.

The store owner can update the account permissions for an existing account, granting staff and developer accounts access to the API Tokens page.

Refer to Enabling Recharge user and account permissions for additional information. 

Rate limits

Recharge’s standard rate limit is ​​2 calls/second leak, 40 call bucket (1x1). 

Merchants on the Pro plan have a default rate of ​​4 calls/second leak, 80 call bucket (2x2).

Contact the Recharge support team if you require a higher rate limit, or if you receive a 429 error.

Developer support

• Visit the Developer Docs to view guides and tutorials for using the Recharge API.
• Access the API Reference to view the Recharge API specification. 
• Check out the Recharge Developer Hub for additional resources, including links to the Recharge Status Page and Changelog. 
• Recharge operates a public channel on Slack for Recharge API-related questions. Reach out to the Recharge support team if you require access.