Skip to main content
Anchor to SubscriptionBillingAttempt

SubscriptionBillingAttempt

object

Requires read_own_subscription_contracts access scope.

A record of an execution of the subscription billing process. Billing attempts use idempotency keys to avoid duplicate order creation. A successful billing attempt will create an order.

•DateTime

The date and time when the billing attempt was completed.

•DateTime!
non-null

The date and time when the billing attempt was created.

•ID!
non-null

A globally-unique ID.

•String!
non-null

A unique key generated by the client to avoid duplicate payments.

•URL

The URL where the customer needs to be redirected so they can complete the 3D Secure payment flow.

•Order

The result of this billing attempt if completed successfully.

•DateTime

The date and time used to calculate fulfillment intervals for a billing attempt that successfully completed after the current anchor date. To prevent fulfillment from being pushed to the next anchor date, this field can override the billing attempt date.

•String

The reference shared between retried payment attempts.

•String

The reference shared between payment attempts with similar payment details.

•SubscriptionBillingAttemptProcessingError

Error information from processing the billing attempt.

•Boolean!
non-null

Whether the billing attempt is still processing.

Anchor to respectInventoryPolicyrespectInventoryPolicy
•Boolean!
non-null

Whether the billing attempt respects the merchant's inventory policy.

Anchor to subscriptionContractsubscriptionContract
•SubscriptionContract!
non-null

The subscription contract.

•OrderTransactionConnection!
non-null

The transactions created by the billing attempt.

Deprecated fields

•SubscriptionBillingAttemptErrorCode
Deprecated
•String
Deprecated

Was this section helpful?

•query

Returns a SubscriptionBillingAttempt by ID.

•query

Returns subscription billing attempts on a store.


Was this section helpful?

•mutation

Creates a new subscription billing attempt. For more information, refer to Create a subscription contract.

•mutation

Creates a new subscription billing attempt for a specified billing cycle. This is the alternative mutation for subscriptionBillingAttemptCreate. For more information, refer to Create a subscription contract.


Was this section helpful?

•interface

Was this section helpful?