The Recharge API is supported for Shopify Checkout Integration merchants. However, there are a few endpoints and properties that are unsupported. This article outlines limitations for using the API.
Recharge API and Shopify Checkout
You will need to contact Recharge support to request access to the API. Upon request, we can enable Recharge API token access with the following acknowledgments:
- Merchants and developers are responsible for troubleshooting and debugging any issues that arise.
- Recharge recommends thoroughly testing API endpoints end-to-end.
- Merchants and/or developers are responsible for testing any third-party apps they are using with the Recharge API token.
Though many endpoints are functional, some properties belonging to the endpoint are currently unavailable due to a Shopify limitation or the Recharge feature not being available yet.
|Fields are not currently functional but will work following the release of the associated functionality. For more information, visit Shopify Checkout integration status.|
|charge_interval_frequency and order_interval_frequency, if they have different values||Fields are functional if values are the same. However, if the values are different, in the case of Prepaids, then the use case is currently unsupported. Visit Shopify Checkout integration status for more information.|
|The fields are only available for Recharge Checkout. To apply these fields, you will need to use the Shopify API.|
Line item properties, including cart notes and note attributes, can still be assigned in Recharge but cannot be passed to Shopify on recurring orders due to a Shopify limitation.
Merchants can still use this to store data but will need to retrieve the data from Recharge.
Current endpoint functionality
The following table shows the endpoints that are compatible Shopify Checkout, and those that are still unsupported.
|Create address||No||Cannot pass cart notes or attributes to Shopify due to a Shopify limitation.|
|Update address||Yes||Cannot pass cart notes or attributes to Shopify due to a Shopify limitation.|
|Override shipping lines||N/A||Shipping is handled by Shopify directly.|
|Change next charge date||Yes|
|Refund by amount||No|
Checkout endpoints are not functional with the Shopify Checkout.
|Create customer||Yes||Billing info is controlled by Shopify so billing address in Recharge is only a representation|
|Retrieve customer||Yes||Billing info will not be available when using this endpoint|
|Create discount||Yes||Discount code must match the discount code in Shopify or an error will occur|
|Update discount||Yes||Discount code must match the discount code in Shopify or an error will occur|
|Apply discount to address||Yes||Discount code must match the discount code in Shopify or an error will occur|
|Apply discount to charge||Yes||Discount code must match the discount code in Shopify or an error will occur|
|Free shipping discount||N/A|
The Metafields endpoints are not functional with the Shopify Checkout integration.
|Update order||No||Prepaids are currently not supported on the Shopify Checkout integration.|
|Update order line_items||No|
|Change an order date||No|
|Cange an order variant||No|
All Products endpoints are not functional with the Shopify Checkout integration.
All Shop endpoints are not functional with the Shopify Checkout integration.
|Create subscription||Partially||Certain datapoints, like charge_interval_frequency, are not yet available. For more information, visit Shopify Checkout integration status|
|Update subscription||Yes||Certain datapoints, like charge_interval_frequency, are not yet available. For more information, visit Shopify Checkout integration status|
|Swap subscription||Yes||Only requires the Shopify variant ID|
|Change next charge date||Yes|
|Change subscription address||No|
|Delay charge regen||N/A|
|Bulk create subscriptions||No|
|Bulk update subscriptions||No|
|Bulk delete subscriptions||No|
The following webhooks will not fire with Shopify Checkout:
All other webhooks are functional.
See Shopify Checkout in the Developer Docs for more guides and tutorials on customizing your integration.
Didn’t find what you’re looking for?Contact us