Subscriptions
The Subscriptions object represents a collection of product items within the agreement.
All items are connected to one product, one vendor, and one client (same as the agreement) and have a common billing frequency and commitment terms. The Subscriptions object contains the following properties:
id
string
Identifier for the subscription object.
Example: SUB-2119-4550-8674-5962
href
string
Relative reference to the object in the API.
Example: /v1/commerce/subscriptions/SUB-2119-4550-8674-5962)
status
string
The key status of the object. Possible values are a by-product of the latest completed order that included this subscription. Possible statuses are a subset of all subscription statuses.
Example: Active
name
string
Name of the subscription.
Example: Subscription for Microsoft Office 365 NCE E1
agreement
Agreement
The agreement that contains this particular subscription.
Example:
product
Product
Reference to the Product object.
Example:
startDate
string
Start date of the subscription.
Example: 2023-12-14T17:28:57Z
commitmentDate
string
Date when the subscription commitment ends and the subscription needs to be renewed.
Example: 2023-12-14T17:28:57Z
terminationDate
string
Date when the subscription is to be terminated.
Example: 2023-12-14T17:28:57Z
terms
Terms
Subscription billing terms.
Example:
price
Price
Price of the subscription.
Example:
lines
Lines
List of all product items (lines) purchased in the scope of this subscription.
Example:
parameters
object
An object that groups separate lists of parameters. Only fulfillment parameters are available in this object.
Example:
parameters.fulfillment
Order Parameter Object
An object that holds a concise definition of a parameter, its value, and any associated errors.
Example:
audit
AuditObject
Audit object with possible entries: created, updated, activated, terminated, according to the object's lifecycle.
Example:
externalIDs
ExternalIDsObject
Set of external IDs.
Example:
Example
Last updated
Was this helpful?