Subscription

Group: Accounting › Subscriptions

Open in the interactive reference

Recurring service a customer has bought from a legal entity: renewal terms, service dates, and cancellation/suspension state.

A subscription is a customer's recurring service, tracked by its lines, term type, and lifecycle status.

Finding subscriptions

subscriptions is the collection header; searchSubscription returns the full record, including the customer/entity references and cancellation/suspension notes List omits.

Changing one

modifySubscription applies line-level changes (add, change quantity, cancel, or replace products) effective on a modification date, or — via modificationType: renew, or earlyRenew from a given date — renews the whole subscription for another term. Every modification type except a cancellation-only payload materializes a sales order.

Ending one

cancelSubscription fully cancels a subscription: every line ends on the cancellation date. For a partial cancellation, or one combined with other changes, use modifySubscription's cancelLines/replaceGroups instead.

Modifying, renewing, cancelling, listing or searching a subscription, or anything carrying a subscription id.