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

# subscription​Billing​Attempt

query

Returns a SubscriptionBillingAttempt by ID.

## Arguments

* id

  [ID!](https://shopify.dev/docs/api/admin-graphql/2024-10/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/2024-10/objects/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.

***

## Examples

* ### 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/2024-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"
    }
  }'
  ```

  #### Remix

  ```javascript
  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 data = await response.json();
  ```

  #### 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"
      },
    },
  });
  ```

  #### 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
    }
  }
  ```

## Query for a subscription billing attempt

[Open in GraphiQL](http://localhost:3457/graphiql?query=query%20findBillingAttempt\(%24subscriptionBillingAttempt%3A%20ID!\)%20%7B%0A%20%20subscriptionBillingAttempt\(id%3A%20%24subscriptionBillingAttempt\)%20%7B%0A%20%20%20%20id%0A%20%20%20%20nextActionUrl%0A%20%20%20%20idempotencyKey%0A%20%20%20%20ready%0A%20%20%20%20order%20%7B%0A%20%20%20%20%20%20id%0A%20%20%20%20%7D%0A%20%20%20%20subscriptionContract%20%7B%0A%20%20%20%20%20%20id%0A%20%20%20%20%7D%0A%20%20%20%20errorMessage%0A%20%20%20%20errorCode%0A%20%20%7D%0A%7D\&variables=%7B%0A%20%20%22subscriptionBillingAttempt%22%3A%20%22gid%3A%2F%2Fshopify%2FSubscriptionBillingAttempt%2F693432112%22%0A%7D)

```javascript
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 data = await response.json();
```

## Input variables

JSON

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

## Response

JSON

```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
  }
}
```