subscriptionBillingCycles
query

Choose a version:

Returns subscription billing cycles for a contract ID.

Anchor to section titled 'SubscriptionBillingCycleConnection arguments'

SubscriptionBillingCycleConnection arguments
SubscriptionBillingCycleConnection!

Anchor to after after String: The elements that come after the specified cursor.
Anchor to before before String: The elements that come before the specified cursor.
Anchor to billingCyclesDateRangeSelector billingCyclesDateRangeSelector SubscriptionBillingCyclesDateRangeSelector: Select subscription billing cycles within a date range.
Anchor to billingCyclesIndexRangeSelector billingCyclesIndexRangeSelector SubscriptionBillingCyclesIndexRangeSelector: Select subscription billing cycles within an index range.
Anchor to contractId contractId ID! required: The ID of the subscription contract to retrieve billing cycles for.
Anchor to first first Int: The first n elements from the paginated list.
Anchor to last last Int: The last n elements from the paginated list.
Anchor to reverse reverse Boolean default:false: Reverse the order of the underlying list.
Anchor to sortKey sortKey SubscriptionBillingCyclesSortKeys default:CYCLE_INDEX: Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Was this section helpful?

Anchor to section titled 'SubscriptionBillingCycleConnection possible returns'

SubscriptionBillingCycleConnection possible returns

Anchor to SubscriptionBillingCycleConnection.edges edges [SubscriptionBillingCycleEdge!]! non-null: The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
Anchor to SubscriptionBillingCycleConnection.nodes nodes [SubscriptionBillingCycle!]! non-null: A list of nodes that are contained in SubscriptionBillingCycleEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.
Anchor to SubscriptionBillingCycleConnection.pageInfo pageInfo PageInfo! non-null: An object that’s used to retrieve cursor information about the current page.

Was this section helpful?

Code examples for QUERY: subscriptionBillingCycles

Query Reference for QUERY: subscriptionBillingCycles

"{\n  subscriptionBillingCycles(contractId) {\n    # SubscriptionBillingCycleConnection fields\n  }\n}"

Input Reference for QUERY: subscriptionBillingCycles

Schema Reference for QUERY: subscriptionBillingCycles

Display Examples for QUERY: subscriptionBillingCycles

