Subscription

The Subscription 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.

This object contains the following attributes:

Field	Type	Description
id	string	(Read-only) The identifier for the subscription.
status	string	The key status of the object. Allowed values are: Active Updating Terminating Terminated
name	string	The name of the subscription.
agreement	object	(Read-only) Represents the agreement that contains the subscription.
product	object	(Read-only) Represents the product object.
startDate	string	(Optional) The start date of the subscription.
commitmentDate	string	(Optional) The date when the subscription commitment ends and must be renewed.
terminationDate	string	(Optional) The date by which the subscription must be terminated.
terms	object	(Read-only) Represents the term object containing the billing terms of the subscription.
price	object	The price of the subscription.
lines	object	A list of all product items (lines) purchased in the scope of this subscription.
parameters	object	(Optional) Represents the parameters object, which groups separate lists of parameters. Only fulfillment parameters are available in this object.
parameters.fulfillment	object	(Optional) Represents the parameters.fulfillment object that holds a concise definition of a parameter, its value, and any associated errors.
audit	object	(Read-only) Represents the audit object.
externalIDs	object	(Optional) Represents the externalIDs object containing a set of IDs.
autoRenew	bool	(Optional) A flag that indicates whether the subscription is set to auto‑renew. The vendor can update this field. By default, it is set to true.

Examples

MINIMAL EXAMPLE

SUBSCRIPTION OBJECT

{
  "id": "SUB-5374-9558-1697-7803",  
  "name": "Subscription for Adobe Creative Cloud",
  "status": "Updating",
  "startDate": "2023-06-05T19:08:42.3656851+02:00",
  "renewalDate": "2024-07-20T09:50:59.1139069+02:00",
  "terms": {
    "period": "1m",
    "commitment": "1y"
  },
  "price": {
    "margin": 0.01,
    "markup": 0.011,
    "SPxM": 1708.12,
    "SPxY": 20504.00,
    "PPxM": 7.12,
    "PPxY": 88.00,
    "defaultMarkup": 0.15,
    "currency": "USD"
  },
  "externalIDs": {
    "client": "12345678",
    "vendor": "ABC-2023-C07-dbeee0b302c0"
  },
  "autoRenew": true,
  "lines": [
    { 
      "id": "ALI-1234-1234-1234-0001",
      "item": {
        "id": "ITM-1234-1234-1234-0021",
        "name": "Adobe Illustrator"
      },
      "quantity": 10,
      "price": { ... }
    },
    {
      "id": "ALI-1234-1234-1234-0002",
      "item": {
        "id": "ITM-4444-4444-4444-0031",
        "name": "Adobe Photoshop"
      },
      "quantity": 1,
      "price": { ... }
    }
  ]
}

COMPLETE EXAMPLE