Subscriptions API (subscriptions)

The subscriptions module serves subscription plans and customer subscriptions with activate, pause, resume, renew, cancel, and a sweep. All 20 endpoints sit under /api/v1/subscriptions. For business meaning see the Subscriptions module page.

Group facts¶

Endpoint summary¶

One row per sub-module folder. The router prefix is added to the base path.

Subscription plans endpoints¶

Plan records, activate, and retire.

Customer subscriptions endpoints¶

The router has no prefix, so subscription paths sit directly under the module base path (src/cluster_erp/modules/subscriptions/customer_subscriptions/routes.py:30-34). Four action routes are added with add_api_route and a shared handler factory (src/cluster_erp/modules/subscriptions/customer_subscriptions/routes.py:110-148).

Error codes¶

The table lists the error codes that code under src/cluster_erp/modules/subscriptions/ raises, found by a syntax-tree scan for AppError(...), the factories in src/cluster_erp/core/errors.py (not_found, conflict, protected, permission_denied, privilege_escalation, check_version), and HTTPException(...). A status of 400 is the AppError default (src/cluster_erp/core/errors.py:23). Guard errors (401, 403), the entitlement codes, and validation errors (422) apply to every route and are listed on Errors.

Events emitted¶

The table lists the contract classes that code under src/cluster_erp/modules/subscriptions/ passes directly to EventBus.emit, found by a syntax-tree scan. Events built in a variable first are not counted. The contracts are described in Contracts reference.

Related pages¶

• API reference
• Subscriptions module
• API conventions
• Errors
• Authentication and headers

Verified against commit 92f8051 on 2026-11-13.