Skip to main content

SubscriptionLine

A product variant that recurs on a subscription. Each upcoming subscription order gets a matching line.

type SubscriptionLine {
basePrice: Money!
basePriceSet: MoneySet!
createdAt: Timestamp!
customAttributes: [CustomAttribute!]!
customised: Boolean!
id: GlobalID!
product: Product!
productVariant: ProductVariant!
quantity: Count!
status: SubscriptionLineStatus!
subscription: Subscription!
updatedAt: Timestamp!
}

Fields​

SubscriptionLine.basePrice ● Money! non-null object types​

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

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

The line's base unit price in shop and presentment currencies.

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

The date and time when the subscription line was created.

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

The subscription line's custom attributes.

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

Whether the line's quantity was changed with subscriptionLineSetQuantity.

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

The subscription line's ID.

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

The subscription line's product.

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

The subscription line's product variant.

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

The subscription line's quantity.

SubscriptionLine.status ● SubscriptionLineStatus! non-null enum types​

The subscription line's status.

SubscriptionLine.subscription ● Subscription! non-null object types​

The subscription the line belongs to.

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

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

Member Of​

Subscription object ● SubscriptionLineAddPayload object ● SubscriptionLineRemovePayload object ● SubscriptionLineSetQuantityPayload object ● SubscriptionOrderLine object