Choose a version:

SubscriptionGroupedLine

union

Requires the read_own_subscription_contracts or write_own_subscription_contracts scope.

A subscription contract line grouped by bundle parent: either a standalone line or a bundle parent line and its components.

Anchor to Possible typesPossible types

Anchor to SubscriptionLine SubscriptionLine •OBJECT: A product line item within a SubscriptionContract. Each line represents a specific product variant that the customer subscribes to, including its quantity, pricing, and whether shipping is required.

The line maintains references to the ProductVariant, SellingPlan, and custom Attribute objects. It tracks the current price and any scheduled price changes through its pricingPolicy. You can modify lines through SubscriptionDraft objects without affecting the original contract until you commit changes.

Learn more about subscription contracts and selling plans.
Anchor to SubscriptionParentLine SubscriptionParentLine •OBJECT: Represents a Subscription Parent Line.

Was this section helpful?

Anchor to Fields with this unionFields with this union

Anchor to SubscriptionBillingCycleEditedContract.groupedLines SubscriptionBillingCycleEditedContract.groupedLines •OBJECT: Represents a subscription contract with billing cycles.
Anchor to SubscriptionCalculatedContract.groupedLines SubscriptionCalculatedContract.groupedLines •OBJECT: A calculated subscription contract that can be previewed before committing.
Anchor to SubscriptionContract.groupedLines SubscriptionContract.groupedLines •OBJECT: A subscription contract that defines recurring purchases for a customer. Each contract specifies what products to deliver, when to bill and ship them, and at what price.

The contract includes SubscriptionBillingPolicy and SubscriptionDeliveryPolicy that control the frequency of charges and fulfillments. SubscriptionLine items define the products, quantities, and pricing for each recurring Order. The contract tracks SubscriptionBillingAttempt records, payment status, and generated orders throughout its lifecycle. App instances manage contracts through various status transitions including active, paused, failed, cancelled, or expired states.

Learn more about building subscription contracts and updating subscription contracts.
Anchor to SubscriptionContractBase.groupedLines SubscriptionContractBase.groupedLines •INTERFACE: Represents subscription contract common fields.
Anchor to SubscriptionGroupedLineConnection.nodes SubscriptionGroupedLineConnection.nodes •CONNECTION: An auto-generated type for paginating through multiple SubscriptionGroupedLines.
Anchor to SubscriptionGroupedLineEdge.node SubscriptionGroupedLineEdge.node •OBJECT: An auto-generated type which holds one SubscriptionGroupedLine and a cursor during pagination.

Was this section helpful?