subscription Billing Attemptquery
query
2024-10latest
Returns a SubscriptionBillingAttempt by ID.
Arguments
The ID of the SubscriptionBillingAttempt to return.
Was this section helpful?
SubscriptionBillingAttempt possible returns
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.
Was this section helpful?
Code examples for QUERY: subscriptionBillingAttempt
Query Reference for QUERY: subscriptionBillingAttempt
"{\n subscriptionBillingAttempt(id) {\n # SubscriptionBillingAttempt fields\n }\n}"
Input Reference for QUERY: subscriptionBillingAttempt
Schema Reference for QUERY: subscriptionBillingAttempt
Display Examples for QUERY: subscriptionBillingAttempt
[ { "example": { "type_name": "subscriptionbillingattempt", "title": "Query for a subscription billing attempt", "description": "Finds a subscription billing attempt by id.", "query_string": "query findBillingAttempt($subscriptionBillingAttempt: ID!) {\n subscriptionBillingAttempt(id: $subscriptionBillingAttempt) {\n id\n nextActionUrl\n idempotencyKey\n ready\n order {\n id\n }\n subscriptionContract {\n id\n }\n errorMessage\n errorCode\n }\n}", "variables": { "subscriptionBillingAttempt": "gid://shopify/SubscriptionBillingAttempt/528177103" }, "response": { "data": { "subscriptionBillingAttempt": { "id": "gid://shopify/SubscriptionBillingAttempt/528177103", "nextActionUrl": null, "idempotencyKey": "unique-token", "ready": true, "order": { "id": "gid://shopify/Order/148977776" }, "subscriptionContract": { "id": "gid://shopify/SubscriptionContract/593791907" }, "errorMessage": null, "errorCode": null } } }, "api_name": "admin", "minimum_api_version": "2023-10", "maximum_api_version": "unstable", "location": "/components/sales/subscriptions/test/unit/graph_api/admin/subscription_billing_attempt_test.rb", "curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query findBillingAttempt($subscriptionBillingAttempt: ID!) { subscriptionBillingAttempt(id: $subscriptionBillingAttempt) { id nextActionUrl idempotencyKey ready order { id } subscriptionContract { id } errorMessage errorCode } }\",\n \"variables\": {\n \"subscriptionBillingAttempt\": \"gid://shopify/SubscriptionBillingAttempt/528177103\"\n }\n}'\n", "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n query findBillingAttempt($subscriptionBillingAttempt: ID!) {\n subscriptionBillingAttempt(id: $subscriptionBillingAttempt) {\n id\n nextActionUrl\n idempotencyKey\n ready\n order {\n id\n }\n subscriptionContract {\n id\n }\n errorMessage\n errorCode\n }\n }`,\n {\n variables: {\n \"subscriptionBillingAttempt\": \"gid://shopify/SubscriptionBillingAttempt/528177103\"\n },\n },\n);\n\nconst data = await response.json();\n", "ruby_example": "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n query findBillingAttempt($subscriptionBillingAttempt: ID!) {\n subscriptionBillingAttempt(id: $subscriptionBillingAttempt) {\n id\n nextActionUrl\n idempotencyKey\n ready\n order {\n id\n }\n subscriptionContract {\n id\n }\n errorMessage\n errorCode\n }\n }\nQUERY\n\nvariables = {\n \"subscriptionBillingAttempt\": \"gid://shopify/SubscriptionBillingAttempt/528177103\"\n}\n\nresponse = client.query(query: query, variables: variables)\n", "node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `query findBillingAttempt($subscriptionBillingAttempt: ID!) {\n subscriptionBillingAttempt(id: $subscriptionBillingAttempt) {\n id\n nextActionUrl\n idempotencyKey\n ready\n order {\n id\n }\n subscriptionContract {\n id\n }\n errorMessage\n errorCode\n }\n }`,\n \"variables\": {\n \"subscriptionBillingAttempt\": \"gid://shopify/SubscriptionBillingAttempt/528177103\"\n },\n },\n});\n", "php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n query findBillingAttempt($subscriptionBillingAttempt: ID!) {\n subscriptionBillingAttempt(id: $subscriptionBillingAttempt) {\n id\n nextActionUrl\n idempotencyKey\n ready\n order {\n id\n }\n subscriptionContract {\n id\n }\n errorMessage\n errorCode\n }\n }\nQUERY;\n\n$variables = [\n \"subscriptionBillingAttempt\" => \"gid://shopify/SubscriptionBillingAttempt/528177103\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n" }, "titleStringKey": "arguments", "inputVariableEntries": [] } ]