SubscriptionBillingAttemptConnection

connection

An auto-generated type for paginating through multiple SubscriptionBillingAttempts.

Anchor to Fields with this connectionFields with this connection

Anchor to SubscriptionBillingCycle.billingAttempts SubscriptionBillingCycle.billingAttempts •OBJECT: A subscription billing cycle.
Anchor to SubscriptionContract.billingAttempts SubscriptionContract.billingAttempts •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.

Was this section helpful?

Anchor to Queries with this connectionQueries with this connection

Anchor to subscriptionBillingAttempts subscriptionBillingAttempts

•query

Returns subscription billing attempts on a store.

Arguments

Anchor to firstfirst

•Int

The first n elements from the paginated list.

Anchor to afterafter

•String

The elements that come after the specified cursor.

Anchor to lastlast

•Int

The last n elements from the paginated list.

Anchor to beforebefore

•String

The elements that come before the specified cursor.

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey

•SubscriptionBillingAttemptsSortKeys

Default:CREATED_AT

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Anchor to queryquery

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to created_at •time
Anchor to error_code •string
Anchor to error_message •string
Anchor to id •id: Filter by id range.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to edgesedges •[SubscriptionBillingAttemptEdge!]! non-null: The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
Anchor to nodesnodes •[SubscriptionBillingAttempt!]! non-null: A list of nodes that are contained in SubscriptionBillingAttemptEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.
Anchor to pageInfopageInfo •PageInfo! non-null: An object that’s used to retrieve cursor information about the current page.

Was this section helpful?