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.

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



Intro image
Base URL
https://api.rechargeapps.com

Authentication

Recharge uses API keys to authenticate requests.

Each request to the API should contain an API token in the following header:

X-Recharge-Access-Token:store_api_token

Replace store_api_token with your API key.

All requests must be made over HTTPS.


API Token Scopes

Scopes can be set up from the API token edit page in Recharge to control the level of access of an API token.

The API currently supports the scopes below:

Write Read
read_accounts
write_batches read_batches
write_charges read_charges
write_customers read_customers
write_discounts read_discounts
write_notifications
write_orders read_orders
write_payment_methods read_payment_methods
write_products read_products
write_subscriptions read_subscriptions
write_webhooks read_webhooks
read_store
GET /
curl -i -H 'X-Recharge-Access-Token: your_api_token'
-X GET

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.

Existing API Versions Release notes
2021-11 2021-11 release notes
2021-01

Responses

Recharge uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that failed given the information provided ( e.g. a required parameter was omitted, a charge failed, etc ), and codes in the 5xx range indicate an error with Recharge’s servers.

200 - OK: Everything worked as expected.
201 - OK: The request was successful, created a new resource, and resource created is in the body.
202 - OK: The request has been accepted and is in processing.
204 - OK: The server has successfully fulfilled the request and there is no content to send in the response body.
400 - Bad Request: The request was unacceptable, often due to a missing required parameter.
401 - Unauthorized: No valid API key was provided.
402 - Request Failed: The parameters were valid but the request failed.
403 - The request was authenticated but not authorized for the requested resource (permission scope error).
404 - Not Found: The requested resource doesn’t exist.
405 - Method Not Allowed: The method is not allowed for this URI.
406 - The request was unacceptable, or requesting a data source which is not allowed although permissions permit the request.
409 - Conflict: You will get this error when you try to send two requests to edit an address or any of its child objects at the same time, in order to avoid out of date information being returned.
415 - The request body was not a JSON object.
422 - The request was understood but cannot be processed due to invalid or missing supplemental information.
426 - The request was made using an invalid API version.
429 - The request has been rate limited.
500 - Internal server error.
501 - The resource requested has not been implemented in the current version but may be implemented in the future.
503 - A 3rd party service on which the request depends has timed out.

Extending responses

Our API endpoints and webhooks allow developers to extend responses with additional data in order to optimize calls, allowing for simpler and more efficient implementations.

The API supports including additional objects when using a GET request to retrieve a list or a GET request to retrieve a record by a specific id. This is achieved by using an include query parameter in the request URL. The include value contains the object or objects you want to include in the response of your request. On routes where multiple includes are available, you are able to pass multiple values serparated by a comma ( include=customer,metafields ). The below table defines available include values for commonly used resources of the API.
Webhooks support included_objects on the topics listed below. Webhook included_objects accepts an array of supported values ( included_objects: [ "customer", "metafields"] ). Specifying included_objects will return an enriched payload, containing the original resource and the associated included objects.

Resource Endpoints Webhook topics Supported include and included_objects values
Addresses GET /addresses
GET /addresses/{id}
address/created
address/updated
customer
payment_methods(beta)
Charges GET /charges
GET /charges/{id}
charge/created
charge/failed
charge/max_retries_reached
charge/paid
charge/refunded
charge/uncaptured
charge/upcoming
charge/updated
charge/deleted
customer
metafields
payment_methods (beta)
Customers GET /customers
GET /customers/{id}
customer/activated
customer/created
customer/deactivated
customer/payment_method_updated
customer/updated
customer/deleted
addresses
metafields
payment_methods (beta)
Orders order/cancelled
order/created
order/deleted
order/processed
order/payment_captured
order/upcoming
order/updated
order/success
GET /orders
GET /orders/{id}
customer
metafields
Payment Methods GET /payment_methods
GET /payment_methods/{id}
addresses
Subscriptions GET /subscriptions
GET /subscriptions/{id}
subscription/activated
subscription/cancelled
subscription/created
subscription/deleted
subscription/skipped
subscription/updated
subscription/unskipped
customer
metafields

