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

Bolt Financial Subscriptions API

Use the Subscriptions endpoint to manage merchant-side recurring subscriptions created through Bolt Charge: list and retrieve subscriptions, cancel or pause/unpause them, view generated orders, and configure dunning (failed payment recovery) settings for a division.

Bolt Financial Subscriptions API is one of 13 APIs that Bolt Financial 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 and API documentation.

This API exposes 8 operations across 7 paths, and defines 25 schemas. It is described by OpenAPI 3.2.0, at version 1.0.1.

Requests are made against 3 base URLs: https://api.boltapp.com, https://api-sandbox.boltapp.com, https://api-staging.boltapp.com.

8 operations 7 paths 25 schemas 4 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.1
Base URL
https://api.boltapp.com
Authentication
OAuth 2.0, API Key
Resource Areas
1

Authentication & Security 2

Bolt Financial Subscriptions API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth) using the authorizationCode flow, exposing 3 scopes. An API key is passed in the header as X-API-Key (X-API-Key). By default, every request must be authenticated.

  • OAuth — Bolt utilizes the OAuth flow that developers can use to attain access to Bolt Account data via APIs. For all APIs that require authorization, please provide yo…
  • X-API-Key — Admins and Developers can obtain their Bolt API key from the Bolt Merchant Dashboard.

Paths & Operations 8

Across 7 paths, the API surfaces 8 operations — 4 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Subscriptions 8

Use the Subscriptions endpoint to manage merchant-side recurring subscriptions created through Bolt Charge: list and retrieve subscriptions, cancel or pause/unpause them, view gen…

GET
/v1/subscriptions
Get Subscriptions
getSubscriptions 9 params → 200400401
GET
/v1/subscriptions/{subscription_id}
Get Subscription
getSubscription 2 params → 200400401404
POST
/v1/subscriptions/{subscription_id}/cancel
Cancel Subscription
cancelSubscription 2 params → 200400401404
POST
/v1/subscriptions/{subscription_id}/pause
Pause Subscription
pauseSubscription 2 params → 200400401404
POST
/v1/subscriptions/{subscription_id}/unpause
Unpause Subscription
unpauseSubscription 2 params → 200400401404
GET
/v1/subscriptions/orders
Get Subscription Orders
getSubscriptionOrders 5 params → 200400401
GET
/v1/subscriptions/dunning_settings
Get Dunning Settings
getDunningSettings 3 params → 200401
PUT
/v1/subscriptions/dunning_settings
Update Dunning Settings
updateDunningSettings 3 params body → 200400401

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are subscription_v2 (15 properties), subscription_v2_order (11 properties), subscription_v2_plan (10 properties), subscription_v2_dunning_settings (4 properties). Each schema is shown below with its type and property counts.

amounts
object
The amount. Nullable for Transactions Details.
3 properties 3 required
subscription_v2_order_list
object
A list of subscription orders.
1 property 1 required
subscription_v2_status
string
The current status of the subscription.
currency_iso
string
The 3-digit ISO code for the currency. Nullable for Transactions Details.
subscription_v2_pagination
object
Pagination details for a list response.
2 properties 2 required
subscription_v2_initial_period
object
An initial billing period, such as a trial or introductory offer, that differs from the plan's regular frequency.
2 properties 2 required
request_failed
boolean
Indicates that the request failed. This value is always false.
message
string
Human-readable description of the error for developers. Should not be shown to users and is not localized.
subscription_v2_success
object
A generic confirmation response.
1 property 1 required
code
integer
Custom-defined Bolt error code. This can be used to programmatically react to specific errors.
subscription_v2_dunning_settings
object
A merchant division's dunning (failed payment recovery) configuration.
4 properties 4 required
subscription_v2_plan
object
The billing plan the subscription is enrolled in.
10 properties 8 required
subscription_v2_status_details
object
Details about the subscription's current status.
2 properties 1 required
subscription_v2_order_status
string
The status of a subscription order.
errors_bolt_api
array
subscription_v2_id
string
The unique ID for a Bolt subscription.
errors_bolt_api_response
object
2 properties
error_bolt_api
object
Error object containing custom error information
2 properties
currency_symbol
string
The currency symbol used for the amount. Nullable for Transactions Details.
subscription_v2_order
object
A single billing cycle (order) generated by a subscription.
11 properties 8 required
subscription_v2
object
A Bolt subscription.
15 properties 10 required
request_result
object
Custom-defined Bolt result object.
1 property
amount
integer
The amount in cents. Nullable for Transactions Details.
subscription_v2_payment_method
object
The card currently used to pay for this subscription.
2 properties 2 required
subscription_v2_list
object
A paginated list of subscriptions.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bolt-financial-subscriptions-api-openapi.yml Raw ↑

Other APIs Bolt Financial publishes across the network.

Bolt MCP Servers
Bolt Financial Account API
Bolt Financial Callbacks API
Bolt Financial Configuration API
Bolt Financial O Auth API
Bolt Financial Orders API
Bolt Financial Payments API
Bolt Financial Statements API
Bolt Financial Testing API
Bolt Financial Tokenizer API
Bolt Financial Transactions API
Bolt Financial Webhooks API
Where this information came from

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