[
  {
    "example": {
      "type_name": "subscriptionbillingcycles",
      "title": "Get the billing cycles between specific dates",
      "description": "Retrieves the billing cycles from `2022-12-15` to `2023-02-15` and returns their `billingAttemptExpectedDate`.\n",
      "query_string": "query subscriptionBillingCycles($contractId: ID!) {\n  subscriptionBillingCycles(first: 10, contractId: $contractId, billingCyclesDateRangeSelector: {startDate: \"2022-12-15T00:00:00Z\", endDate: \"2023-02-15T00:00:00Z\"}) {\n    edges {\n      node {\n        billingAttemptExpectedDate\n      }\n    }\n  }\n}",
      "variables": {
        "contractId": "gid://shopify/SubscriptionContract/593791907"
      },
      "response": {
        "data": {
          "subscriptionBillingCycles": {
            "edges": [
              {
                "node": {
                  "billingAttemptExpectedDate": "2023-01-02T01:00:00Z"
                }
              },
              {
                "node": {
                  "billingAttemptExpectedDate": "2023-02-02T01:00:00Z"
                }
              },
              {
                "node": {
                  "billingAttemptExpectedDate": "2023-03-02T01:00:00Z"
                }
              }
            ]
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2023-10",
      "maximum_api_version": "unstable",
      "location": "/components/sales/subscriptions/test/unit/graph_api/admin/subscription_contract_billing_cycles_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 subscriptionBillingCycles($contractId: ID!) { subscriptionBillingCycles(first: 10, contractId: $contractId, billingCyclesDateRangeSelector: {startDate: \\\"2022-12-15T00:00:00Z\\\", endDate: \\\"2023-02-15T00:00:00Z\\\"}) { edges { node { billingAttemptExpectedDate } } } }\",\n \"variables\": {\n    \"contractId\": \"gid://shopify/SubscriptionContract/593791907\"\n  }\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query subscriptionBillingCycles($contractId: ID!) {\n    subscriptionBillingCycles(first: 10, contractId: $contractId, billingCyclesDateRangeSelector: {startDate: \"2022-12-15T00:00:00Z\", endDate: \"2023-02-15T00:00:00Z\"}) {\n      edges {\n        node {\n          billingAttemptExpectedDate\n        }\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"contractId\": \"gid://shopify/SubscriptionContract/593791907\"\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 subscriptionBillingCycles($contractId: ID!) {\n    subscriptionBillingCycles(first: 10, contractId: $contractId, billingCyclesDateRangeSelector: {startDate: \"2022-12-15T00:00:00Z\", endDate: \"2023-02-15T00:00:00Z\"}) {\n      edges {\n        node {\n          billingAttemptExpectedDate\n        }\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"contractId\": \"gid://shopify/SubscriptionContract/593791907\"\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 subscriptionBillingCycles($contractId: ID!) {\n      subscriptionBillingCycles(first: 10, contractId: $contractId, billingCyclesDateRangeSelector: {startDate: \"2022-12-15T00:00:00Z\", endDate: \"2023-02-15T00:00:00Z\"}) {\n        edges {\n          node {\n            billingAttemptExpectedDate\n          }\n        }\n      }\n    }`,\n    \"variables\": {\n      \"contractId\": \"gid://shopify/SubscriptionContract/593791907\"\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 subscriptionBillingCycles($contractId: ID!) {\n    subscriptionBillingCycles(first: 10, contractId: $contractId, billingCyclesDateRangeSelector: {startDate: \"2022-12-15T00:00:00Z\", endDate: \"2023-02-15T00:00:00Z\"}) {\n      edges {\n        node {\n          billingAttemptExpectedDate\n        }\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"contractId\" => \"gid://shopify/SubscriptionContract/593791907\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
    },
    "titleStringKey": "arguments",
    "inputVariableEntries": []
  },
  {
    "example": {
      "type_name": "subscriptionbillingcycles",
      "title": "Get the billing cycles between specific indexes",
      "description": "Retrieves the billing cycles from cycle indexes `1` to `3` and returns their `billingAttemptExpectedDate`.\n",
      "query_string": "query subscriptionBillingCycles($contractId: ID!) {\n  subscriptionBillingCycles(first: 10, contractId: $contractId, billingCyclesIndexRangeSelector: {startIndex: 1, endIndex: 3}) {\n    edges {\n      node {\n        billingAttemptExpectedDate\n      }\n    }\n  }\n}",
      "variables": {
        "contractId": "gid://shopify/SubscriptionContract/593791907"
      },
      "response": {
        "data": {
          "subscriptionBillingCycles": {
            "edges": [
              {
                "node": {
                  "billingAttemptExpectedDate": "2022-01-02T11:59:59Z"
                }
              },
              {
                "node": {
                  "billingAttemptExpectedDate": "2020-11-25T15:00:00Z"
                }
              },
              {
                "node": {
                  "billingAttemptExpectedDate": "2022-03-01T00:00:00Z"
                }
              }
            ]
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2023-10",
      "maximum_api_version": "unstable",
      "location": "/components/sales/subscriptions/test/unit/graph_api/admin/subscription_contract_billing_cycles_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 subscriptionBillingCycles($contractId: ID!) { subscriptionBillingCycles(first: 10, contractId: $contractId, billingCyclesIndexRangeSelector: {startIndex: 1, endIndex: 3}) { edges { node { billingAttemptExpectedDate } } } }\",\n \"variables\": {\n    \"contractId\": \"gid://shopify/SubscriptionContract/593791907\"\n  }\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query subscriptionBillingCycles($contractId: ID!) {\n    subscriptionBillingCycles(first: 10, contractId: $contractId, billingCyclesIndexRangeSelector: {startIndex: 1, endIndex: 3}) {\n      edges {\n        node {\n          billingAttemptExpectedDate\n        }\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"contractId\": \"gid://shopify/SubscriptionContract/593791907\"\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 subscriptionBillingCycles($contractId: ID!) {\n    subscriptionBillingCycles(first: 10, contractId: $contractId, billingCyclesIndexRangeSelector: {startIndex: 1, endIndex: 3}) {\n      edges {\n        node {\n          billingAttemptExpectedDate\n        }\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"contractId\": \"gid://shopify/SubscriptionContract/593791907\"\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 subscriptionBillingCycles($contractId: ID!) {\n      subscriptionBillingCycles(first: 10, contractId: $contractId, billingCyclesIndexRangeSelector: {startIndex: 1, endIndex: 3}) {\n        edges {\n          node {\n            billingAttemptExpectedDate\n          }\n        }\n      }\n    }`,\n    \"variables\": {\n      \"contractId\": \"gid://shopify/SubscriptionContract/593791907\"\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 subscriptionBillingCycles($contractId: ID!) {\n    subscriptionBillingCycles(first: 10, contractId: $contractId, billingCyclesIndexRangeSelector: {startIndex: 1, endIndex: 3}) {\n      edges {\n        node {\n          billingAttemptExpectedDate\n        }\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"contractId\" => \"gid://shopify/SubscriptionContract/593791907\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
    },
    "titleStringKey": "arguments",
    "inputVariableEntries": []
  }
]

subscriptionBillingCyclesquery

SubscriptionBillingCycleConnection argumentsSubscriptionBillingCycleConnection!

SubscriptionBillingCycleConnection possible returns

subscriptionBillingCycles
query

SubscriptionBillingCycleConnection arguments
SubscriptionBillingCycleConnection!