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

Bold Commerce Subscriptions API

Recurring orders, intervals, and subscription management.

Bold Commerce Subscriptions API is one of 6 APIs that Bold Commerce 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 12 operations across 9 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

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

12 operations 9 paths 3 schemas 4 GET1 PATCH5 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.boldcommerce.com/subscriptions/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Bold Commerce Subscriptions API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — OAuth 2.0 access token (public integrations) or scoped API access token (private integrations), passed as Authorization: Bearer {token}.

Paths & Operations 12

Across 9 paths, the API surfaces 12 operations — 4 GET, 1 PATCH, 5 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Subscriptions 12

Recurring orders, intervals, and subscription management.

GET
/subscriptions/v1/shops/{shop_identifier}/subscriptions
List subscriptions
listSubscriptions 1 param → 200401
POST
/subscriptions/v1/shops/{shop_identifier}/subscriptions
Create a subscription
createSubscription 1 param body → 201401
GET
/subscriptions/v1/shops/{shop_identifier}/subscriptions/{subscription_id}
Retrieve a subscription
getSubscription 2 params → 200401
PUT
/subscriptions/v1/shops/{shop_identifier}/subscriptions/{subscription_id}
Update a subscription
replaceSubscription 2 params body → 200
PATCH
/subscriptions/v1/shops/{shop_identifier}/subscriptions/{subscription_id}
Partially update a subscription
patchSubscription 2 params body → 200
POST
/subscriptions/v1/shops/{shop_identifier}/subscriptions/{subscription_id}/pause
Pause a subscription
pauseSubscription 2 params → 200
POST
/subscriptions/v1/shops/{shop_identifier}/subscriptions/{subscription_id}/cancel
Cancel a subscription
cancelSubscription 2 params → 200
POST
/subscriptions/v1/shops/{shop_identifier}/subscriptions/{subscription_id}/activate
Reactivate a subscription
activateSubscription 2 params → 200
POST
/subscriptions/v1/shops/{shop_identifier}/subscriptions/{subscription_id}/line_items
Add line items to a subscription
addSubscriptionLineItems 2 params body → 200
GET
/subscriptions/v1/shops/{shop_identifier}/subscriptions/{subscription_id}/intervals
List subscription intervals
listSubscriptionIntervals 2 params → 200
GET
/subscriptions/v1/shops/{shop_identifier}/subscriptions/{subscription_id}/orders
List subscription orders
listSubscriptionOrders 2 params → 200
PUT
/subscriptions/v1/shops/{shop_identifier}/subscriptions/{subscription_id}/orders/{order_id}/skip
Skip an upcoming order
skipSubscriptionOrder 3 params → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Subscription (6 properties), LineItem (4 properties), Error (1 property). Each schema is shown below with its type and property counts.

Subscription
object
6 properties
LineItem
object
4 properties
Error
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bold-commerce-subscriptions-api-openapi.yml Raw ↑

Other APIs Bold Commerce publishes across the network.

Bold Commerce Checkout API
Bold Commerce Customers API
Bold Commerce Price Rules API
Bold Commerce Products API
Bold Commerce Shops API
Where this information came from

This is an independent, third-party profile of Bold Commerce 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.