Anchor to section titled 'undefined'subscription
subscription
mutation
2024-04
Requires write access scope. Also: The user must have manage_orders_information permission.
Delete the schedule and contract edits of the selected subscription billing cycle.
Anchor to section titled 'Arguments'
Arguments
Input object used to select and use billing cycles.
Was this section helpful?
Anchor to section titled 'SubscriptionBillingCycleEditDeletePayload returns'
SubscriptionBillingCycleEditDeletePayload returns
The list of updated billing cycles.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: subscriptionBillingCycleEditDelete
Query Reference for MUTATION: subscriptionBillingCycleEditDelete
"mutation subscriptionBillingCycleEditDelete($billingCycleInput: SubscriptionBillingCycleInput!) {\n subscriptionBillingCycleEditDelete(billingCycleInput: $billingCycleInput) {\n billingCycles {\n # SubscriptionBillingCycle fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: subscriptionBillingCycleEditDelete
"{\n \"billingCycleInput\": {\n \"contractId\": \"gid://shopify/<objectName>/10079785100\",\n \"selector\": {\n \"date\": \"2019-09-07T15:50:00Z\",\n \"index\": 1\n }\n }\n}"Schema Reference for MUTATION: subscriptionBillingCycleEditDelete
"input SubscriptionBillingCycleInput {\n contractId: ID!\n selector: SubscriptionBillingCycleSelector!\n}\n\ninput SubscriptionBillingCycleSelector {\n date: DateTime\n index: Int\n}\n"Display Examples for MUTATION: subscriptionBillingCycleEditDelete
[
{
"example": {
"type_name": "subscriptionbillingcycleeditdelete",
"title": "Deletes the edits on a future billing cycle",
"description": "Deletes the schedule and contract edits on the billing cycle with cycle index `1`, and reverts the schedule and contract to the information on the base subscription contract.\n",
"query_string": "mutation subscriptionBillingCycleEditDelete($contractId: ID!, $index: Int!) {\n subscriptionBillingCycleEditDelete(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) {\n billingCycles {\n cycleStartAt\n cycleEndAt\n cycleIndex\n }\n userErrors {\n field\n message\n }\n }\n}",
"variables": {
"contractId": "gid://shopify/SubscriptionContract/398475269",
"index": 1
},
"response": {
"data": {
"subscriptionBillingCycleEditDelete": {
"billingCycles": [
{
"cycleStartAt": "2021-12-15T15:33:01Z",
"cycleEndAt": "2022-01-01T12:00:00Z",
"cycleIndex": 1
}
],
"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_edit_delete_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation subscriptionBillingCycleEditDelete($contractId: ID!, $index: Int!) { subscriptionBillingCycleEditDelete(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) { billingCycles { cycleStartAt cycleEndAt cycleIndex } 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 subscriptionBillingCycleEditDelete($contractId: ID!, $index: Int!) {\n subscriptionBillingCycleEditDelete(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) {\n billingCycles {\n cycleStartAt\n cycleEndAt\n cycleIndex\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 subscriptionBillingCycleEditDelete($contractId: ID!, $index: Int!) {\n subscriptionBillingCycleEditDelete(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) {\n billingCycles {\n cycleStartAt\n cycleEndAt\n cycleIndex\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 subscriptionBillingCycleEditDelete($contractId: ID!, $index: Int!) {\n subscriptionBillingCycleEditDelete(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) {\n billingCycles {\n cycleStartAt\n cycleEndAt\n cycleIndex\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 subscriptionBillingCycleEditDelete($contractId: ID!, $index: Int!) {\n subscriptionBillingCycleEditDelete(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) {\n billingCycles {\n cycleStartAt\n cycleEndAt\n cycleIndex\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": []
}
]