Cursor Pagination

By default, calls for a list of objects will return 50 results. Using the limit parameter, that can be increased to 250 results per response.

When there are more results than the current limit a cursor may be used to request additional results.

The next_cursor and previous_cursor attributes are are included in all list responses.

To request the next set of results, find the next_cursor in the list response and include it in the url with the cursor parameter e.g. GET https://api.rechargeapps.com/subscriptions?limit=250&cursor=<next_cursor>

To request the previous set of results, find the previous_cursor in the list response and include it in the url with the cursor parameter e.g. GET https://api.rechargeapps.com/subscriptions?limit=250&cursor=<previous_cursor>


Retrieving total number of records

Starting with the 2021-11 version of the API, you will not be able to retrieve a count of total records for a given GET request. If you are building a UI page that allows end users to paginate through result sets (such as paginating through a list of orders or subscriptions), we recommend that your pagination implementation allow users to go to the next and previous page of results (as opposed to allowing users to jump to specific page in the results). This aligns well with the previous_cursor and the next_cursor fields included in all list responses.

Example Request
URL="https://api.rechargeapps.com/charges?limit=5"

response=$(curl -s -w "%{http_code}"\ 
    -H 'X-Recharge-Access-Token: your_api_token' \ 
    -H 'X-Recharge-Version: 2021-11' \    -X GET $URL)

content=$(sed '$ d' <<< "$response") # get all but the last line which contains the status code

# Display results
echo $content | jq "."

# parse next url
echo "Next URL"
next_cursor=$(jq ".next_cursor" <<< "${content}")

# Notice next_cursor value is passed as page_info query param
echo "$URL&page_info=$next_cursor"

Sorting

The API supports sorting of results when using a GET request to retrieve a list. Sorting is achieved using a sort_by query parameter in the request URL. The sort_by value contains the parameter and sort direction for your results (ascending or descending), and available sort_by values vary between resources. The below table defines available sort_by options for commonly used resources.


Resource Supported sort_by_values
Address Default: id-desc
Options: id-asc id-desc updated_at-asc updated_at-desc
Async Batch Default: id-desc
Options: id-asc id-desc created_at-asc created_at-desc
Charge Default: id-asc
Options: id-asc id-desc created_at-asc created_at-desc updated_at-asc updated_at-desc charge_date-asc charge-date-desc
Customer Default: id-desc
Options: id-asc id-desc created_at-asc created_at-desc updated_at-asc updated_at-desc
Discount Default: id-desc
Options: id-asc id-desc created_at-asc created_at-desc updated_at-asc updated_at-desc
Metafield Default: id-desc
Options:id-asc id-desc updated_at-asc updated_at-desc
Onetime Default: id-desc
Options: id-asc id-desc created_at-asc created_at-desc updated_at-asc updated_at-desc
Order Default: id-desc
Options: id-asc id-desc updated_at-asc updated_at-desc processed_at-asc processed_at-desc scheduled_at-asc scheduled_at-desc
Plan Default: id-desc
Options:id-asc id-desc updated_at-asc updated_at-desc
Product Default: id-desc
Options: id-asc id-desc created_at-asc created_at-desc updated_at-asc updated_at-desc title-asc title-desc
Subscription Default: id-desc
Options: id-asc id-desc created_at-asc created_at-desc updated_at-asc updated_at-desc
Webhook Default: id-desc
Options: id-asc id-desc

Addresses

An Addresses record represents a shipping address. Each customer can have multiple addresses. Subscriptions are a child object of an address.

Endpoints
POST
/addresses
GET
/addresses/{id}
PUT
/addresses/{id}
DELETE
/addresses/{id}
GET
/addresses
POST
/addresses/merge

The address object

An Addresses record represents a shipping address. Each customer can have multiple addresses. Subscriptions are a child object of an address.

