---
title: subscriptionBillingAttempt - GraphQL Admin
description: Returns a `SubscriptionBillingAttempt` resource by ID.
api_version: 2026-10
source_url:
  html: >-
    https://shopify.dev/docs/api/admin-graphql/latest/queries/subscriptionBillingAttempt
  md: >-
    https://shopify.dev/docs/api/admin-graphql/latest/queries/subscriptionBillingAttempt.md
api_name: admin
api_type: graphql
type: query
---

# subscription​Billing​Attempt

query

Returns a `SubscriptionBillingAttempt` resource by ID.

## Arguments

* id

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

  required

  The ID of the `SubscriptionBillingAttempt` to return.

***

## Possible returns

* Subscription​Billing​Attempt

  [Subscription​Billing​Attempt](https://shopify.dev/docs/api/admin-graphql/latest/objects/SubscriptionBillingAttempt)

  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.

  * completed​At

    [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime)

    The date and time when the billing attempt was completed.

  * created​At

    [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime)

    non-null

    The date and time when the billing attempt was created.

  * id

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

    non-null

    A globally-unique ID.

  * idempotency​Key

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

    non-null

    A unique key generated by the client to avoid duplicate payments.

  * origin​Time

    [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/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.

  * payment​Group​Id

    [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)

    The reference shared between retried payment attempts.

  * payment​Session​Id

    [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)

    The reference shared between payment attempts with similar payment details.

  * respect​Inventory​Policy

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

    non-null

    Whether the billing attempt respects the merchant's inventory policy.

  * state

    [Subscription​Billing​Attempt​State!](https://shopify.dev/docs/api/admin-graphql/latest/unions/SubscriptionBillingAttemptState)

    non-null

    The state of the billing attempt with state-specific data.

  * subscription​Contract

    [Subscription​Contract!](https://shopify.dev/docs/api/admin-graphql/latest/objects/SubscriptionContract)

    non-null

    The subscription contract.

  * transactions

    [Order​Transaction​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/OrderTransactionConnection)

    non-null

    The transactions created by the billing attempt.

    * after

      [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)

      ### Arguments

      The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

    * before

      [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)

      The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

    * first

      [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)

      The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

    * last

      [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)

      The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

    * reverse

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

      Default:false

      Reverse the order of the underlying list.

    ***

  * error​Code

    [Subscription​Billing​Attempt​Error​Code](https://shopify.dev/docs/api/admin-graphql/latest/enums/SubscriptionBillingAttemptErrorCode)

    Deprecated

  * error​Message

    [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)

    Deprecated

  * next​Action​Url

    [URL](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL)

    Deprecated

  * order

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

    Deprecated

  * processing​Error

    [Subscription​Billing​Attempt​Processing​Error](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/SubscriptionBillingAttemptProcessingError)

    Deprecated

  * ready

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

    non-nullDeprecated

***

## Examples

* ### Query for a billing attempt with a processing error

  #### Description

  Shows how to query for error details.

  #### Query

  ```graphql
  query findBillingAttempt($subscriptionBillingAttempt: ID!) {
    subscriptionBillingAttempt(id: $subscriptionBillingAttempt) {
      id
      nextActionUrl
      idempotencyKey
      ready
      order {
        id
      }
      subscriptionContract {
        id
      }
      processingError {
        __typename
        code
        message
        ... on SubscriptionBillingAttemptInsufficientStockProductVariantsError {
          insufficientStockProductVariants(first: 3) {
            edges {
              node {
                id
                title
              }
            }
          }
        }
      }
    }
  }
  ```

  #### Variables

  ```json
  {
    "subscriptionBillingAttempt": "gid://shopify/SubscriptionBillingAttempt/693432113"
  }
  ```

  #### cURL

  ```bash
  curl -X POST \
  https://your-development-store.myshopify.com/admin/api/2026-10/graphql.json \
  -H 'Content-Type: application/json' \
  -H 'X-Shopify-Access-Token: {access_token}' \
  -d '{
  "query": "query findBillingAttempt($subscriptionBillingAttempt: ID!) { subscriptionBillingAttempt(id: $subscriptionBillingAttempt) { id nextActionUrl idempotencyKey ready order { id } subscriptionContract { id } processingError { __typename code message ... on SubscriptionBillingAttemptInsufficientStockProductVariantsError { insufficientStockProductVariants(first: 3) { edges { node { id title } } } } } } }",
   "variables": {
      "subscriptionBillingAttempt": "gid://shopify/SubscriptionBillingAttempt/693432113"
    }
  }'
  ```

  #### React Router

  ```javascript
  import { authenticate } from "../shopify.server";

  export const loader = async ({request}) => {
    const { admin } = await authenticate.admin(request);
    const response = await admin.graphql(
      `#graphql
    query findBillingAttempt($subscriptionBillingAttempt: ID!) {
      subscriptionBillingAttempt(id: $subscriptionBillingAttempt) {
        id
        nextActionUrl
        idempotencyKey
        ready
        order {
          id
        }
        subscriptionContract {
          id
        }
        processingError {
          __typename
          code
          message
          ... on SubscriptionBillingAttemptInsufficientStockProductVariantsError {
            insufficientStockProductVariants(first: 3) {
              edges {
                node {
                  id
                  title
                }
              }
            }
          }
        }
      }
    }`,
    {
      variables: {
          "subscriptionBillingAttempt": "gid://shopify/SubscriptionBillingAttempt/693432113"
      },
    },
    );
    const json = await response.json();
    return json.data;
  }
  ```

  #### Ruby

  ```ruby
  session = ShopifyAPI::Auth::Session.new(
    shop: "your-development-store.myshopify.com",
    access_token: access_token
  )
  client = ShopifyAPI::Clients::Graphql::Admin.new(
    session: session
  )

  query = <<~QUERY
    query findBillingAttempt($subscriptionBillingAttempt: ID!) {
      subscriptionBillingAttempt(id: $subscriptionBillingAttempt) {
        id
        nextActionUrl
        idempotencyKey
        ready
        order {
          id
        }
        subscriptionContract {
          id
        }
        processingError {
          __typename
          code
          message
          ... on SubscriptionBillingAttemptInsufficientStockProductVariantsError {
            insufficientStockProductVariants(first: 3) {
              edges {
                node {
                  id
                  title
                }
              }
            }
          }
        }
      }
    }
  QUERY

  variables = {
    "subscriptionBillingAttempt": "gid://shopify/SubscriptionBillingAttempt/693432113"
  }

  response = client.query(query: query, variables: variables)
  ```

  #### Node.js

  ```javascript
  const client = new shopify.clients.Graphql({session});
  const data = await client.query({
    data: {
      "query": `query findBillingAttempt($subscriptionBillingAttempt: ID!) {
        subscriptionBillingAttempt(id: $subscriptionBillingAttempt) {
          id
          nextActionUrl
          idempotencyKey
          ready
          order {
            id
          }
          subscriptionContract {
            id
          }
          processingError {
            __typename
            code
            message
            ... on SubscriptionBillingAttemptInsufficientStockProductVariantsError {
              insufficientStockProductVariants(first: 3) {
                edges {
                  node {
                    id
                    title
                  }
                }
              }
            }
          }
        }
      }`,
      "variables": {
          "subscriptionBillingAttempt": "gid://shopify/SubscriptionBillingAttempt/693432113"
      },
    },
  });
  ```

  #### Shopify CLI

  ```bash
  shopify app execute \
  --query \
  'query findBillingAttempt($subscriptionBillingAttempt: ID!) {
    subscriptionBillingAttempt(id: $subscriptionBillingAttempt) {
      id
      nextActionUrl
      idempotencyKey
      ready
      order {
        id
      }
      subscriptionContract {
        id
      }
      processingError {
        __typename
        code
        message
        ... on SubscriptionBillingAttemptInsufficientStockProductVariantsError {
          insufficientStockProductVariants(first: 3) {
            edges {
              node {
                id
                title
              }
            }
          }
        }
      }
    }
  }' \
  --variables \
  '{
    "subscriptionBillingAttempt": "gid://shopify/SubscriptionBillingAttempt/693432113"
  }'
  ```

  #### Direct API Access

  ```javascript
  const response = await fetch('shopify:admin/api/2026-10/graphql.json', {
    method: 'POST',
    body: JSON.stringify({
      query: `
        query findBillingAttempt($subscriptionBillingAttempt: ID!) {
          subscriptionBillingAttempt(id: $subscriptionBillingAttempt) {
            id
            nextActionUrl
            idempotencyKey
            ready
            order {
              id
            }
            subscriptionContract {
              id
            }
            processingError {
              __typename
              code
              message
              ... on SubscriptionBillingAttemptInsufficientStockProductVariantsError {
                insufficientStockProductVariants(first: 3) {
                  edges {
                    node {
                      id
                      title
                    }
                  }
                }
              }
            }
          }
        }
      `,
      variables: {
          "subscriptionBillingAttempt": "gid://shopify/SubscriptionBillingAttempt/693432113"
      },
    }),
  });

  const { data } = await response.json();
  console.log(data);
  ```

  #### Response

  ```json
  {
    "subscriptionBillingAttempt": {
      "id": "gid://shopify/SubscriptionBillingAttempt/693432113",
      "nextActionUrl": null,
      "idempotencyKey": "unique-token",
      "ready": true,
      "order": {
        "id": "gid://shopify/Order/148977776"
      },
      "subscriptionContract": {
        "id": "gid://shopify/SubscriptionContract/593791907"
      },
      "processingError": {
        "__typename": "SubscriptionBillingAttemptInsufficientStockProductVariantsError",
        "code": "INSUFFICIENT_INVENTORY",
        "message": "Insufficient inventory.",
        "insufficientStockProductVariants": {
          "edges": [
            {
              "node": {
                "id": "gid://shopify/ProductVariant/43729076",
                "title": "151cm"
              }
            }
          ]
        }
      }
    }
  }
  ```

* ### Query for a subscription billing attempt

  #### Description

  Finds a subscription billing attempt by id.

  #### Query

  ```graphql
  query findBillingAttempt($subscriptionBillingAttempt: ID!) {
    subscriptionBillingAttempt(id: $subscriptionBillingAttempt) {
      id
      nextActionUrl
      idempotencyKey
      ready
      order {
        id
      }
      subscriptionContract {
        id
      }
      errorMessage
      errorCode
    }
  }
  ```

  #### Variables

  ```json
  {
    "subscriptionBillingAttempt": "gid://shopify/SubscriptionBillingAttempt/693432112"
  }
  ```

  #### cURL

  ```bash
  curl -X POST \
  https://your-development-store.myshopify.com/admin/api/2026-10/graphql.json \
  -H 'Content-Type: application/json' \
  -H 'X-Shopify-Access-Token: {access_token}' \
  -d '{
  "query": "query findBillingAttempt($subscriptionBillingAttempt: ID!) { subscriptionBillingAttempt(id: $subscriptionBillingAttempt) { id nextActionUrl idempotencyKey ready order { id } subscriptionContract { id } errorMessage errorCode } }",
   "variables": {
      "subscriptionBillingAttempt": "gid://shopify/SubscriptionBillingAttempt/693432112"
    }
  }'
  ```

  #### React Router

  ```javascript
  import { authenticate } from "../shopify.server";

  export const loader = async ({request}) => {
    const { admin } = await authenticate.admin(request);
    const response = await admin.graphql(
      `#graphql
    query findBillingAttempt($subscriptionBillingAttempt: ID!) {
      subscriptionBillingAttempt(id: $subscriptionBillingAttempt) {
        id
        nextActionUrl
        idempotencyKey
        ready
        order {
          id
        }
        subscriptionContract {
          id
        }
        errorMessage
        errorCode
      }
    }`,
    {
      variables: {
          "subscriptionBillingAttempt": "gid://shopify/SubscriptionBillingAttempt/693432112"
      },
    },
    );
    const json = await response.json();
    return json.data;
  }
  ```

  #### Ruby

  ```ruby
  session = ShopifyAPI::Auth::Session.new(
    shop: "your-development-store.myshopify.com",
    access_token: access_token
  )
  client = ShopifyAPI::Clients::Graphql::Admin.new(
    session: session
  )

  query = <<~QUERY
    query findBillingAttempt($subscriptionBillingAttempt: ID!) {
      subscriptionBillingAttempt(id: $subscriptionBillingAttempt) {
        id
        nextActionUrl
        idempotencyKey
        ready
        order {
          id
        }
        subscriptionContract {
          id
        }
        errorMessage
        errorCode
      }
    }
  QUERY

  variables = {
    "subscriptionBillingAttempt": "gid://shopify/SubscriptionBillingAttempt/693432112"
  }

  response = client.query(query: query, variables: variables)
  ```

  #### Node.js

  ```javascript
  const client = new shopify.clients.Graphql({session});
  const data = await client.query({
    data: {
      "query": `query findBillingAttempt($subscriptionBillingAttempt: ID!) {
        subscriptionBillingAttempt(id: $subscriptionBillingAttempt) {
          id
          nextActionUrl
          idempotencyKey
          ready
          order {
            id
          }
          subscriptionContract {
            id
          }
          errorMessage
          errorCode
        }
      }`,
      "variables": {
          "subscriptionBillingAttempt": "gid://shopify/SubscriptionBillingAttempt/693432112"
      },
    },
  });
  ```

  #### Shopify CLI

  ```bash
  shopify app execute \
  --query \
  'query findBillingAttempt($subscriptionBillingAttempt: ID!) {
    subscriptionBillingAttempt(id: $subscriptionBillingAttempt) {
      id
      nextActionUrl
      idempotencyKey
      ready
      order {
        id
      }
      subscriptionContract {
        id
      }
      errorMessage
      errorCode
    }
  }' \
  --variables \
  '{
    "subscriptionBillingAttempt": "gid://shopify/SubscriptionBillingAttempt/693432112"
  }'
  ```

  #### Direct API Access

  ```javascript
  const response = await fetch('shopify:admin/api/2026-10/graphql.json', {
    method: 'POST',
    body: JSON.stringify({
      query: `
        query findBillingAttempt($subscriptionBillingAttempt: ID!) {
          subscriptionBillingAttempt(id: $subscriptionBillingAttempt) {
            id
            nextActionUrl
            idempotencyKey
            ready
            order {
              id
            }
            subscriptionContract {
              id
            }
            errorMessage
            errorCode
          }
        }
      `,
      variables: {
          "subscriptionBillingAttempt": "gid://shopify/SubscriptionBillingAttempt/693432112"
      },
    }),
  });

  const { data } = await response.json();
  console.log(data);
  ```

  #### Response

  ```json
  {
    "subscriptionBillingAttempt": {
      "id": "gid://shopify/SubscriptionBillingAttempt/693432112",
      "nextActionUrl": null,
      "idempotencyKey": "unique-token",
      "ready": true,
      "order": {
        "id": "gid://shopify/Order/148977776"
      },
      "subscriptionContract": {
        "id": "gid://shopify/SubscriptionContract/593791907"
      },
      "errorMessage": null,
      "errorCode": null
    }
  }
  ```