---
title: SubscriptionBillingAttemptState - GraphQL Admin
description: The state of a subscription billing attempt with state-specific data.
api_version: unstable
api_name: admin
source_url:
  html: >-
    https://shopify.dev/docs/api/admin-graphql/unstable/unions/SubscriptionBillingAttemptState
  md: >-
    https://shopify.dev/docs/api/admin-graphql/unstable/unions/SubscriptionBillingAttemptState.md
---

# Subscription​Billing​Attempt​State

union

Requires `read_own_subscription_contracts` access scope.

The state of a subscription billing attempt with state-specific data.

## Possible types

* [Subscription​Billing​Attempt​Action​Required​State](https://shopify.dev/docs/api/admin-graphql/unstable/objects/SubscriptionBillingAttemptActionRequiredState)

  OBJECT

  The billing attempt state that requires an action to resolve. Must complete the action required for the billing attempt to continue being processed.

  * action

    [Subscription​Billing​Attempt​Action!](https://shopify.dev/docs/api/admin-graphql/unstable/unions/SubscriptionBillingAttemptAction)

    non-null

    The action required to resolve the billing attempt.

* [Subscription​Billing​Attempt​Failed​State](https://shopify.dev/docs/api/admin-graphql/unstable/objects/SubscriptionBillingAttemptFailedState)

  OBJECT

  The billing attempt failed due to an error.

  * error

    [Subscription​Billing​Attempt​Error!](https://shopify.dev/docs/api/admin-graphql/unstable/unions/SubscriptionBillingAttemptError)

    non-null

    The error that caused the billing attempt to fail.

* [Subscription​Billing​Attempt​Pending​State](https://shopify.dev/docs/api/admin-graphql/unstable/objects/SubscriptionBillingAttemptPendingState)

  OBJECT

  The billing attempt is currently being processed.

  * processing

    [Boolean!](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/Boolean)

    non-null

    Always true when the billing attempt is pending.

* [Subscription​Billing​Attempt​Success​State](https://shopify.dev/docs/api/admin-graphql/unstable/objects/SubscriptionBillingAttemptSuccessState)

  OBJECT

  The billing attempt completed successfully and created an order.

  * order

    [Order](https://shopify.dev/docs/api/admin-graphql/unstable/objects/Order)

    The order created by the successful billing attempt. May be null if the order was deleted.

***

## Fields with this union

* [Subscription​Billing​Attempt.state](https://shopify.dev/docs/api/admin-graphql/unstable/objects/SubscriptionBillingAttempt#field-SubscriptionBillingAttempt.fields.state)

  OBJECT

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

  When a billing attempt completes successfully, it creates an [`Order`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order). The attempt includes associated payment transactions and any errors that occur during billing. If 3D Secure authentication is required, the `nextActionUrl` field provides the redirect URL for customer verification.

***

```graphql
union SubscriptionBillingAttemptState = SubscriptionBillingAttemptActionRequiredState | SubscriptionBillingAttemptFailedState | SubscriptionBillingAttemptPendingState | SubscriptionBillingAttemptSuccessState
```