Line

A Line object represents either an Order Line object an Agreement Line object or a Subscription Line object.

A Line object represents the amount (quantity) of product items being purchased in the scope of order and/or subscription as well as a price for them.

Usually, a Line object first appears in some purchase or change order. Later on, the line should be assigned to some subscription for recurrent terms, or to agreement for one-time terms. Also, a Line of active subscriptions can be used in a change order to update the quantity or/and price of the subscription Line. Also, a new Line object can be introduced just directly in the subscription by the vendor (migration or synchronization scenario).

The lifecycle of the Line object is bound to the lifecycle of the relevant agreement object.

Lines are always returned or provided as part of a lines array of either one of the Agreement object, the Subscription object, or the Order object.

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	item
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 is resides. The value is never returned in context of subscription, it is used only in orders.
order	object	Last order where the Line was introduced/updated. The value is never returned in context of an order. It can be used in context of a subscription or agreement.

Example

{
  "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" }
}