Anchor to section titled 'undefined'subscription
subscription
query
2024-10latest
Returns a subscription billing cycle found either by cycle index or date.
Anchor to section titled 'Arguments'
Arguments
Input object used to select and use billing cycles.
Was this section helpful?
Anchor to section titled 'SubscriptionBillingCycle possible returns'
SubscriptionBillingCycle possible returns
A subscription billing cycle.
Was this section helpful?
Code examples for QUERY: subscriptionBillingCycle
Query Reference for QUERY: subscriptionBillingCycle
"{\n subscriptionBillingCycle(billingCycleInput) {\n # SubscriptionBillingCycle fields\n }\n}"Input Reference for QUERY: subscriptionBillingCycle
Schema Reference for QUERY: subscriptionBillingCycle
Display Examples for QUERY: subscriptionBillingCycle
[
{
"example": {
"type_name": "subscriptionbillingcycle",
"title": "Get a billing cycle by cycle index",
"description": "Retrieves a billing cycle with cycle index `1` and returns the `billingAttemptExpectedDate`.\n",
"query_string": "query subscriptionBillingCycle($contractId: ID!, $index: Int!) {\n subscriptionBillingCycle(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) {\n billingAttemptExpectedDate\n }\n}",
"variables": {
"contractId": "gid://shopify/SubscriptionContract/593791907",
"index": 1
},
"response": {
"data": {
"subscriptionBillingCycle": {
"billingAttemptExpectedDate": "2022-01-02T11:59:59Z"
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/sales/subscriptions/test/unit/graph_api/admin/subscription_billing_cycle_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 subscriptionBillingCycle($contractId: ID!, $index: Int!) { subscriptionBillingCycle(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) { billingAttemptExpectedDate } }\",\n \"variables\": {\n \"contractId\": \"gid://shopify/SubscriptionContract/593791907\",\n \"index\": 1\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n query subscriptionBillingCycle($contractId: ID!, $index: Int!) {\n subscriptionBillingCycle(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) {\n billingAttemptExpectedDate\n }\n }`,\n {\n variables: {\n \"contractId\": \"gid://shopify/SubscriptionContract/593791907\",\n \"index\": 1\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 subscriptionBillingCycle($contractId: ID!, $index: Int!) {\n subscriptionBillingCycle(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) {\n billingAttemptExpectedDate\n }\n }\nQUERY\n\nvariables = {\n \"contractId\": \"gid://shopify/SubscriptionContract/593791907\",\n \"index\": 1\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 subscriptionBillingCycle($contractId: ID!, $index: Int!) {\n subscriptionBillingCycle(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) {\n billingAttemptExpectedDate\n }\n }`,\n \"variables\": {\n \"contractId\": \"gid://shopify/SubscriptionContract/593791907\",\n \"index\": 1\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 subscriptionBillingCycle($contractId: ID!, $index: Int!) {\n subscriptionBillingCycle(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) {\n billingAttemptExpectedDate\n }\n }\nQUERY;\n\n$variables = [\n \"contractId\" => \"gid://shopify/SubscriptionContract/593791907\",\n \"index\" => 1,\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "arguments",
"inputVariableEntries": []
},
{
"example": {
"type_name": "subscriptionbillingcycle",
"title": "Get a billing cycle by date",
"description": "Retrieves the billing cycle that includes the date `2022-12-01` and returns the `billingAttemptExpectedDate`.\n",
"query_string": "query subscriptionBillingCycle($contractId: ID!, $date: DateTime!) {\n subscriptionBillingCycle(billingCycleInput: {contractId: $contractId, selector: {date: $date}}) {\n billingAttemptExpectedDate\n }\n}",
"variables": {
"contractId": "gid://shopify/SubscriptionContract/593791907",
"date": "2022-12-01T00:00:00Z"
},
"response": {
"data": {
"subscriptionBillingCycle": {
"billingAttemptExpectedDate": "2022-12-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_billing_cycle_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 subscriptionBillingCycle($contractId: ID!, $date: DateTime!) { subscriptionBillingCycle(billingCycleInput: {contractId: $contractId, selector: {date: $date}}) { billingAttemptExpectedDate } }\",\n \"variables\": {\n \"contractId\": \"gid://shopify/SubscriptionContract/593791907\",\n \"date\": \"2022-12-01T00:00:00Z\"\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n query subscriptionBillingCycle($contractId: ID!, $date: DateTime!) {\n subscriptionBillingCycle(billingCycleInput: {contractId: $contractId, selector: {date: $date}}) {\n billingAttemptExpectedDate\n }\n }`,\n {\n variables: {\n \"contractId\": \"gid://shopify/SubscriptionContract/593791907\",\n \"date\": \"2022-12-01T00:00:00Z\"\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 subscriptionBillingCycle($contractId: ID!, $date: DateTime!) {\n subscriptionBillingCycle(billingCycleInput: {contractId: $contractId, selector: {date: $date}}) {\n billingAttemptExpectedDate\n }\n }\nQUERY\n\nvariables = {\n \"contractId\": \"gid://shopify/SubscriptionContract/593791907\",\n \"date\": \"2022-12-01T00:00:00Z\"\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 subscriptionBillingCycle($contractId: ID!, $date: DateTime!) {\n subscriptionBillingCycle(billingCycleInput: {contractId: $contractId, selector: {date: $date}}) {\n billingAttemptExpectedDate\n }\n }`,\n \"variables\": {\n \"contractId\": \"gid://shopify/SubscriptionContract/593791907\",\n \"date\": \"2022-12-01T00:00:00Z\"\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 subscriptionBillingCycle($contractId: ID!, $date: DateTime!) {\n subscriptionBillingCycle(billingCycleInput: {contractId: $contractId, selector: {date: $date}}) {\n billingAttemptExpectedDate\n }\n }\nQUERY;\n\n$variables = [\n \"contractId\" => \"gid://shopify/SubscriptionContract/593791907\",\n \"date\" => \"2022-12-01T00:00:00Z\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "arguments",
"inputVariableEntries": []
}
]