Introduction
The sticky.io Subscriptions application offers a collection of headless APIs to enable merchants to more deeply customize the ecommerce experience for their consumers.
You, as a merchant, will be able to build consumer portals on a headless basis and take certain actions against active subscriptions on behalf of your consumers.
Without further ado, let's begin!
Index
Looking for something specific? We recommend you read through this article in its entirety, but you can jump ahead in the article by clicking the links below.
Accessing Our API Documentation
To access the relevant API documentation, please reference this link.
Please note these APIs are intended to be leveraged by merchants with in-house developer teams or the support of a qualified agency. If needed, your sticky.io representative will be able to refer you to a qualified agency partner. Contact them directly for more information.
What actions are available via API?
Within the context of the sticky.io Subscriptions app for BigCommerce, the following actions are available via API:
Headless Checkout API
Check cart has a subscription
Headless Consumer Portal API
Get consumer portal configurations
Subscriptions
Get subscriptions list
Get subscription amount
Get a subscription product image
Get shipping and billing details of a subscription
Get subscription history
Get available billing frequencies
Get subscription product options
Subscription Actions
Pause subscription
Resume subscription
Stop subscription
Skip subscription
Bill now
Change shipping address
Get customer shipping addresses
Update shipping address
Add a customer address
Change payment method
Get payment methods
Update payment method on subscription
Manage billing
Update billing model
Update next billing date
Update product quantity
Change product
Get change product page details
Get product price
Change subscription product
Please reference the linked documentation for the most-up-to-date listing of the sticky.io Subscription applications API-based capabilities.
Managing User Permissions to Generate or View API Tokens
The newly introduced "Permissions" tab within the sticky.io Subscriptions app allows storefront admins to determine which users have the capacity to scope, generate or view API tokens.
To set permissions for users across your storefront, navigate to the Permissions tab.
From here, you'll be able to view all of the storefront users by login and set their permissions using the simple toggles. To enable a user to scope, generate or view API tokens, simply throw the toggle to the "on" state (Blue-shaded toggle background). To revoke their permissions, simply throw the toggle to the "off" state (Grey-shaded toggle background).
Generating an API Token
Users with adequate permissions can generate an API token directly within the sticky.io Subscriptions app. To do so, navigate to the API Tokens tab of the sticky.io Subscriptions app for BigCommerce.
Once you have navigated to the tab, click Create API token.
Next, add a name for your token and scope the token and define which modules are pertinent to the requests you will be making.
Please consult the API documentation to determine which modules will be relevant to the API calls you'll be making. Once you've identified the modules that will be pertinent for you, simply check the corresponding boxes within the API token generation view.
Lastly, set an expiration date for your token. There are no limitations on how far in the future this expiration date can be set. After this defined date, the token will no longer be valid and functional.
Congratulations! You're now an expert on leveraging the sticky.io Subscriptions application's headless APIs.