Subscription
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•Date
At Time The date and time when the billing attempt was completed.
- Anchor to createdAtcreated•Date
At Time!non-null The date and time when the billing attempt was created.
- •ID!non-null
A globally-unique ID.
- Anchor to idempotencyKeyidempotency•String!non-null
Key A unique key generated by the client to avoid duplicate payments.
- Anchor to nextActionUrlnext•URL
Action Url The URL where the customer needs to be redirected so they can complete the 3D Secure payment flow.
- Anchor to orderorder•Order
The result of this billing attempt if completed successfully.
- Anchor to originTimeorigin•Date
Time 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•String
Group Id The reference shared between retried payment attempts.
- Anchor to paymentSessionIdpayment•String
Session Id The reference shared between payment attempts with similar payment details.
- Anchor to processingErrorprocessing•Subscription
Error Billing Attempt Processing Error Error information from processing the billing attempt.
- Anchor to readyready•Boolean!non-null
Whether the billing attempt is still processing.
- Anchor to respectInventoryPolicyrespect•Boolean!non-null
Inventory Policy Whether the billing attempt respects the merchant's inventory policy.
- Anchor to subscriptionContractsubscription•Subscription
Contract Contract!non-null The subscription contract.
- Anchor to transactionstransactions•Order
Transaction Connection!non-null The transactions created by the billing attempt.
Deprecated fields and connections
- Anchor to errorCodeerror•Subscription
Code Billing Attempt Error CodeDeprecated - Anchor to errorMessageerror•StringDeprecated
Message
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.
- Anchor to subscriptionBillingAttemptInputsubscription•Subscription
Billing Attempt Input Billing Attempt Input!required The information to apply as a billing attempt.
- Anchor to subscriptionContractIdsubscription•ID!required
Contract Id The ID of the subscription contract.
Arguments
- Anchor to subscriptionBillingAttemptsubscription•Subscription
Billing Attempt Billing Attempt The subscription billing attempt.
- Anchor to userErrorsuser•[Billing
Errors Attempt User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •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.
- Anchor to billingCycleSelectorbilling•Subscription
Cycle Selector Billing Cycle Selector!required Select the specific billing cycle to be billed. If the selected billing cycle's billingAttemptExpectedDate is in the past, the originTime of the billing attempt will be set to this date. However, if the billingAttemptExpectedDate is in the future, the originTime will be the current time.
- Anchor to inventoryPolicyinventory•Subscription
Policy Billing Attempt Inventory PolicyDefault:PRODUCT_VARIANT_INVENTORY_POLICY The behaviour to use when updating inventory.
- Anchor to subscriptionContractIdsubscription•ID!required
Contract Id The ID of the subscription contract.
Arguments
- Anchor to subscriptionBillingAttemptsubscription•Subscription
Billing Attempt Billing Attempt The subscription billing attempt.
- Anchor to userErrorsuser•[Billing
Errors Attempt User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields