Important product naming update: Sidekick is now called Gladly (AI) and Gladly Hero (the Platform) is now Gladly Team. Please keep this in mind as you read through our documentation.

Recharge App Platform Installation

Prev Next

Before you start

Review the following information before you install the Recharge app.

  • Review the App Platform overview and key concepts to familiarize yourself with this tool before installation.

  • You need Administrator permission in Gladly to complete the installation process.

  • You need a Recharge account with API access.

  • You need a Recharge API token (labeled "API Key" in the Recharge admin) from Tools & Apps > API tokens, with the required scopes below. Have this token ready to paste during setup.

  • Decide the maximum amounts team members may set for the guarded actions (credit adjustment, subscription price, and refund) before rollout.

  • Decide whether store credit applies. Store credit is a Recharge Plus/Custom feature; leave it off unless your plan includes it and the token has the credit scopes.

Require API token scopes

When you create the Recharge API token, grant it these scopes:

  • Subscriptions — read and write

  • Orders — read and write (this also covers charges, discounts, free gifts, and refunds; Refund a charge needs only Orders write — no Payments scope is required)

  • Customers — read and write (covers customer and address data, and updating the shipping address)

  • Store credit (optional, Plus/Custom plans only) — read credit accounts, read credit adjustments, and write credit adjustments (credit and debit). Grant these only if you enable store credit.

    Refunds run on the Orders scope, so no Payments permission is required. When setting the token's permissions in Recharge, the selections look like this:

Install the Recharge app

The Recharge app is set up entirely from Gladly's Settings — no command-line tools are required. Once set up, your team can view Recharge subscription data and run approved subscription actions directly within Gladly.

Step 1: Open the Apps settings

In Gladly, go to Settings > Apps. This is where you manage your App Platform integrations.

Step 2: Create a configuration

Click the Create Configuration button. When prompted for the External App, choose the Recharge app (gladly.com/Recharge_App). Always choose the latest available version.

Step 3: Fill in the configuration fields

Complete the fields in the configuration form:

  • Configuration Name — a recognizable name you'll see across Gladly, for example "Recharge <store name>".

  • Store credit — leave this unchecked unless your Recharge plan includes store credit (a Plus/Custom feature) and your API token has the credit scopes. Check it to show the store-credit balance and enable the Adjust store credit action. If in doubt, leave it off.

  • Maximum credit adjustment — the largest single store-credit adjustment a team member may make (for example, 100.00). Only needed if you use Adjust store credit.

  • Maximum delay (billing cycles) — the most billing cycles a team member may delay the next charge from the Delay next order form. Defaults to 3 if left blank.

  • Maximum subscription price — the highest line-item price a team member may set from Adjust subscription price (for example, 200.00).

  • Maximum refund amount — the largest single refund a team member may issue (for example, 100.00).

  • API Access Token — paste your Recharge API token (the "API Key" from the Recharge admin under Tools & Apps > API tokens).

The configuration form looks like this:

Step 4: Save and activate

Turn on the Configuration is active toggle, then save. Your Recharge configuration is now live.

Verify subscription data

Open a Customer Profile in Gladly for a known Recharge subscriber email address. If a known subscriber shows no Recharge subscription data, confirm the Customer Profile email, the Recharge API token, and the token's scopes.

Enable the Recharge Card in Gladly

When ready, contact the Gladly Support team to enable the Recharge Card in Customer Details.

Register Recharge Action Forms in the + Menu

Contact the Gladly Support team to enable Recharge action forms so team members can run them from the Gladly + menu. The following options are available:

  • Delay next order: rescheduleNextCharge

  • Change subscription frequency: changeSubscriptionFrequency

  • Update shipping address: updateAddress

  • Add free gift: addFreeGift

  • Apply or remove discount: manageChargeDiscount

  • Swap subscription item: swapSubscriptionItem

  • Adjust subscription price: adjustSubscriptionPrice

  • Adjust store credit (store-credit plans only): adjustCredit

  • Cancel or reactivate subscription: manageSubscriptionState

  • Skip or unskip next order: manageNextChargeSkip

  • Refund a charge: refundCharge

Register the consolidated forms above rather than the individual halves. Cancel or reactivate replaces separate cancel and reactivate forms; Skip or unskip replaces separate skip and unskip forms; Apply or remove discount replaces separate apply and remove discount forms.

Verify Your Installation

After activation and action registration, open a known subscriber profile, confirm the Recharge Card displays subscription data, confirm approved actions appear in the + menu, run a low-risk test action, and verify the action result appears in the Conversation timeline. Use a disposable test subscription for write actions, and do not test guarded money-moving actions (refund, credit, price) against a real Customer.