Attributes
  • id
    integer

    Unique numeric identifier for the Address.

  • payment_method_id
    integer

    Unique numeric identifier for the Payment Method associated to the Address.

  • address1
    string

    The street associated with the Address.

  • address2
    string

    Any additional information associated with the Address.

  • city
    string

    The city associated with the address.

  • company
    string

    The company associated with the address.

  • country_code
    string

    2-letter country code.

  • customer_id
    integer

    Unique numeric identifier for the customer associated with the address.

  • discounts
    array

    A list of discounts applied on the address. These discounts will apply to future recurring charges associated with this address.

  • first_name
    string

    The customer’s first name associated with the address.

  • last_name
    string

    The customer’s last name associated with the address.

  • order_attributes
    array

    Replaces cart_attributes. Extra information that is added to the order.

  • order_note
    string

    Notes to be added to all orders associated with the address.

  • phone
    string

    The phone number associated with the address.

  • presentment_currency
    string

    The currency on the subscription contract in Shopify.

    Only set if the currency is different from the store-level currency. Else, will be null.

  • province
    string

    The state or province associated with the address.

  • shipping_lines_override
    array

    Used when shipping rates need to be overridden.

    If this parameter has value null, rates will be fetched when Charge is created or regenerated

  • zip
    string

    The zip or postal code associated with the address.

  • created_at
    datetime

    The date and time when the address was created.

  • updated_at
    datetime

    The date and time when the address was last updated.

The address object
{
  "address": {
    "id": 21317826,
    "payment_method_id": 17874235,
    "address1": "1776 Washington Street",
    "address2": "",
    "city": "Los Angeles",
    "company": "Recharge",
    "country_code": "US",
    "created_at": "2018-11-14T09:00:01",
    "customer_id": 18819267,
    "discount_id": null,
    "first_name": "John",
    "last_name": "Doe",
    "order_attributes": [
      {
        "name": "custom name",
        "value": "custom value"
      }
    ],
    "order_note": "My recurring order note.",
    "phone": "5551234567",
    "presentment_currency": null,
    "shipping_lines_override": [
      {
        "code": "Standard Shipping",
        "price": "0.00",
        "title": "Standard Shipping"
      }
    ],
    "updated_at": "2018-11-14T09:00:01",
    "zip": "90404"
  }
}

Create an address

Create a new address for a customer.

Scopes: write_customers
Body Parameters
  • customer_id
    integer
    * Required

    Unique numeric identifier for the customer associated with the address.

  • address1
    string
    * Required

    The street associated with the Address. Minimum length is 1 character.

  • address2
    string

    Any additional information associated with the shipping address.

  • city
    string
    * Required

    The city associated with the shipping address.

  • company
    string

    The company associated with the shipping address.

  • country_code
    string
    * Required

    2-letter country code.

    Check if the store supports shipping to this country. This is set by the merchant in their Shipping Settings page.

  • discounts
    array

    List of discounts applied on the Address.

  • first_name
    string
    * Required

    The customer’s first name associated with the address. Minimum length is 1 character.

  • last_name
    string
    * Required

    The customer’s last name associated with the address. Minimum length is 1 character.

  • order_attributes
    array

    Extra information that is added to the order.

  • order_note
    string

    Notes to be added to all orders associated with the address.

  • payment_method_id
    integer

    Payment method id for the Payment_method to be associated to this address.

  • phone
    string
    * Required

    The phone number associated with the address. Must be included in the request schema but can be an empty string.

  • province
    string
    * Required

    The state or province associated with the address. Check if country requires a province COUNTRIES_REQUIRING_PROVINCE.

  • shipping_lines_override
    array

    Used when shipping rates need to be overridden. If this parameter has value null, rates will be fetched when a related Charge is created or regenerated

  • zip
    string
    * Required

    The zip or postal code associated with the address.

    Check if the country requires a zip code COUNTRIES_NOT_REQUIRING_ZIP. If not included in the list then a zip code with the minimum length of 1 character is required. If the country is United States validate against regex UNITED_STATES_ZIP_REGEX. If country is United Kingdom then validate against regex UNITED_KINGDOM_ZIP_REGEX.

