Get a list of subscriptions in all agreements.
Get a list of subscriptions in all agreements.
The subscriptions object represents a collection of Product Items inside the Agreement. All items are connected to one Product, one vendor, and one client (the same as the agreement) and have common billing frequency and commitment terms.
This object contains the following properties:
| Field | Type | Description |
|---|---|---|
id
string
Human Friendly identifier of Subscription object.
Example: "SUB-2119-4550-8674-5962"
href
string
Relative reference to object on API (always /commerce/agreements/{id})
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 touched this subscription. Possible statuses are a subset of all subscription statuses.
Example: "Active"
name
string
Subscription name.
Example: Subscription for Microsoft Office 365 NCE E1
agreement
Agreement
Agreement that holds this particular Subscription instance.
Example:
product
Product
Product reference
Example:
startDate
string
Effective date of subscription start may be not defined in sciope of order).
Example: "2023-12-14T17:28:57Z"
commitmentDate
string
Date when subscription commitment ends and subscription to be renewed.
Example: "2023-12-14T17:28:57Z"
terminationDate
string
Date when subscription to be terminated.
Example: "2023-12-14T17:28:57Z"
terms
Terms
Subscription billing terms.
Example:
price
Price
Price for subscription, not all fields visible for everyone see details in Price, most of the object should be READONLY as it is calculated on orders completion, with only exception OPS can edit default markup for an active subscriptions.
Example:
lines
Lines[]
List of all product items (lines) purchasedi n scope of this subscription.
Example:
parameters
object
An object that groups together 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.
Possible audit events: Created, Updated, Activated, Terminated, and Failed.
Example:
externalIDs
ExternalIDsObject
Set of external IDs.
Example:
Success
Success