Anchor to section titled 'undefined'subscription
subscription
mutation
2024-07
Requires write access scope. Also: The user must have manage_orders_information permission.
Modify the schedule of a specific billing cycle.
Anchor to section titled 'Arguments'
Arguments
Input object for selecting and using billing cycles.
Data used to create or modify billing cycle schedule edit.
Was this section helpful?
Anchor to section titled 'SubscriptionBillingCycleScheduleEditPayload returns'
SubscriptionBillingCycleScheduleEditPayload returns
The updated billing cycle.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: subscriptionBillingCycleScheduleEdit
Query Reference for MUTATION: subscriptionBillingCycleScheduleEdit
"mutation subscriptionBillingCycleScheduleEdit($billingCycleInput: SubscriptionBillingCycleInput!, $input: SubscriptionBillingCycleScheduleEditInput!) {\n subscriptionBillingCycleScheduleEdit(billingCycleInput: $billingCycleInput, input: $input) {\n billingCycle {\n # SubscriptionBillingCycle fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: subscriptionBillingCycleScheduleEdit
"{\n \"billingCycleInput\": {\n \"contractId\": \"gid://shopify/<objectName>/10079785100\",\n \"selector\": {\n \"date\": \"2019-09-07T15:50:00Z\",\n \"index\": 1\n }\n },\n \"input\": {\n \"billingDate\": \"2019-09-07T15:50:00Z\",\n \"reason\": \"BUYER_INITIATED\",\n \"skip\": true\n }\n}"Schema Reference for MUTATION: subscriptionBillingCycleScheduleEdit
"input SubscriptionBillingCycleInput {\n contractId: ID!\n selector: SubscriptionBillingCycleSelector!\n}\n\ninput SubscriptionBillingCycleSelector {\n date: DateTime\n index: Int\n}\n\ninput SubscriptionBillingCycleScheduleEditInput {\n billingDate: DateTime\n reason: SubscriptionBillingCycleScheduleEditInputScheduleEditReason!\n skip: Boolean\n}\n"Display Examples for MUTATION: subscriptionBillingCycleScheduleEdit
[
{
"example": {
"type_name": "subscriptionbillingcyclescheduleedit",
"title": "Change the billing date of a cycle",
"description": "Changes the `billingAttemptExpectedDate` for the specified cycle.\n",
"query_string": "mutation subscriptionBillingCycleScheduleEdit($contractId: ID!, $index: Int!, $date: DateTime!) {\n subscriptionBillingCycleScheduleEdit(billingCycleInput: {contractId: $contractId, selector: {index: $index}}, input: {billingDate: $date, reason: BUYER_INITIATED}) {\n billingCycle {\n cycleIndex\n billingAttemptExpectedDate\n }\n userErrors {\n field\n message\n }\n }\n}",
"variables": {
"contractId": "gid://shopify/SubscriptionContract/398475269",
"index": 1,
"date": "2021-12-31T07:00:00-05:00"
},
"response": {
"data": {
"subscriptionBillingCycleScheduleEdit": {
"billingCycle": {
"cycleIndex": 1,
"billingAttemptExpectedDate": "2021-12-31T12:00:00Z"
},
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/sales/subscriptions/test/unit/graph_api/admin/mutations/subscription_billing_cycle_schedule_edit_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation subscriptionBillingCycleScheduleEdit($contractId: ID!, $index: Int!, $date: DateTime!) { subscriptionBillingCycleScheduleEdit(billingCycleInput: {contractId: $contractId, selector: {index: $index}}, input: {billingDate: $date, reason: BUYER_INITIATED}) { billingCycle { cycleIndex billingAttemptExpectedDate } userErrors { field message } } }\",\n \"variables\": {\n \"contractId\": \"gid://shopify/SubscriptionContract/398475269\",\n \"index\": 1,\n \"date\": \"2021-12-31T07:00:00-05:00\"\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation subscriptionBillingCycleScheduleEdit($contractId: ID!, $index: Int!, $date: DateTime!) {\n subscriptionBillingCycleScheduleEdit(billingCycleInput: {contractId: $contractId, selector: {index: $index}}, input: {billingDate: $date, reason: BUYER_INITIATED}) {\n billingCycle {\n cycleIndex\n billingAttemptExpectedDate\n }\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"contractId\": \"gid://shopify/SubscriptionContract/398475269\",\n \"index\": 1,\n \"date\": \"2021-12-31T07:00:00-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 subscriptionBillingCycleScheduleEdit($contractId: ID!, $index: Int!, $date: DateTime!) {\n subscriptionBillingCycleScheduleEdit(billingCycleInput: {contractId: $contractId, selector: {index: $index}}, input: {billingDate: $date, reason: BUYER_INITIATED}) {\n billingCycle {\n cycleIndex\n billingAttemptExpectedDate\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"contractId\": \"gid://shopify/SubscriptionContract/398475269\",\n \"index\": 1,\n \"date\": \"2021-12-31T07:00:00-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 subscriptionBillingCycleScheduleEdit($contractId: ID!, $index: Int!, $date: DateTime!) {\n subscriptionBillingCycleScheduleEdit(billingCycleInput: {contractId: $contractId, selector: {index: $index}}, input: {billingDate: $date, reason: BUYER_INITIATED}) {\n billingCycle {\n cycleIndex\n billingAttemptExpectedDate\n }\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"contractId\": \"gid://shopify/SubscriptionContract/398475269\",\n \"index\": 1,\n \"date\": \"2021-12-31T07:00:00-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 subscriptionBillingCycleScheduleEdit($contractId: ID!, $index: Int!, $date: DateTime!) {\n subscriptionBillingCycleScheduleEdit(billingCycleInput: {contractId: $contractId, selector: {index: $index}}, input: {billingDate: $date, reason: BUYER_INITIATED}) {\n billingCycle {\n cycleIndex\n billingAttemptExpectedDate\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"contractId\" => \"gid://shopify/SubscriptionContract/398475269\",\n \"index\" => 1,\n \"date\" => \"2021-12-31T07:00:00-05:00\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": []
},
{
"example": {
"type_name": "subscriptionbillingcyclescheduleedit",
"title": "Skip a cycle",
"description": "Skips the billing and delivery for the billing cycle with cycle index `1`. The reason that is given for the skip is a customer request.\n",
"query_string": "mutation subscriptionBillingCycleScheduleEdit($contractId: ID!, $index: Int!) {\n subscriptionBillingCycleScheduleEdit(billingCycleInput: {contractId: $contractId, selector: {index: $index}}, input: {skip: true, reason: BUYER_INITIATED}) {\n billingCycle {\n cycleIndex\n skipped\n }\n userErrors {\n field\n message\n }\n }\n}",
"variables": {
"contractId": "gid://shopify/SubscriptionContract/398475269",
"index": 1
},
"response": {
"data": {
"subscriptionBillingCycleScheduleEdit": {
"billingCycle": {
"cycleIndex": 1,
"skipped": true
},
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/sales/subscriptions/test/unit/graph_api/admin/mutations/subscription_billing_cycle_schedule_edit_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation subscriptionBillingCycleScheduleEdit($contractId: ID!, $index: Int!) { subscriptionBillingCycleScheduleEdit(billingCycleInput: {contractId: $contractId, selector: {index: $index}}, input: {skip: true, reason: BUYER_INITIATED}) { billingCycle { cycleIndex skipped } userErrors { field message } } }\",\n \"variables\": {\n \"contractId\": \"gid://shopify/SubscriptionContract/398475269\",\n \"index\": 1\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation subscriptionBillingCycleScheduleEdit($contractId: ID!, $index: Int!) {\n subscriptionBillingCycleScheduleEdit(billingCycleInput: {contractId: $contractId, selector: {index: $index}}, input: {skip: true, reason: BUYER_INITIATED}) {\n billingCycle {\n cycleIndex\n skipped\n }\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"contractId\": \"gid://shopify/SubscriptionContract/398475269\",\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 mutation subscriptionBillingCycleScheduleEdit($contractId: ID!, $index: Int!) {\n subscriptionBillingCycleScheduleEdit(billingCycleInput: {contractId: $contractId, selector: {index: $index}}, input: {skip: true, reason: BUYER_INITIATED}) {\n billingCycle {\n cycleIndex\n skipped\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"contractId\": \"gid://shopify/SubscriptionContract/398475269\",\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\": `mutation subscriptionBillingCycleScheduleEdit($contractId: ID!, $index: Int!) {\n subscriptionBillingCycleScheduleEdit(billingCycleInput: {contractId: $contractId, selector: {index: $index}}, input: {skip: true, reason: BUYER_INITIATED}) {\n billingCycle {\n cycleIndex\n skipped\n }\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"contractId\": \"gid://shopify/SubscriptionContract/398475269\",\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 mutation subscriptionBillingCycleScheduleEdit($contractId: ID!, $index: Int!) {\n subscriptionBillingCycleScheduleEdit(billingCycleInput: {contractId: $contractId, selector: {index: $index}}, input: {skip: true, reason: BUYER_INITIATED}) {\n billingCycle {\n cycleIndex\n skipped\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"contractId\" => \"gid://shopify/SubscriptionContract/398475269\",\n \"index\" => 1,\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": []
}
]