Line

A Line object represents one of the following: an Order Line, an Agreement Line, or a Subscription Line.

A Line object describes the quantity of product items being purchased within the scope of an order or subscription, along with the associated pricing.

Typically, a Line object is first introduced through a purchase order or a change order. After creation, the line is assigned either to a subscription (for recurring terms) or to an agreement (for one‑time terms). A line belonging to an active subscription may later appear in a change order to update its quantity or price. In some cases, a new Line object may be created directly within a subscription by the vendor—for example, during migration or synchronization scenarios.

The lifecycle of a Line object is tied to the lifecycle of the corresponding agreement.

Line objects are always returned or provided as part of a lines array within one of the following parent objects: an agreement, a subscription, or an order.

Field	Type	Description
id	string	Line identifier, consisting of fixed prefix (same digits as in relevant agreement object), and a suffix, which is sequential number for all allocated lines in scope of the agreement (including failed or deleted orders).
item	object	Represents the item object.
oldQuantity	integer	In case of purchase orders, this value will always be unset. For change orders, this value reflects the agreement quantity at the time the change order was created.
quantity	integer	The quantity of items in a subscription.
price	object	The price for the item in the subscription. Not all fields are visible to all actors.
subscription	object	A reference to subscription where this line resides. The value is never returned in the context of a subscription. It is used only in orders.
order	object	Last order where the Line was introduced/updated. The value is never returned in the context of an order. It can be used in the context of a subscription or agreement.

Example

LINE OBJECT

{
  "id": "ALI-1234-1234-1234-0001",
  "item": {
    "id": "ITM-1234-1234-1234-0021",
    "name": "Adobe Illustrator"
  },
  "oldQuantity": 7,
  "quantity": 10,
  "price": {
    "PPxY": 150,
    "PPxM": 12.50,
    "unitPP": 1.25,
    "SPxY": 165,
    "SPxM": 13.50,
    "unitSP": 1.35,
    "markup": 0.10,
    "margin": 0.11,
    "currency": "USD"
  },
  "subscription": {
    "id": "SUB-1234-1234-1234"
  }
}