The Recharge API is currently not supported by Recharge for the Shopify Checkout Integration. However, we recognize that developers or merchants may need access to complete customizations or to integrate unsupported third-party apps.
This guide goes over the required store acknowledgment for access, testing requirements, and general guidance on functional API endpoints.
Recharge API and Shopify Checkout
The Recharge API is currently not supported for the Shopify Checkout as we continue to build out parity to support the integration. For more information, visit Shopify Checkout Integration status.
Upon request, we can enable Recharge API token access with the following acknowledgments:
- The Recharge API is not supported for the Shopify Checkout at this time. 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.
Stores interested in using the Recharge API will need to fill out an acknowledgment form that covers existing limitations. To fill out the form, please reach out to Recharge Support.
Though many endpoints are functional, some variables are not currently available 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 object functionality
While the API is not currently supported, the Recharge team has provided guidance for the following objects.
|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|
All webhooks are functional. Note that the /created webhooks will now fire off of all completed Shopify checkouts.
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