Choose a version:

subscriptionBillingAttempt

query

Returns a SubscriptionBillingAttempt by ID.

Arguments

Anchor to idid • ID!required: The ID of the SubscriptionBillingAttempt to return.

Was this section helpful?

Anchor to Possible returnsPossible returns

SubscriptionBillingAttempt

•

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.

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.
ready• Boolean! non-null: Whether the billing attempt is still processing.
subscriptionContract• SubscriptionContract! non-null: The subscription contract.
errorCode• SubscriptionBillingAttemptErrorCode: A code corresponding to a payment error during processing.
errorMessage• String: A message describing a payment error during processing.

Was this section helpful?

Query for a subscription billing attempt

Open in GraphiQL

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

query findBillingAttempt($subscriptionBillingAttempt: ID!) {

subscriptionBillingAttempt(id: $subscriptionBillingAttempt) {

nextActionUrl

idempotencyKey

ready

order {

}

subscriptionContract {

}

errorMessage

errorCode

}

}`,

{

variables: {

"subscriptionBillingAttempt": "gid://shopify/SubscriptionBillingAttempt/693432112"

);

const data = await response.json();

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

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-07/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"
  }
}'

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();

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

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)

Input variables

JSON

{

"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

}