/
SM
smartrr
/
Smartrr API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 3h ago · Updated 2w ago
View markdown
smartrr
Smartrr API
get
Get Addons Config
latest
OpenAPI 3.0.0
2026-08-10
134
271
194.2 KB
da24e062ff11
Analytics Simple
1
Auth
5
Bill
6
Cancellation Reason
5
Customer
10
Customer Email Config
2
Extensions API
2
Integrations
13
Order
5
Organization
8
Phone
2
Purchasable Collection
1
Purchasables
4
Purchase State
31
get
Get Purchase States
post
Create Purchase State
put
Update shipping price on Purchase State
put
Update external subscription dates on purchase state
put
Update Address on Purchase State
put
Pause Purchase
put
Bulk Pause Purchases
put
Cancel Purchase
put
Bulk Cancel Purchases
put
Activate Purchase
put
Bulk Activate Purchases
put
Skip Purchase
put
Bulk Skip Purchases
put
Unskip Purchase
put
Bulk Unskip Purchases
put
Set Next Billing Date on Purchase
put
Bulk Set Next Billing Date on Purchases
put
Set Selling Plan on Purchase
get
Preview next order date for a selling plan (read-only)
post
Apply Discount on Purchase
delete
Delete Discount on Purchase
get
Get Purchase States By Customer ID
get
Get Purchase State By Shopify Subscription ID
get
Get Orders By Shopify Subscription ID
get
Get Events by Shopify Subscription ID. Returns up to 250 most recent events
get
Get Bills By Shopify Subscription ID
get
Get Oldest Contract Processed Date
get
Get List of Countries
get
Get Selling Plan Groups
get
Get Addons Config
get
Get all programs for a shop
Purchase State Line Item
8
Rewards
2
Setup
2
Shopify Stream
3
Smartrr API Token
4
Smartrr Script
3
Smartrr Script delete
1
SMS Addon
2
Theme
6
Webhooks
8
Purchase State
Get Addons Config
get
/vendor/add-ons-config
Query parameters
cache
'true'
|
'false'
Response
Successful response
ISmartrrAddOnsConfig[]
required
shopifyNumericId
number
required
shopifyId
string
required
name
string
required
appId
string
nullable
required
description
string
nullable
required
merchantCode
string
required
options
string[]
required
productIds
number[]
required
variantIds
number[]
required
subscriptionCount
number
required
summary
string
nullable
required
position
number
nullable
required
sellingPlanCount
number
required
enabledProductIdToVariantIdMap
IEnabledShopifyProductIdToShopifyVariantIdMap
required
[productShopifyId: number]: number[];
sellingPlans
ISmartrrAddOnsConfigSellingPlan[]
required