subscriptionBillingCycleBulkSearch
mutation

Choose a version:

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

Asynchronously queries all subscription billing cycles whose billingAttemptExpectedDate values fall within a specified date range and meet additional filtering criteria. The results of this action can be retrieved using the subscriptionBillingCycleBulkResults query.

Anchor to section titled 'Arguments'

Arguments

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

Was this section helpful?

Anchor to section titled 'SubscriptionBillingCycleBulkSearchPayload returns'

SubscriptionBillingCycleBulkSearchPayload returns

Anchor to SubscriptionBillingCycleBulkSearchPayload.job job Job: The asynchronous job that performs the action on the targeted billing cycles.
Anchor to SubscriptionBillingCycleBulkSearchPayload.userErrors userErrors [SubscriptionBillingCycleBulkUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: subscriptionBillingCycleBulkSearch

Query Reference for MUTATION: subscriptionBillingCycleBulkSearch

"mutation subscriptionBillingCycleBulkSearch($billingAttemptExpectedDateRange: SubscriptionBillingCyclesDateRangeSelector!) {\n  subscriptionBillingCycleBulkSearch(billingAttemptExpectedDateRange: $billingAttemptExpectedDateRange) {\n    job {\n      # Job fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: subscriptionBillingCycleBulkSearch

"{\n  \"billingAttemptExpectedDateRange\": {\n    \"endDate\": \"2019-09-07T15:50:00Z\",\n    \"startDate\": \"2019-09-07T15:50:00Z\"\n  },\n  \"filters\": {\n    \"billingAttemptStatus\": \"ANY\",\n    \"billingCycleStatus\": [\n      \"BILLED\"\n    ],\n    \"contractStatus\": [\n      \"ACTIVE\"\n    ]\n  }\n}"

Schema Reference for MUTATION: subscriptionBillingCycleBulkSearch

"input SubscriptionBillingCyclesDateRangeSelector {\n  endDate: DateTime!\n  startDate: DateTime!\n}\n\ninput SubscriptionBillingCycleBulkFilters {\n  billingAttemptStatus: SubscriptionBillingCycleBillingAttemptStatus\n  billingCycleStatus: [SubscriptionBillingCycleBillingCycleStatus!]\n  contractStatus: [SubscriptionContractSubscriptionStatus!]\n}\n"

Display Examples for MUTATION: subscriptionBillingCycleBulkSearch

[
  {
    "example": {
      "type_name": "subscriptionbillingcyclebulksearch",
      "title": "Create a job to search for all subscription billing cycles in time range",
      "description": "Creates a job to search for all subscription billing cycles in time range between 2023-02-01 and 2023-02-02.\n",
      "query_string": "mutation($startDate: DateTime!, $endDate: DateTime!) {\n  subscriptionBillingCycleBulkSearch(billingAttemptExpectedDateRange: {startDate: $startDate, endDate: $endDate}) {\n    job {\n      id\n    }\n  }\n}",
      "variables": {
        "startDate": "2023-02-01T00:00:00-05:00",
        "endDate": "2023-02-02T23:59:59-05:00"
      },
      "response": {
        "data": {
          "subscriptionBillingCycleBulkSearch": {
            "job": {
              "id": "gid://shopify/Job/ea4e2f15-8508-4930-8de5-0e31c8b7014e"
            }
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2024-07",
      "maximum_api_version": "unstable",
      "location": "/components/sales/subscriptions/test/unit/graph_api/admin/mutations/subscription_billing_cycle_bulk_search_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\": \"mutation($startDate: DateTime!, $endDate: DateTime!) { subscriptionBillingCycleBulkSearch(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",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation($startDate: DateTime!, $endDate: DateTime!) {\n    subscriptionBillingCycleBulkSearch(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",
      "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    subscriptionBillingCycleBulkSearch(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",
      "node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation($startDate: DateTime!, $endDate: DateTime!) {\n      subscriptionBillingCycleBulkSearch(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",
      "php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation($startDate: DateTime!, $endDate: DateTime!) {\n    subscriptionBillingCycleBulkSearch(billingAttemptExpectedDateRange: {startDate: $startDate, endDate: $endDate}) {\n      job {\n        id\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"startDate\" => \"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"
    },
    "titleStringKey": "variables",
    "inputVariableEntries": []
  }
]

subscriptionBillingCycleBulkSearchmutation

Arguments

SubscriptionBillingCycleBulkSearchPayload returns

subscriptionBillingCycleBulkSearch
mutation