Choose a version:

Anchor to subscriptionBillingCycleEditDelete

subscriptionBillingCycleEditDelete

mutation

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

Arguments

Anchor to billingCycleInputbillingCycleInput

•SubscriptionBillingCycleInput!

required

Input object used to select and use billing cycles.

Show input fields

Was this section helpful?

Anchor to SubscriptionBillingCycleEditDeletePayload returnsSubscriptionBillingCycleEditDeletePayload 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

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.

Query

mutation subscriptionBillingCycleEditDelete($contractId: ID!, $index: Int!) {
  subscriptionBillingCycleEditDelete(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) {
    billingCycles {
      cycleStartAt
      cycleEndAt
      cycleIndex
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "contractId": "gid://shopify/SubscriptionContract/398475269",
  "index": 1
}

cURL

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

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 subscriptionBillingCycleEditDelete($contractId: ID!, $index: Int!) {
    subscriptionBillingCycleEditDelete(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) {
      billingCycles {
        cycleStartAt
        cycleEndAt
        cycleIndex
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "contractId": "gid://shopify/SubscriptionContract/398475269",
        "index": 1
    },
  },
  );
  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 subscriptionBillingCycleEditDelete($contractId: ID!, $index: Int!) {
    subscriptionBillingCycleEditDelete(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) {
      billingCycles {
        cycleStartAt
        cycleEndAt
        cycleIndex
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

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

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

Node.js

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

Shopify CLI

shopify app execute \
--query \
'mutation subscriptionBillingCycleEditDelete($contractId: ID!, $index: Int!) {
  subscriptionBillingCycleEditDelete(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) {
    billingCycles {
      cycleStartAt
      cycleEndAt
      cycleIndex
    }
    userErrors {
      field
      message
    }
  }
}' \
--variables \
'{
  "contractId": "gid://shopify/SubscriptionContract/398475269",
  "index": 1
}'

Direct API Access

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

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

Response

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

subscriptionBillingCycleEditDelete 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 subscriptionBillingCycleEditDelete($contractId: ID!, $index: Int!) {

subscriptionBillingCycleEditDelete(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) {

billingCycles {

cycleStartAt

cycleEndAt

cycleIndex

}

userErrors {

field

message

}

}`,

{

variables: {

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

"index": 1

);

const json = await response.json();

return json.data;

}

GQL

mutation subscriptionBillingCycleEditDelete($contractId: ID!, $index: Int!) {
  subscriptionBillingCycleEditDelete(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) {
    billingCycles {
      cycleStartAt
      cycleEndAt
      cycleIndex
    }
    userErrors {
      field
      message
    }
  }
}

cURL

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

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 subscriptionBillingCycleEditDelete($contractId: ID!, $index: Int!) {
    subscriptionBillingCycleEditDelete(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) {
      billingCycles {
        cycleStartAt
        cycleEndAt
        cycleIndex
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "contractId": "gid://shopify/SubscriptionContract/398475269",
        "index": 1
    },
  },
  );
  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 subscriptionBillingCycleEditDelete($contractId: ID!, $index: Int!) {
      subscriptionBillingCycleEditDelete(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) {
        billingCycles {
          cycleStartAt
          cycleEndAt
          cycleIndex
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "contractId": "gid://shopify/SubscriptionContract/398475269",
        "index": 1
    },
  },
});

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 subscriptionBillingCycleEditDelete($contractId: ID!, $index: Int!) {
    subscriptionBillingCycleEditDelete(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) {
      billingCycles {
        cycleStartAt
        cycleEndAt
        cycleIndex
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

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

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

Shopify CLI

shopify app execute \
--query \
'mutation subscriptionBillingCycleEditDelete($contractId: ID!, $index: Int!) {
  subscriptionBillingCycleEditDelete(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) {
    billingCycles {
      cycleStartAt
      cycleEndAt
      cycleIndex
    }
    userErrors {
      field
      message
    }
  }
}' \
--variables \
'{
  "contractId": "gid://shopify/SubscriptionContract/398475269",
  "index": 1
}'

Direct API Access

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

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

Input variables

JSON

{

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

"index": 1

}

Response

JSON

{

"subscriptionBillingCycleEditDelete": {

"billingCycles": [

{

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

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

"cycleIndex": 1

}

"userErrors": []

}