Subscriptions

📄️List Subscription Editions (Paginated)

Returns a paginated list of all subscription editions across all offerings.

📄️Create Subscription Edition

Creates a new subscription edition.

📄️Get Subscription Edition

Returns a single subscription edition with offering and product details.

📄️Update Subscription Edition

Updates an existing subscription edition. All fields are optional for partial updates.

📄️Delete Subscription Edition

Deletes a subscription edition.

📄️Activate Subscription Edition

Activates a draft subscription edition by setting its status to 'active'.

📄️Archive Subscription Edition

Archives a subscription edition by setting its status to 'archived'.

📄️Copy Subscription Edition

Creates a new draft edition by copying an existing one with a new name and effective date.

📄️List Subscription Offerings

Get a paginated list of subscription offerings with filtering and sorting.

📄️Create Subscription Offering

Create a new subscription offering.

📄️Get Active Offerings List (Picker)

Get a lightweight list of active subscription offerings with edition counts — for use in pickers and dropdowns.

📄️Get Subscription Offering

Get a subscription offering with full detail including editions and product listings count.

📄️Update Subscription Offering

Update an existing subscription offering. All fields are optional.

📄️Delete Subscription Offering

Delete a subscription offering.

📄️Activate Offering

Set the status of a subscription offering to active.

📄️Pause Offering

Set the status of a subscription offering to paused.

📄️List Editions for Offering

Get paginated editions for a subscription offering.

📄️Create Edition for Offering

Create a new edition for a subscription offering.

📄️Get Edition for Offering

Get a single subscription edition nested under an offering.

📄️Update Edition for Offering

Update an edition nested under an offering. All fields are optional.

📄️Delete Edition for Offering

Delete an edition from a subscription offering.

📄️Editions Orders Summary

Get orders summary grouped by edition for a subscription offering.

📄️List Product Listings

Get product listings linked to a subscription offering.

📄️Link Product Listing

Link a product listing to the subscription offering.

📄️Unlink Product Listing

Unlink a product listing from the subscription offering.

📄️Performance Report

Get offering performance report data including summary metrics, edition performance, and upcoming cutoffs.

📄️Demand Forecast

Get demand forecast for the offering based on historical order velocity.

📄️Low Stock Alerts

Get low stock alerts for active edition products.

📄️Component Requirements

Get component requirements for bundle edition products.

📄️Draft Editions Pending

Get draft editions pending activation, ordered by effective date.

📄️Override Audit Log

Get edition override audit log — shows all order lines where the automatically-resolved edition was manually overridden.

📄️Offering Trends

Get trends data for the subscription offering.

📄️Timeline

Get all editions ordered by effective_date for timeline visualization.

📄️Resolve Edition for Order Date

Preview edition resolution for a given order date.

📄️Resolve Edition for Sales Order

Resolve the edition for a sales order given an order date and optional quantity. Used by the sales order offering picker to preview resolution.