Choose a version:

Anchor to subscriptionBillingCycleEditsDelete

subscriptionBillingCycleEditsDelete

mutation

Requires write_own_subscription_contracts 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 Arguments

Arguments

Anchor to contractIdcontractId

•ID!

required

The globally-unique identifier of the subscription contract that the billing cycle belongs to.

Anchor to targetSelectiontargetSelection

•SubscriptionBillingCyclesTargetSelection!

required

Select billing cycles to be deleted.

Show enum values

Was this section helpful?

Anchor to SubscriptionBillingCycleEditsDeletePayload returnsSubscriptionBillingCycleEditsDeletePayload returns

Anchor to billingCyclesbillingCycles •[SubscriptionBillingCycle!]: The list of updated billing cycles.

Show fields
Anchor to userErrorsuserErrors •[SubscriptionBillingCycleUserError!]! non-null: The list of errors that occurred from executing the mutation.

Show fields

Was this section helpful?

Examples

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.

Query

mutation subscriptionBillingCycleEditsDelete($contractId: ID!) {
  subscriptionBillingCycleEditsDelete(contractId: $contractId, targetSelection: ALL) {
    billingCycles {
      cycleStartAt
      cycleEndAt
      cycleIndex
    }
    userErrors {
      field
      message
    }
  }
}

Variables

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

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation subscriptionBillingCycleEditsDelete($contractId: ID!) { subscriptionBillingCycleEditsDelete(contractId: $contractId, targetSelection: ALL) { billingCycles { cycleStartAt cycleEndAt cycleIndex } userErrors { field message } } }",
 "variables": {
    "contractId": "gid://shopify/SubscriptionContract/398475269"
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation subscriptionBillingCycleEditsDelete($contractId: ID!) {
    subscriptionBillingCycleEditsDelete(contractId: $contractId, targetSelection: ALL) {
      billingCycles {
        cycleStartAt
        cycleEndAt
        cycleIndex
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "contractId": "gid://shopify/SubscriptionContract/398475269"
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation subscriptionBillingCycleEditsDelete($contractId: ID!) {
    subscriptionBillingCycleEditsDelete(contractId: $contractId, targetSelection: ALL) {
      billingCycles {
        cycleStartAt
        cycleEndAt
        cycleIndex
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "contractId": "gid://shopify/SubscriptionContract/398475269"
}

response = client.query(query: query, variables: variables)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation subscriptionBillingCycleEditsDelete($contractId: ID!) {
      subscriptionBillingCycleEditsDelete(contractId: $contractId, targetSelection: ALL) {
        billingCycles {
          cycleStartAt
          cycleEndAt
          cycleIndex
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "contractId": "gid://shopify/SubscriptionContract/398475269"
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'mutation subscriptionBillingCycleEditsDelete($contractId: ID!) {
  subscriptionBillingCycleEditsDelete(contractId: $contractId, targetSelection: ALL) {
    billingCycles {
      cycleStartAt
      cycleEndAt
      cycleIndex
    }
    userErrors {
      field
      message
    }
  }
}' \
--variables \
'{
  "contractId": "gid://shopify/SubscriptionContract/398475269"
}'

Direct API Access

const response = await fetch('shopify:admin/api/2026-01/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation subscriptionBillingCycleEditsDelete($contractId: ID!) {
        subscriptionBillingCycleEditsDelete(contractId: $contractId, targetSelection: ALL) {
          billingCycles {
            cycleStartAt
            cycleEndAt
            cycleIndex
          }
          userErrors {
            field
            message
          }
        }
      }
    `,
    variables: {
        "contractId": "gid://shopify/SubscriptionContract/398475269"
    },
  }),
});

const { data } = await response.json();
console.log(data);

Response

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

subscriptionBillingCycleEditsDelete reference

Examples

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

mutation subscriptionBillingCycleEditsDelete($contractId: ID!) {

subscriptionBillingCycleEditsDelete(contractId: $contractId, targetSelection: ALL) {

billingCycles {

cycleStartAt

cycleEndAt

cycleIndex

}

userErrors {

field

message

}

}`,

{

variables: {

"contractId": "gid://shopify/SubscriptionContract/398475269"

);

const json = await response.json();

return json.data;

}

GQL

mutation subscriptionBillingCycleEditsDelete($contractId: ID!) {
  subscriptionBillingCycleEditsDelete(contractId: $contractId, targetSelection: ALL) {
    billingCycles {
      cycleStartAt
      cycleEndAt
      cycleIndex
    }
    userErrors {
      field
      message
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation subscriptionBillingCycleEditsDelete($contractId: ID!) { subscriptionBillingCycleEditsDelete(contractId: $contractId, targetSelection: ALL) { billingCycles { cycleStartAt cycleEndAt cycleIndex } userErrors { field message } } }",
 "variables": {
    "contractId": "gid://shopify/SubscriptionContract/398475269"
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation subscriptionBillingCycleEditsDelete($contractId: ID!) {
    subscriptionBillingCycleEditsDelete(contractId: $contractId, targetSelection: ALL) {
      billingCycles {
        cycleStartAt
        cycleEndAt
        cycleIndex
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "contractId": "gid://shopify/SubscriptionContract/398475269"
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation subscriptionBillingCycleEditsDelete($contractId: ID!) {
      subscriptionBillingCycleEditsDelete(contractId: $contractId, targetSelection: ALL) {
        billingCycles {
          cycleStartAt
          cycleEndAt
          cycleIndex
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "contractId": "gid://shopify/SubscriptionContract/398475269"
    },
  },
});

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation subscriptionBillingCycleEditsDelete($contractId: ID!) {
    subscriptionBillingCycleEditsDelete(contractId: $contractId, targetSelection: ALL) {
      billingCycles {
        cycleStartAt
        cycleEndAt
        cycleIndex
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "contractId": "gid://shopify/SubscriptionContract/398475269"
}

response = client.query(query: query, variables: variables)

Shopify CLI

shopify app execute \
--query \
'mutation subscriptionBillingCycleEditsDelete($contractId: ID!) {
  subscriptionBillingCycleEditsDelete(contractId: $contractId, targetSelection: ALL) {
    billingCycles {
      cycleStartAt
      cycleEndAt
      cycleIndex
    }
    userErrors {
      field
      message
    }
  }
}' \
--variables \
'{
  "contractId": "gid://shopify/SubscriptionContract/398475269"
}'

Direct API Access

const response = await fetch('shopify:admin/api/2026-01/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation subscriptionBillingCycleEditsDelete($contractId: ID!) {
        subscriptionBillingCycleEditsDelete(contractId: $contractId, targetSelection: ALL) {
          billingCycles {
            cycleStartAt
            cycleEndAt
            cycleIndex
          }
          userErrors {
            field
            message
          }
        }
      }
    `,
    variables: {
        "contractId": "gid://shopify/SubscriptionContract/398475269"
    },
  }),
});

const { data } = await response.json();
console.log(data);

Input variables

JSON

{

"contractId": "gid://shopify/SubscriptionContract/398475269"

}

Response

JSON

{

"subscriptionBillingCycleEditsDelete": {

"billingCycles": [

{

"cycleStartAt": "2021-12-15T15:33:01Z",

"cycleEndAt": "2022-01-01T12:00:00Z",

"cycleIndex": 1

}

"userErrors": []

}