SubscriptionBillingAttempt
Requires 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.
Anchor to Fields and connectionsFields and connections
- Anchor to completedAtcompleted•
At The date and time when the billing attempt was completed.
- Anchor to createdAtcreated•
At DateTime! non-null The date and time when the billing attempt was created.
- •ID!non-null
A globally-unique ID.
- Anchor to idempotencyKeyidempotency•
Key String!non-null A unique key generated by the client to avoid duplicate payments.
- Anchor to nextActionUrlnext•
Action Url The URL where the customer needs to be redirected so they can complete the 3D Secure payment flow.
- Anchor to orderorder•
The result of this billing attempt if completed successfully.
- Anchor to originTimeorigin•
Time 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.
- Anchor to paymentGroupIdpayment•
Group Id The reference shared between retried payment attempts.
- Anchor to paymentSessionIdpayment•
Session Id The reference shared between payment attempts with similar payment details.
- Anchor to processingErrorprocessing•
Error Error information from processing the billing attempt.
- Anchor to readyready•Boolean!non-null
Whether the billing attempt is still processing.
- Anchor to respectInventoryPolicyrespect•
Inventory Policy Boolean!non-null Whether the billing attempt respects the merchant's inventory policy.
- Anchor to subscriptionContractsubscription•
Contract SubscriptionContract! non-null The subscription contract.
- Anchor to transactionstransactions•Order
Transaction non-nullConnection! The transactions created by the billing attempt.
Anchor to QueriesQueries
- •query
Returns a SubscriptionBillingAttempt by ID.
- •query
Returns subscription billing attempts on a store.
Anchor to MutationsMutations
- •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.