subscriptionBillingCycleEditsDelete - admin-graphql - MUTATION

Version: 2024-10

Description:

Delete the current and future schedule and contract edits of a list of subscription billing cycles.

Access Scopes

`write_own_subscription_contracts` access scope. Also: The user must have manage_orders_information permission.

Arguments

• contractId: ID! - The globally-unique identifier of the subscription contract that the billing cycle belongs to.
• targetSelection: SubscriptionBillingCyclesTargetSelection! - Select billing cycles to be deleted.

Returns

• billingCycles: SubscriptionBillingCycle The list of updated billing cycles.
• userErrors: SubscriptionBillingCycleUserError! The list of errors that occurred from executing the mutation.

Examples

• Delete the edits on the current and all future billing cycles

          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\": \"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"
          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"
          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"
          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"
          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"
          Graphql 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}"
        

  input: {
    "contractId": "gid://shopify/SubscriptionContract/398475269"
  }

  response: {
    "data": {
      "subscriptionBillingCycleEditsDelete": {
        "billingCycles": [
          {
            "cycleStartAt": "2021-12-15T15:33:01Z",
            "cycleEndAt": "2022-01-01T12:00:00Z",
            "cycleIndex": 1
          }
        ],
        "userErrors": []
      }
    }
  }