Home > @infiniteobjects/shopify-data-manager > AdminTypes > SubscriptionBillingAttempt
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.
Signature:
export interface SubscriptionBillingAttempt extends Node
Extends: Node
| Property | Modifiers | Type | Description |
|---|---|---|---|
| completedAt? | Maybe<Scalars[‘DateTime’][‘output’]> | (Optional) The date and time when the billing attempt was completed. | |
| createdAt | Scalars[‘DateTime’][‘output’] | The date and time when the billing attempt was created. | |
| errorCode? | Maybe<SubscriptionBillingAttemptErrorCode | `${SubscriptionBillingAttemptErrorCode}`> | (Optional) A code corresponding to a payment error during processing. | |
| errorMessage? | Maybe<Scalars[‘String’][‘output’]> | (Optional) A message describing a payment error during processing. | |
| id | Scalars[‘ID’][‘output’] | A globally-unique ID. | |
| idempotencyKey | Scalars[‘String’][‘output’] | A unique key generated by the client to avoid duplicate payments. | |
| nextActionUrl? | Maybe<Scalars[‘URL’][‘output’]> | (Optional) The URL where the customer needs to be redirected so they can complete the 3D Secure payment flow. | |
| order? | Maybe<Order> | (Optional) The result of this billing attempt if completed successfully. | |
| originTime? | Maybe<Scalars[‘DateTime’][‘output’]> | (Optional) 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. | |
| ready | Scalars[‘Boolean’][‘output’] | Whether the billing attempt is still processing. | |
| subscriptionContract | SubscriptionContract | The subscription contract. |