Responses
  • 201

    OK: The request was successful, created a new resource, and resource created is in the body.

POST
/addresses
curl https://api.rechargeapps.com/addresses \ 
 -H 'X-Recharge-Version: 2021-11' \ 
 -H 'Content-Type: application/json' \ 
 -H 'X-Recharge-Access-Token: your_api_token' \ 
 -d '{
  "customer_id": 22152215,
  "address1": "1776 Washington Street",
  "address2": "",
  "city": "Los Angeles",
  "company": "Recharge",
  "country_code": "US",
  "first_name": "John",
  "last_name": "Doe",
  "order_attributes": [
    {
      "name": "custom name",
      "value": "custom value"
    }
  ],
  "phone": "5551234567",
  "province": "California",
  "zip": "90404"
}'
Response
{
  "address": {
    "id": 42171447,
    "address1": "1030 Barnum Ave",
    "address2": "Suite 101",
    "city": "Stratford",
    "company": "Fake Company",
    "country_code": "US",
    "created_at": "2020-02-19T17:40:09",
    "customer_id": 37657002,
    "discounts": [],
    "first_name": "Fake First",
    "last_name": "Fake Last",
    "order_attributes": [
      {
        "name": "custom name",
        "value": "custom value"
      }
    ],
    "order_note": "My recurring order note",
    "phone": "999-999-9999",
    "presentment_currency": null,
    "province": "Connecticut",
    "shipping_lines_override": [],
    "updated_at": "2020-12-17T18:50:27",
    "zip": "06614"
  }
}

Retrieve an address

Retrieves address for customer based on specified address id.

Scopes: read_customers
Responses
  • 200

    successful response

GET
/addresses/{id}
curl 'https://api.rechargeapps.com/addresses/21317826' \ 
 -H 'X-Recharge-Version: 2021-11' \ 
 -H 'X-Recharge-Access-Token: your_api_token'
Response
{
  "address": {
    "id": 42171447,
    "payment_method_id": 17874235,
    "address1": "1030 Barnum Ave",
    "address2": "Suite 101",
    "city": "Stratford",
    "company": "Fake Company",
    "country_code": "US",
    "created_at": "2020-02-19T17:40:09",
    "customer_id": 37657002,
    "discounts": [],
    "first_name": "Fake First",
    "last_name": "Fake Last",
    "order_attributes": [
      {
        "name": "custom name",
        "value": "custom value"
      }
    ],
    "order_note": "My recurring order note",
    "phone": "999-999-9999",
    "presentment_currency": null,
    "province": "Connecticut",
    "shipping_lines_override": [],
    "updated_at": "2020-12-17T18:50:27",
    "zip": "06614"
  }
}

Update an address

Updates an existing address to match the specified parameters.

Note: When updating the country property you will have to update the zip property as well, otherwise you will receive an error.

Scopes: write_customers
Body Parameters
  • address1
    string

    The street associated with the Address. Minimum length is 1 character.

  • address2
    string

    Any additional information associated with the shipping address.

  • city
    string

    The city associated with the shipping address. Minimum length is 1 character.

  • company
    string

    The company associated with the shipping address.

  • country_code
    string

    2-letter country code.

    Check if the store supports shipping to this country. This is set by the merchant in their Shipping Settings page.

  • discounts
    array

    A list of discounts applied on the address. These discounts will apply to future recurring charges associated with this address.

  • first_name
    string

    The customer’s first name associated with the address. Minimum length is 1 character.

  • last_name
    string

    The customer’s last name associated with the address. Minimum length is 1 character.

  • order_attributes
    array

    Extra information that is added to the order.

  • order_note
    string

    Notes to be added to all orders associated with the address.

  • payment_method_id
    integer

    Payment method id for the Payment_method to be associated to this address.

  • phone
    string

    The phone number associated with the address. Must be included in the request schema but can be an empty string.

  • province
    string

    The state or province associated with the address. Check if country requires a province COUNTRIES_REQUIRING_PROVINCE.

  • shipping_lines_override
    array

    Used when shipping rates need to be overridden. If this parameter has value null, rates will be fetched when a related Charge is created or regenerated.

  • zip
    string

    The zip or postal code associated with the address. Check if the country requires a zip code COUNTRIES_NOT_REQUIRING_ZIP. If not included in the list then a zip code with the minimum length of 1 character is required. If the country is United States then validate against regex UNITED_STATES_ZIP_REGEX. If country is United Kingdom then validate against regex UNITED_KINGDOM_ZIP_REGEX.

