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.
completedAt•
DateTime
The date and time when the billing attempt was completed.
createdAt•
DateTime!
non-null
The date and time when the billing attempt was created.
id•
ID!
non-null
A globally-unique ID.
idempotencyKey•
String!
non-null
A unique key generated by the client to avoid duplicate payments.
nextActionUrl•
URL
The URL where the customer needs to be redirected so they can complete the 3D Secure payment flow.
order•
Order
The result of this billing attempt if completed successfully.
originTime•
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.
paymentGroupId•
String
The reference shared between retried payment attempts.
paymentSessionId•
String
The reference shared between payment attempts with similar payment details.
processingError•
SubscriptionBillingAttemptProcessingError
Error information from processing the billing attempt.
ready•
Boolean!
non-null
Whether the billing attempt is still processing.
respectInventoryPolicy•
Boolean!
non-null
Whether the billing attempt respects the merchant's inventory policy.
subscriptionContract•
SubscriptionContract!
non-null
The subscription contract.
transactions•
OrderTransactionConnection!
non-null
The transactions created by the billing attempt.
errorCode•
SubscriptionBillingAttemptErrorCode
Deprecated
A code corresponding to a payment error during processing. As of API version 2025-01, use processingError.code instead to get the errorCode
errorMessage•
String
Deprecated
A message describing a payment error during processing. As of API version 2025-01, use processingError.message instead to get the errorMessage
