Skip to main content

SubscriptionOrderLine

A line on a subscription order. It either comes from a subscription line or is a one-off for this order.

type SubscriptionOrderLine {
  basePriceSet: MoneySet!
  createdAt: Timestamp!
  customAttributes: [CustomAttribute!]!
  customised: Boolean!
  financials: SubscriptionOrderLineFinancials
  financialsSet: SubscriptionOrderLineFinancialsSet!
  id: GlobalID!
  lineItem: LineItem
  lineType: SubscriptionOrderLineType!
  product: Product!
  productVariant: ProductVariant!
  quantity: Count!
  status: SubscriptionOrderLineStatus!
  subscriptionLine: SubscriptionLine
  subscriptionOrder: SubscriptionOrder!
  updatedAt: Timestamp!
}

Fields​

SubscriptionOrderLine.basePriceSet ● MoneySet! non-null object types​

The line's base unit price in shop and presentment currencies, taken from the product variant when the line was added.

SubscriptionOrderLine.createdAt ● Timestamp! non-null scalar types​

The date and time when the subscription order line was created.

SubscriptionOrderLine.customAttributes ● [CustomAttribute!]! non-null object types​

The subscription order line's custom attributes.

SubscriptionOrderLine.customised ● Boolean! non-null scalar types​

Whether the line's quantity was changed on this subscription order. A customised line keeps its quantity when its subscription line changes.

SubscriptionOrderLine.financials ● SubscriptionOrderLineFinancials object types​

The line's financial details in the shop's currency.

SubscriptionOrderLine.financialsSet ● SubscriptionOrderLineFinancialsSet! non-null object types​

The line's financial details in shop and presentment currencies.

SubscriptionOrderLine.id ● GlobalID! non-null scalar types​

The subscription order line's ID.

SubscriptionOrderLine.lineItem ● LineItem object types​

The order line item created from this line when the subscription order was processed.

SubscriptionOrderLine.lineType ● SubscriptionOrderLineType! non-null enum types​

Whether the line recurs from the subscription or is a one-off for this subscription order.

SubscriptionOrderLine.product ● Product! non-null object types​

The subscription order line's product.

SubscriptionOrderLine.productVariant ● ProductVariant! non-null object types​

The subscription order line's product variant.

SubscriptionOrderLine.quantity ● Count! non-null scalar types​

The subscription order line's quantity.

SubscriptionOrderLine.status ● SubscriptionOrderLineStatus! non-null enum types​

The subscription order line's status.

SubscriptionOrderLine.subscriptionLine ● SubscriptionLine object types​

The subscription line this line comes from. Empty for one-off lines.

SubscriptionOrderLine.subscriptionOrder ● SubscriptionOrder! non-null object types​

The subscription order the line belongs to.

SubscriptionOrderLine.updatedAt ● Timestamp! non-null scalar types​

The date and time when the subscription order line was last updated.

Member Of​

SubscriptionOrder object ● SubscriptionOrderLineAddPayload object ● SubscriptionOrderLineRemovePayload object ● SubscriptionOrderLineSetQuantityPayload object