Responses
  • 200

    successful response

PUT
/addresses/{id}
curl -X PUT 'https://api.rechargeapps.com/addresses/38700614' \ 
 -H 'X-Recharge-Version: 2021-11' \ 
 -H 'Content-Type: application/json' \ 
 -H 'X-Recharge-Access-Token: your_api_token' \ 
 -d '{"address1": "1776 Washington Street"}'
Response
{
  "address": {
    "id": 42171447,
    "payment_method_id": 17874235,
    "address1": "1030 Barnum Ave",
    "address2": "Suite 101",
    "city": "Stratford",
    "company": "Fake Company",
    "country_code": "US",
    "created_at": "2020-02-19T17:40:09",
    "customer_id": 37657002,
    "discounts": [],
    "first_name": "Fake First",
    "last_name": "Fake Last",
    "order_attributes": [
      {
        "name": "custom name",
        "value": "custom value"
      }
    ],
    "order_note": "My recurring order note",
    "phone": "999-999-9999",
    "presentment_currency": null,
    "province": "Connecticut",
    "shipping_lines_override": [],
    "updated_at": "2020-12-17T18:50:27",
    "zip": "06614"
  }
}

Delete an address

It is possible to delete certain addresses from the store using API.

Only Addresses with no active Subscriptions can be deleted.

Scopes: write_customers
Responses
  • 204

    Content Deleted: The server has successfully fulfilled the request and deleted the desired object and there is no content to send in the response body.

DELETE
/addresses/{id}
curl -X DELETE 'https://api.rechargeapps.com/addresses/38700614'\ 
 -H 'X-Recharge-Version: 2021-11' \ 
 -H 'X-Recharge-Access-Token: your_api_token'
Response
{}

List addresses

Returns all addresses from the store, or addresses for the user given in the parameter.

HTTP examples


GET /addresses

GET /addresses?customer_id=<customer_id>

GET /addresses?discount_id=<discount_id>

GET /addresses?discount_code=<discount_code>

You can combine created_at_min and created_at_max to return all addresses created in the given timespan. This also applies to updated_at_min and updated_at_max parameters.

Scopes: read_customers
Query Parameters
  • created_at_max
    datetime

    Returns addresses created before the given time.

  • created_at_min
    datetime

    Returns addresses created after the given time.

  • customer_id
    integer

    Unique identifier of the customer.

  • discount_code
    string

    Returns addresses that have the provided discount_code.

  • discount_id
    string

    Returns addresses that have the provided discount_id.

  • limit
    string

    Default: 50

    Max: 250

    The amount of results. Default is 50 while the maximum is 250.

  • page
    string

    Default: 1

    The page to show. Default is 1.

  • updated_at_max
    string

    Returns addresses updated before the given date.

  • updated_at_min
    string

    Returns addresses updated after the given time.

  • is_active
    boolean

    Returns active addresses.

Responses
  • 200

    successful response

GET
/addresses
curl 'https://api.rechargeapps.com/addresses' \ 
 -H 'X-Recharge-Version: 2021-11' \ 
 -H 'X-Recharge-Access-Token: your_api_token' \ 
 -d limit=3 -G
