Anchor to section titled 'undefined'subscription
subscription
mutation
2024-07
Requires write access scope. Also: The user must have manage_orders_information permission.
Delete the current and future schedule and contract edits of a list of subscription billing cycles.
Anchor to section titled 'Arguments'
Arguments
The globally-unique identifier of the subscription contract that the billing cycle belongs to.
Select billing cycles to be deleted.
Was this section helpful?
Anchor to section titled 'SubscriptionBillingCycleEditsDeletePayload returns'
SubscriptionBillingCycleEditsDeletePayload 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: subscriptionBillingCycleEditsDelete
Query Reference for MUTATION: subscriptionBillingCycleEditsDelete
"mutation subscriptionBillingCycleEditsDelete($contractId: ID!, $targetSelection: SubscriptionBillingCyclesTargetSelection!) {\n subscriptionBillingCycleEditsDelete(contractId: $contractId, targetSelection: $targetSelection) {\n billingCycles {\n # SubscriptionBillingCycle fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: subscriptionBillingCycleEditsDelete
"{\n \"contractId\": \"gid://shopify/<objectName>/10079785100\",\n \"targetSelection\": \"ALL\"\n}"Schema Reference for MUTATION: subscriptionBillingCycleEditsDelete
""
Display Examples for MUTATION: subscriptionBillingCycleEditsDelete
[
{
"example": {
"type_name": "subscriptionbillingcycleeditsdelete",
"title": "Delete the edits on the current and all future billing cycles",
"description": "Deletes the schedule and contract edits on the current and all future billing cycles, and reverts the schedule and contract to the information on the base subscription contract.\n",
"query_string": "mutation subscriptionBillingCycleEditsDelete($contractId: ID!) {\n subscriptionBillingCycleEditsDelete(contractId: $contractId, targetSelection: ALL) {\n billingCycles {\n cycleStartAt\n cycleEndAt\n cycleIndex\n }\n userErrors {\n field\n message\n }\n }\n}",
"variables": {
"contractId": "gid://shopify/SubscriptionContract/398475269"
},
"response": {
"data": {
"subscriptionBillingCycleEditsDelete": {
"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_edits_delete_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 subscriptionBillingCycleEditsDelete($contractId: ID!) { subscriptionBillingCycleEditsDelete(contractId: $contractId, targetSelection: ALL) { billingCycles { cycleStartAt cycleEndAt cycleIndex } userErrors { field message } } }\",\n \"variables\": {\n \"contractId\": \"gid://shopify/SubscriptionContract/398475269\"\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation subscriptionBillingCycleEditsDelete($contractId: ID!) {\n subscriptionBillingCycleEditsDelete(contractId: $contractId, targetSelection: ALL) {\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 },\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 subscriptionBillingCycleEditsDelete($contractId: ID!) {\n subscriptionBillingCycleEditsDelete(contractId: $contractId, targetSelection: ALL) {\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}\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 subscriptionBillingCycleEditsDelete($contractId: ID!) {\n subscriptionBillingCycleEditsDelete(contractId: $contractId, targetSelection: ALL) {\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 },\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 subscriptionBillingCycleEditsDelete($contractId: ID!) {\n subscriptionBillingCycleEditsDelete(contractId: $contractId, targetSelection: ALL) {\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];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "contractId",
"description": "The globally-unique identifier of the subscription contract that the billing cycle belongs to.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "contractId",
"argValue": " \"gid://shopify/SubscriptionContract/398475269\"",
"typeKind": "MUTATION"
}
]
}
]