📍 Bolt Help / Products / Bolt Charge / Bolt Charge Implementation Details
Bolt Charge Implementation Details

Steps to Implement Bolt Charge

1. Get Keys

  1. Log in to the Bolt Merchant Dashboard
  2. Navigate to Administration > API.
  3. Copy the following:
    • Api Key
    • Publishable Key
  • The publishable key is a long string of lower and upper case letters and numbers that consists of three sections.
get keys

Go to the Integrations tab on Merchant Dash to find more information on how to use Bolt Charge APIs

We leverage Bolt Charge APIs to generate checkout links that allow shoppers to purchase or subscribe to digital products seamlessly.

2. Creating a New Product

Request
CURL
curl --request POST 'https://api.bolt.com/v1/subscriptions/products' \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: YOUR_API_KEY' \
--header 'X-Publishable-Key: YOUR_PUBLISHABLE_KEY' \
--data '{
    "name": "Bolt+ Membership",
    "description": "Get All the money",
    "brand": "Bolt",
    "sku": "BOLTPLUS",
    "images": [
        "https://user-images.githubusercontent.com/40345645/229246491-bb572a18-7e09-4457-ac20-b51e0fb05923.png"
    ],
    "plans": [
        {
            "sku": "BOLTPLUSMIN",
            "name": "Bolt+ membership - monthly",
            "frequency": 3,
            "frequency_unit": "month",
            "unit_price": 999,
            "images": [
                "https://user-images.githubusercontent.com/40345645/229246491-bb572a18-7e09-4457-ac20-b51e0fb05923.png"
            ]
        },
        {
            "sku": "BOLTPLUSWEEK",
            "name": "Bolt+ membership - 1 year",
            "frequency": 1,
            "frequency_unit": "year",
            "unit_price": 6999,
            "images": [
                "https://user-images.githubusercontent.com/40345645/229246491-bb572a18-7e09-4457-ac20-b51e0fb05923.png"
            ]
        }
    ]
}'

Request Parameters:

  • POST: Specifies that the request method is POST.
  • application/json’: Specifies that the request body will be sent as JSON.
  • YOUR_API_KEY’: Replace YOUR_API_KEY with the API key provided by Bolt.
  • YOUR_PUBLISHABLE_KEY’: Replace YOUR_PUBLISHABLE_KEY with the publishable key provided by Bolt.
  • data-raw ‘{ … }’: Specifies the JSON payload containing product details such as name, description, brand, SKU, images, and associated subscription plans with pricing and frequency.

Response

Click to expand.

NOTE: The checkout links returned in the response can be embedded anywhere a shopper needs to complete their purchase, serving as a universal checkout point for each product.

More Info: Subscriptions API

3. The checkout link directs you to Bolt Checkout to complete your order.

4. Once the checkout is completed, you should see

  • Transaction on Merchant Dashboard
  • Get a subscription Endpoint Retrieves the Subscription by its ID and its Status.
  • Shopper Receive a confirmation email with the purchase and subscription details

Other Useful Endpoints

Get all Products - Retrieves a list of all products.

Request

curl --location 'https://api.bolt.com/v1/subscriptions/products' \
--header 'X-Api-Key: YOUR_API_KEY' \
--header 'X-Publishable-Key: YOUR_PUBLISHABLE_KEY'

Response

Click to expand.

Get a Product - Retrieves a product by its ID.

Request

curl --location 'https://api.bolt.com/v1/subscriptions/products/{ID}' \
--header 'X-Api-Key: YOUR_API_KEY' \
--header 'X-Publishable-Key: YOUR_PUBLISHABLE_KEY'

Response

Click to expand.

Get a Subscription - Retrieves a subscription by its ID.

Request

curl --location 'https://api.bolt.com/v1/subscriptions/{ID}' \
--header 'X-Api-Key: YOUR_API_KEY' \
--header 'X-Publishable-Key: YOUR_PUBLISHABLE_KEY'

Response

Click to expand.

Get All Subscription - Retrieves a list of all subscriptions.

Request

curl --location 'https://api.bolt.com/v1/subscriptions' \
--header 'X-Api-Key: YOUR_API_KEY' \
--header 'X-Publishable-Key: YOUR_PUBLISHABLE_KEY'

Response

Click to expand.

Cancel a Subscription - Cancels a subscription by its ID

Request

curl --location 'https://api.bolt.com/v1/subscriptions/{ID}/cancel' \
--header 'X-Api-Key: YOUR_API_KEY' \
--header 'X-Publishable-Key: YOUR_PUBLISHABLE_KEY'

Response

Click to expand.

NOTE

More Info: Subscriptions API