How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Smartrr Subscriptions API

Customer subscriptions, modeled by Smartrr as "purchase states". Create, read, and manage the lifecycle (skip, pause, cancel, reschedule, swap line items) of a subscription.

Smartrr Subscriptions API is one of 6 APIs that Smartrr publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Subscription. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 17 operations across 16 paths. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.smartrr.com.

17 operations 16 paths 0 schemas 6 GET2 POST9 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.smartrr.com
Authentication
API Key
Contact
Resource Areas
1

Authentication & Security 1

Smartrr Subscriptions API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-smartrr-access-token (smartrrAccessToken). By default, every request must be authenticated.

  • smartrrAccessToken — Per-organization API access token generated in the Smartrr admin under the Integrations tab (Add Key). Sent on every request in the x-smartrr-access-token head…

Paths & Operations 17

Across 16 paths, the API surfaces 17 operations — 6 GET, 2 POST, 9 PUT. Each is listed below with its method, path, parameters, and response codes.

Subscriptions 17

Customer subscriptions, modeled by Smartrr as "purchase states". Create, read, and manage the lifecycle (skip, pause, cancel, reschedule, swap line items) of a subscription.

GET
/vendor/purchase-state
Get Purchase States
getPurchaseStates 2 params → 200
POST
/vendor/purchase-state
Create Purchase State
createPurchaseState body → 201
GET
/vendor/purchase-state/{shopifySubscriptionId}
Get Purchase State By Shopify Subscription ID
getPurchaseStateByShopifyId 1 param → 200
GET
/vendor/purchase-state/{shopifySubscriptionId}/orders
Get Orders By Shopify Subscription ID
getPurchaseStateOrders 1 param → 200
GET
/vendor/purchase-state/{shopifySubscriptionId}/bills
Get Bills By Shopify Subscription ID
getPurchaseStateBills 1 param → 200
GET
/vendor/purchase-state/{shopifySubscriptionId}/events
Get Events by Shopify Subscription ID
getPurchaseStateEvents 1 param → 200
GET
/vendor/customer/{customerRelationshipId}/purchase-state/
Get Purchase States By Customer ID
getPurchaseStatesByCustomer 1 param → 200
PUT
/vendor/customer/{customerRelationshipId}/purchase-state/{customerPurchaseStateId}/skip
Skip Purchase
skipPurchase 2 params → 200
PUT
/vendor/customer/{customerRelationshipId}/purchase-state/{customerPurchaseStateId}/unskip
Unskip Purchase
unskipPurchase 2 params → 200
PUT
/vendor/customer/{customerRelationshipId}/purchase-state/{customerPurchaseStateId}/pause
Pause Purchase
pausePurchase 2 params body → 200
PUT
/vendor/customer/{customerRelationshipId}/purchase-state/{customerPurchaseStateId}/activate
Activate Purchase
activatePurchase 2 params → 200
PUT
/vendor/customer/{customerRelationshipId}/purchase-state/{customerPurchaseStateId}/cancel
Cancel Purchase
cancelPurchase 2 params → 200
PUT
/vendor/customer/{customerRelationshipId}/purchase-state/{customerPurchaseStateId}/next-billing-date
Set Next Billing Date on Purchase
setNextBillingDate 2 params → 200
PUT
/vendor/customer/{customerRelationshipId}/purchase-state/{customerPurchaseStateId}/selling-plan
Set Selling Plan on Purchase
setSellingPlanOnPurchase 2 params → 200
POST
/vendor/customer/{customerRelationshipId}/purchase-state/{customerPurchaseStateId}/line-item
Add Line Item to Purchase
addLineItem 2 params → 200
PUT
/vendor/customer/purchase-state/bulk-cancel
Bulk Cancel Purchases
bulkCancelPurchases → 200
PUT
/vendor/customer/purchase-state/bulk-pause
Bulk Pause Purchases
bulkPausePurchases → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

smartrr-subscriptions-api-openapi.yml Raw ↑

Other APIs Smartrr publishes across the network.

Smartrr Bills API
Smartrr Orders API
Smartrr Plans API
Smartrr Subscribers API
Smartrr Webhooks API
Where this information came from

This is an independent, third-party profile of Smartrr Subscriptions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.