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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Smokeball

Smokeball Subscriptions API

The Subscriptions API from Smokeball — 26 operation(s) for subscriptions.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 1 JSON Schema definition.

Tagged areas include Subscription. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, rate-limit docs, a GitHub repository, and 1 JSON Schema.

This API exposes 31 operations across 26 paths, and defines 46 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 6 base URLs: https://api.smokeball.com, https://api.smokeball.com.au, https://api.smokeball.co.uk, https://stagingapi.smokeball.com, https://stagingapi.smokeball.com.au, https://stagingapi.smokeball.co.uk.

31 operations 26 paths 46 schemas 2 DELETE19 GET5 PATCH5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.smokeball.com
Authentication
API Key, API Key
Contact
Smokeball Developer Support
Resource Areas
1

Authentication & Security 2

Smokeball Subscriptions API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-api-key (api-key). An API key is passed in the header as Authorization (token). By default, every request must be authenticated.

Paths & Operations 31

Across 26 paths, the API surfaces 31 operations — 2 DELETE, 19 GET, 5 PATCH, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Subscriptions 31
GET
/subscriptions/addons
Get all add-ons
→ 200500
GET
/subscriptions/addons/{id}
Get an add-on
GetAddOnAsync 1 param → 200404500
POST
/{id}
Add add-on
2 params → 202400404500
DELETE
/{id}
Remove add-on
2 params → 202400404500
GET
/subscriptions/{subscriptionId}/charges
GetSubscriptionUsageCharges 9 params → 200404
GET
/subscriptions/{subscriptionId}/usages/{usageId}/charges
GetUsageCharges 10 params → 200404
POST
/subscriptions/{subscriptionId}/usages/{usageId}/charges
CreateUsageChargeAsync 2 params body → 202400404
GET
/subscriptions/{subscriptionId}/charges/{id}
GetUsageCharge 2 params → 200404
POST
/subscriptions/{subscriptionId}/charges/{id}/cancel
CancelUsageChargeAsync 2 params body → 202400404
GET
/subscriptions/invoices
Get subscription invoices
GetSubscriptionInvoicesAsync 5 params → 200404500
GET
/subscriptions/{subscriptionId}/invoices
Get subscription invoices
GetSubscriptionInvoicesBackgroundsCompatibleAsync 2 params → 200404500
GET
/subscriptions/invoices/{invoiceId}/download
Download invoice PDF
DownloadInvoiceAsync 1 param → 200404500
GET
/subscriptions/invoices/{invoiceId}/url
Get invoice download URL
GetInvoiceDownloadUrlAsync 1 param → 200404500
GET
/subscriptions
Get subscriptions
GetSubscriptions → 200500
GET
/subscriptions/{id}
Get subscription
GetSubscription 1 param → 200404500
PATCH
/subscriptions/{id}
Update subscription
UpdateSubscriptionAsync 1 param body → 202400404500
GET
/subscriptions/settings
Get subscription settings
GetSubscriptionSettings → 200404
PATCH
/subscriptions/settings
Patch subscription settings
PatchSubscriptionSettingsAsync body → 202400404
GET
/subscriptions/{id}/promotions
Get subscription promotions
GetSubscriptionPromotions 3 params → 200404500
GET
/subscriptions/{id}/changes
Get subscription changes
GetSubscriptionChangesAsync 3 params → 200500
POST
/subscriptions/{id}/preview
Preview upcoming subscription charges
PreviewSubscriptionUpdateAsync 1 param body → 200400404500
PATCH
/subscriptions/{id}/cancel
Cancel subscription
CancelSubscriptionAsync 1 param body → 200400404500
PATCH
/subscriptions/{id}/resume
Resume subscription
ResumeSubscriptionAsync 1 param body → 202400404500
GET
/subscriptions/tiers
Get all tiers
→ 200500
GET
/subscriptions/tiers/{id}
Get a tier
GetTierAsync 1 param → 200500
GET
/subscriptions/tiers/{id}/addons
Get tier add-ons
1 param → 200404500
PATCH
/subscriptions/{subscriptionId}/tiers/{id}
Switch product tier
2 params body → 200202404500
GET
/subscriptions/usages
→ 200
GET
/subscriptions/usages/{id}
GetUsageAsync 1 param → 200404
POST
/subscriptions/{subscriptionId}/usages/{id}
2 params body → 202400404
DELETE
/subscriptions/{subscriptionId}/usages/{id}
2 params → 202404

