subscriptionBillingCycleBulkCharge - admin-graphql - MUTATION

Version: 2024-10

Description:

Asynchronously queries and charges all subscription billing cycles whose [billingAttemptExpectedDate](https://shopify.dev/api/admin-graphql/latest/objects/SubscriptionBillingCycle#field-billingattemptexpecteddate) values fall within a specified date range and meet additional filtering criteria. The results of this action can be retrieved using the [subscriptionBillingCycleBulkResults](https://shopify.dev/api/admin-graphql/latest/queries/subscriptionBillingCycleBulkResults) query.

Access Scopes

`write_own_subscription_contracts` access scope. Also: The user must have manage_orders_information permission.

Arguments

• billingAttemptExpectedDateRange: SubscriptionBillingCyclesDateRangeSelector! - Specifies the date range within which the `billingAttemptExpectedDate` values of the billing cycles should fall.
• filters: SubscriptionBillingCycleBulkFilters - Criteria to filter the billing cycles on which the action is executed.

Returns

• job: Job The asynchronous job that performs the action on the targeted billing cycles.
• userErrors: SubscriptionBillingCycleBulkUserError! The list of errors that occurred from executing the mutation.

Examples

• Create a job to charge all subscription billing cycles in time range

          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($startDate: DateTime!, $endDate: DateTime!) { subscriptionBillingCycleBulkCharge(billingAttemptExpectedDateRange: {startDate: $startDate, endDate: $endDate}) { job { id } } }\",\n \"variables\": {\n    \"startDate\": \"2023-02-01T00:00:00-05:00\",\n    \"endDate\": \"2023-02-02T23:59:59-05:00\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation($startDate: DateTime!, $endDate: DateTime!) {\n      subscriptionBillingCycleBulkCharge(billingAttemptExpectedDateRange: {startDate: $startDate, endDate: $endDate}) {\n        job {\n          id\n        }\n      }\n    }`,\n    \"variables\": {\n      \"startDate\": \"2023-02-01T00:00:00-05:00\",\n      \"endDate\": \"2023-02-02T23:59:59-05:00\"\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($startDate: DateTime!, $endDate: DateTime!) {\n    subscriptionBillingCycleBulkCharge(billingAttemptExpectedDateRange: {startDate: $startDate, endDate: $endDate}) {\n      job {\n        id\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"startDate\": \"2023-02-01T00:00:00-05:00\",\n  \"endDate\": \"2023-02-02T23:59:59-05:00\"\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = << \"2023-02-01T00:00:00-05:00\",\n  \"endDate\" => \"2023-02-02T23:59:59-05:00\",\n];\n\n$response = $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($startDate: DateTime!, $endDate: DateTime!) {\n    subscriptionBillingCycleBulkCharge(billingAttemptExpectedDateRange: {startDate: $startDate, endDate: $endDate}) {\n      job {\n        id\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"startDate\": \"2023-02-01T00:00:00-05:00\",\n      \"endDate\": \"2023-02-02T23:59:59-05:00\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation($startDate: DateTime!, $endDate: DateTime!) {\n  subscriptionBillingCycleBulkCharge(billingAttemptExpectedDateRange: {startDate: $startDate, endDate: $endDate}) {\n    job {\n      id\n    }\n  }\n}"
        

  input: {
    "startDate": "2023-02-01T00:00:00-05:00",
    "endDate": "2023-02-02T23:59:59-05:00"
  }

  response: {
    "data": {
      "subscriptionBillingCycleBulkCharge": {
        "job": {
          "id": "gid://shopify/Job/99ff28fc-980d-48ef-a190-1a1973fb5ed3"
        }
      }
    }
  }