Contents x
    Bold Subscriptions API Key
    • 07 Dec 2020
    • 1 Minute to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Contents

    Bold Subscriptions API Key

    • Updated on 07 Dec 2020
    • 1 Minute to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Article Summary

    This page will cover how to find your API key in the BoldCommerce admin panel for BoldCommerce merchants.

    Make sure your Bold Subscriptions plan is compatible with RetentionEngine
    1. In order to access an API Key with Bold Subscriptions, you need to be on the Advanced plan.
    2.RetentionEngine only supports v1 of Bold Subscriptions.

    Sharing your API key allows the RetentionEngine to access vital customer information to ensure a flawless customer experience. Additionally, the API key allows the RetentionEngine to automatically update customer accounts with discounts, pauses, or cancellations.

    When setting up your Bold Commerce integration, you will need three things from Bold Commerce:

    • Your API handle
    • Your private API key
    • Your full Shopify domain

    To generate an API key in Subscriptions, please follow these steps:

    1. From Subscriptions' admin, select Integrations, then API Keys.
    2. Select Create Private Key.
    3. Enter a Handle. Note: This is a name for the API key that will only be visible to yourself. The handle can be used to help you identify what program, system, or app the key is using.
    4. Select Generate.

    You'll now need to copy and paste your generated API key into the system you want to use Subscriptions with in order for the two to communicate with one another:


    Was this article helpful?
    What's Next