Skip to main content

Recharge Theme Engine

Shopify Checkout integration Custom BigCommerce Recharge Checkout on Shopify
Sections

The Recharge Theme Engine allows you to customize the interface of your store's customer portal. This portal is a series of pages and controls that allow your customers to view or modify their subscription, change their billing information, or review their order history. With the editor, you'll be able to tailor the look and feel of this portal to fit your store's style and branding.

Eligibility

  • To access the Theme Engine, you need to be on the Recharge Pro Plan.
  • We recommend having experience with JavaScript, AJAX, and HTML. 
  • Your store should have at least one customer with one active subscription.

Recharge Checkout on Shopify

Recharge Checkout on BigCommerce

Shopify Checkout Integration

Developer documentation

Once you have access to the Theme Engine, you can access the developer documentation. 

Note: When using API keys in your applications, ensure they are kept secure in transit and at rest. Publicly exposing your credentials can result in unauthorized access and unexpected changes to data. To help keep your API keys secure, Recharge strongly recommends following these best practices: API Security.

Access the Recharge Theme Engine

Use the theme editor to begin customizing your customer portal theme.

Create a new theme or edit an existing one

Create a new theme if you want to update an existing one to a newer template version. This automatically uses the latest template version, and you can migrate customizations from the existing theme to the new one.

  1. Click Storefront and select Theme Editor in your merchant portal. 
  2. Click Create new theme or click Edit code to work on an existing theme.
  3. If creating a new theme, enter a name in the Theme name field and select the Theme template from the dropdown.
  4. Click Create theme.
    create-new-theme.png
Tip: The Template version shows once you select a Theme template. Subscribe to the Recharge Changelog to be notified about major version changes, and refer to the Release notes for minor version updates.

Import a theme

  1. Click Storefront and select Theme Editor in your merchant portal. 
  2. Click Import theme.
  3. Upload your Theme asset file (.zip) and click Next.
    Screen_Shot_2021-10-06_at_5.05.51_PM.png
  4. Enter a name in the Theme name field and click Import theme.
    step-2.png
Tip: The Template version shows after you upload your theme file. If the imported theme was created before the release of Theme Engine versioning (October 6, 2021), the version shows Legacy. Subscribe to the Recharge Changelog to be notified about major version changes, and refer to the Release notes for minor version updates.

Enable your custom theme

When you are ready to go live with your custom portal theme, you can update the settings in your Customer portal settings page.

  1. In the merchant portal, click Storefront.
  2. Select Customer Portal.
  3. Under Customer portal, select PRO Theme Engine
  4. Under Customer portal location, select either Hosted by Recharge or Embedded in platform storefront
  5. Click Save. 

customer_portal_location_in_Recharge.png

Note: The Hosted by Recharge option allows you to assign a custom domain for the customer portal. Custom builds using the Recharge API, must use Hosted by Recharge unless they are building a custom portal leveraging the Theme Engine API.
Was this article helpful?
2 out of 2 found this helpful

Related articles

Didn’t find what you’re looking for?

Contact us