Response
{
  "addresses": [
    {
      "id": 42171447,
      "payment_method_id": 17874235,
      "address1": "1030 Barnum Ave",
      "address2": "Suite 101",
      "city": "Stratford",
      "company": "Fake Company",
      "country_code": "US",
      "created_at": "2020-02-19T17:40:09",
      "customer_id": 37657002,
      "discounts": [
        {
          "id": 123456
        }
      ],
      "first_name": "Fake First",
      "last_name": "Fake Last",
      "order_attributes": [
        {
          "name": "custom name",
          "value": "custom value"
        }
      ],
      "order_note": "My recurring order note",
      "phone": "999-999-9999",
      "presentment_currency": null,
      "province": "Connecticut",
      "shipping_lines_override": [
        {
          "code": "Standard Shipping",
          "price": "0.00",
          "title": "Standard Shipping"
        }
      ],
      "updated_at": "2020-12-17T18:50:27",
      "zip": "06614"
    }
  ]
}

Merge addresses

Merges up to 10 target addresses into 1 source address.

Scopes: write_customers
Body Parameters
  • delete_source_addresses
    boolean

    Indicates whether source addresses should be deleted.

  • next_charge_date
    string

    Specifies the next charge date of the associated subscriptions on the target address.

  • target_address
    object
    * Required

    The address all of the subscriptions should be moved to.

  • source_addresses
    array
    * Required

    The list of addresses that the subscriptions should move from.

Responses
  • 200

    successful response

POST
/addresses/merge
curl -X POST 'https://api.rechargeapps.com/addresses/merge' \ 
 -H 'X-Recharge-Version: 2021-11' \ 
 -H 'Content-Type: application/json' \ 
 -H 'X-Recharge-Access-Token: your_api_token' \ 
 -d '{"target_address": 42171447, "source_addresses": [42171446, 42171445]}'
Response
{
  "address": {
    "id": 42171447,
    "payment_method_id": 17874235,
    "address1": "1030 Barnum Ave",
    "address2": "Suite 101",
    "city": "Stratford",
    "company": "Fake Company",
    "country_code": "US",
    "created_at": "2020-02-19T17:40:09",
    "customer_id": 37657002,
    "discounts": [],
    "first_name": "Fake First",
    "last_name": "Fake Last",
    "order_attributes": [
      {
        "name": "custom name",
        "value": "custom value"
      }
    ],
    "order_note": "My recurring order note",
    "phone": "999-999-9999",
    "presentment_currency": null,
    "province": "Connecticut",
    "shipping_lines_override": [],
    "updated_at": "2020-12-17T18:50:27",
    "zip": "06614"
  }
}

Charges

A charge is the representation of a financial transaction linked to the purchase of an item (past or future). It can be a transaction that was processed already or the representation of an upcoming transaction. A Charge is linked to its corresponding Orders (one Order for pay as you go subscriptions and several for pre-paid). Orders are created once the corresponding Charge is successful. After successful payment, the first Order will be immediately submitted to the external platform if applicable (e.g. Shopify, BigCommerce).

Endpoints
GET
/charges/{id}
GET
/charges
POST
/charges/{id}/apply_discount
POST
/charges/{id}/remove_discount
POST
/charges/{id}/skip
POST
/charges/{id}/unskip
POST
/charges/{id}/refund
POST
/charges/{id}/process
POST
/charges/{id}/capture_payment

Checkouts

Checkouts allow you to create, update, and process a Checkout programmatically. Shipping cost and sales tax determination are automatic functions of the Recharge Checkout resource.

Related guides: Recharge checkout integrations, How to use the Checkout resource

Important - The Checkout endpoints are only available for BigCommerce and Custom. Checkouts on Shopify must go through Shopify.

Endpoints
POST
/checkouts
GET
/checkouts/{token}
POST
/checkouts
PUT
/checkouts/{token}
GET
/checkouts/{token}/shipping_rates
POST
/checkouts/{token}/charge