> For the complete documentation index, see [llms.txt](https://docs.platform.softwareone.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.platform.softwareone.com/developer-resources/rest-api/commerce-api/line.md). # 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`.
FieldTypeDescription
idstringLine 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).ALI-1234-1234-1234-0001
itemobject Represents the item object.{ "id": "ITM-1234-1234-1234-0021", "name": "Adobe Illustrator" }
oldQuantityintegerIn 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.7
quantityintegerThe quantity of items in a subscription.10
priceobjectThe price for the item in the subscription. Not all fields are visible to all actors. { "PPxY": 150, "PPxM": 12.50, "unitPP": 1.25 "SPxY": 165, "SPxM": 13.50, "unitSP": 1.35, "markup": 0.10, "margin": 0.11, "currency": "USD" }
subscriptionobjectA reference to subscription where this line resides. The value is never returned in the context of a subscription. It is used only in orders.{ "id": "SUB-1234-1234-1234" }
orderobjectLast 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.{ "id": "ORD-6869-4529-8975-9005" }
## Example {% code title="LINE OBJECT" overflow="wrap" lineNumbers="true" %} ```json { "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" } } ``` {% endcode %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.platform.softwareone.com/developer-resources/rest-api/commerce-api/line.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.