# subscriptionBillingAttemptCreate - admin-graphql - MUTATION Version: 2024-10 ## Description Creates a new subscription billing attempt. For more information, refer to [Create a subscription contract](https://shopify.dev/docs/apps/selling-strategies/subscriptions/contracts/create#step-4-create-a-billing-attempt). ### Access Scopes `write_own_subscription_contracts` access scope. Also: The user must have manage_orders_information permission. ## Arguments * [subscriptionBillingAttemptInput](/docs/api/admin-graphql/2024-10/input-objects/SubscriptionBillingAttemptInput): SubscriptionBillingAttemptInput! - The information to apply as a billing attempt. * [subscriptionContractId](/docs/api/admin-graphql/2024-10/scalars/ID): ID! - The ID of the subscription contract. ## Returns * [subscriptionBillingAttempt](/docs/api/admin-graphql/2024-10/objects/SubscriptionBillingAttempt): SubscriptionBillingAttempt The subscription billing attempt. * [userErrors](/docs/api/admin-graphql/2024-10/objects/BillingAttemptUserError): BillingAttemptUserError! The list of errors that occurred from executing the mutation. ## Examples ### Create a billing attempt on a specific billing cycle 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\": \"mutation subscriptionBillingAttemptCreate($contractId: ID!, $index: Int!) { subscriptionBillingAttemptCreate(subscriptionContractId: $contractId, subscriptionBillingAttemptInput: {billingCycleSelector: {index: $index}, idempotencyKey: \\\"aaa-bbb-ccc\\\", originTime: \\\"2020-10-01T10:00:00Z\\\"}) { subscriptionBillingAttempt { id ready } userErrors { field message } } }\",\n \"variables\": {\n \"contractId\": \"gid://shopify/SubscriptionContract/593791907\",\n \"index\": 1\n }\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation subscriptionBillingAttemptCreate($contractId: ID!, $index: Int!) {\n subscriptionBillingAttemptCreate(subscriptionContractId: $contractId, subscriptionBillingAttemptInput: {billingCycleSelector: {index: $index}, idempotencyKey: \"aaa-bbb-ccc\", originTime: \"2020-10-01T10:00:00Z\"}) {\n subscriptionBillingAttempt {\n id\n ready\n }\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"contractId\": \"gid://shopify/SubscriptionContract/593791907\",\n \"index\": 1\n },\n },\n});\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 mutation subscriptionBillingAttemptCreate($contractId: ID!, $index: Int!) {\n subscriptionBillingAttemptCreate(subscriptionContractId: $contractId, subscriptionBillingAttemptInput: {billingCycleSelector: {index: $index}, idempotencyKey: \"aaa-bbb-ccc\", originTime: \"2020-10-01T10:00:00Z\"}) {\n subscriptionBillingAttempt {\n id\n ready\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"contractId\": \"gid://shopify/SubscriptionContract/593791907\",\n \"index\": 1\n}\n\nresponse = client.query(query: query, variables: variables)\n" Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation subscriptionBillingAttemptCreate($contractId: ID!, $index: Int!) {\n subscriptionBillingAttemptCreate(subscriptionContractId: $contractId, subscriptionBillingAttemptInput: {billingCycleSelector: {index: $index}, idempotencyKey: \"aaa-bbb-ccc\", originTime: \"2020-10-01T10:00:00Z\"}) {\n subscriptionBillingAttempt {\n id\n ready\n }\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"contractId\": \"gid://shopify/SubscriptionContract/593791907\",\n \"index\": 1\n },\n },\n);\n\nconst data = await response.json();\n" Graphql query: "mutation subscriptionBillingAttemptCreate($contractId: ID!, $index: Int!) {\n subscriptionBillingAttemptCreate(subscriptionContractId: $contractId, subscriptionBillingAttemptInput: {billingCycleSelector: {index: $index}, idempotencyKey: \"aaa-bbb-ccc\", originTime: \"2020-10-01T10:00:00Z\"}) {\n subscriptionBillingAttempt {\n id\n ready\n }\n userErrors {\n field\n message\n }\n }\n}" #### Graphql Input { "contractId": "gid://shopify/SubscriptionContract/593791907", "index": 1 } #### Graphql Response { "data": { "subscriptionBillingAttemptCreate": { "subscriptionBillingAttempt": { "id": "gid://shopify/SubscriptionBillingAttempt/528177097", "ready": false }, "userErrors": [] } } }