Schemas 46

The contract defines 46 schemas that model the data the API accepts and returns. The most detailed are Charge (25 properties), Subscription (25 properties), SubscriptionPromotion (23 properties), Product (17 properties). Each schema is shown below with its type and property counts.

ProductPrice
object
10 properties
SubscribeUsageRequest
object
1 property
SubscriptionCollection
object
6 properties
InvoiceDownloadUrl
object
1 property
UsageCollection
object
6 properties
AddOn
object
13 properties
UpdateSubscriptionRequest
object
4 properties
Price
object
8 properties
CancelSubscriptionRequest
object
5 properties
SubscriptionPromotion
object
23 properties
SetSubscriptionTierRequest
object
3 properties
ProductPriceMeter
object
2 properties
CancellationResponse
object
7 properties
SubscriptionType
integer
SubscriptionAudit
object
6 properties
SubscriptionInvoiceLineItem
object
7 properties
ResumeSubscriptionRequest
object
CancelUsageChargeRequest
object
1 property
Subscription
object
25 properties
Tier
object
13 properties
InvoicePreviewLineItem
object
6 properties
ChargePagedCollection
object
13 properties
ProblemDetails
object
5 properties
AddOnCollection
object
6 properties
SubscriptionInvoiceCollection
object
6 properties
SubscriptionInvoicePagedCollection
object
13 properties
SubscriptionPromotionPagedCollection
object
13 properties
Metadata
object
2 properties
SubscriptionInvoice
object
10 properties
TaxRate
object
8 properties
CreateUsageChargeRequest
object
4 properties 1 required
SubscriptionAuditPagedCollection
object
13 properties
SubscriptionDiscount
object
3 properties
TrialingTier
object
16 properties
TaxRateBehavior
integer
The behavior set on Tax Rate.
Link
object
4 properties
Charge
object
25 properties
SubscriptionSettingsDto
object
Subscription settings patch payload.
3 properties
SubscriptionPreview
object
4 properties
Usage
object
14 properties
PreviewSubscriptionRequest
object
4 properties
SmokeballProductType
integer
Product
object
17 properties
PromotionCode
object
11 properties
SubscriptionSettings
object
Settings for an account's subscription behavior.
10 properties
InvoicePreview
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

smokeball-subscriptions-api-openapi.yml Raw ↑

Other APIs Smokeball publishes across the network.

Smokeball Activity Codes API
AE Profile APIs.io
Smokeball Authorization API
AE Profile APIs.io
Smokeball Bank Accounts API
AE Profile APIs.io
Smokeball Contacts API
AE Profile APIs.io
Smokeball Events API
AE Profile APIs.io
Smokeball Expenses API
AE Profile APIs.io
Smokeball Fees API
AE Profile APIs.io
Smokeball Files API
AE Profile APIs.io
Smokeball Firm API
AE Profile APIs.io
Smokeball Folders API
AE Profile APIs.io
Smokeball Intake API
AE Profile APIs.io
Smokeball Integrated Search API
AE Profile APIs.io
#Subscription
← Back to S APIs
API Details
ID
smokeball:smokeball-subscriptions-api
Base URL
https://api.smokeball.com
Docs
https://docs.smokeball.com/docs/api-docs/1e13a13124aee-introduction
Provider
Smokeball
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=smokeball-subscriptions-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/smokeball-subscriptions-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

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