Anchor to billingCyclebillingCycle •SubscriptionBillingCycle: The updated billing cycle.

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

Change the billing date of a cycle

Description

Changes the `billingAttemptExpectedDate` for the specified cycle.

Query

mutation subscriptionBillingCycleScheduleEdit($contractId: ID!, $index: Int!, $date: DateTime!) {
  subscriptionBillingCycleScheduleEdit(billingCycleInput: {contractId: $contractId, selector: {index: $index}}, input: {billingDate: $date, reason: BUYER_INITIATED}) {
    billingCycle {
      cycleIndex
      billingAttemptExpectedDate
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "contractId": "gid://shopify/SubscriptionContract/398475269",
  "index": 1,
  "date": "2021-12-31T07:00:00-05:00"
}

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 subscriptionBillingCycleScheduleEdit($contractId: ID!, $index: Int!, $date: DateTime!) { subscriptionBillingCycleScheduleEdit(billingCycleInput: {contractId: $contractId, selector: {index: $index}}, input: {billingDate: $date, reason: BUYER_INITIATED}) { billingCycle { cycleIndex billingAttemptExpectedDate } userErrors { field message } } }",
 "variables": {
    "contractId": "gid://shopify/SubscriptionContract/398475269",
    "index": 1,
    "date": "2021-12-31T07:00:00-05:00"
  }
}'

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 subscriptionBillingCycleScheduleEdit($contractId: ID!, $index: Int!, $date: DateTime!) {
    subscriptionBillingCycleScheduleEdit(billingCycleInput: {contractId: $contractId, selector: {index: $index}}, input: {billingDate: $date, reason: BUYER_INITIATED}) {
      billingCycle {
        cycleIndex
        billingAttemptExpectedDate
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "contractId": "gid://shopify/SubscriptionContract/398475269",
        "index": 1,
        "date": "2021-12-31T07:00:00-05:00"
    },
  },
  );
  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 subscriptionBillingCycleScheduleEdit($contractId: ID!, $index: Int!, $date: DateTime!) {
    subscriptionBillingCycleScheduleEdit(billingCycleInput: {contractId: $contractId, selector: {index: $index}}, input: {billingDate: $date, reason: BUYER_INITIATED}) {
      billingCycle {
        cycleIndex
        billingAttemptExpectedDate
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "contractId": "gid://shopify/SubscriptionContract/398475269",
  "index": 1,
  "date": "2021-12-31T07:00:00-05:00"
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation subscriptionBillingCycleScheduleEdit($contractId: ID!, $index: Int!, $date: DateTime!) {
      subscriptionBillingCycleScheduleEdit(billingCycleInput: {contractId: $contractId, selector: {index: $index}}, input: {billingDate: $date, reason: BUYER_INITIATED}) {
        billingCycle {
          cycleIndex
          billingAttemptExpectedDate
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "contractId": "gid://shopify/SubscriptionContract/398475269",
        "index": 1,
        "date": "2021-12-31T07:00:00-05:00"
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'mutation subscriptionBillingCycleScheduleEdit($contractId: ID!, $index: Int!, $date: DateTime!) {
  subscriptionBillingCycleScheduleEdit(billingCycleInput: {contractId: $contractId, selector: {index: $index}}, input: {billingDate: $date, reason: BUYER_INITIATED}) {
    billingCycle {
      cycleIndex
      billingAttemptExpectedDate
    }
    userErrors {
      field
      message
    }
  }
}' \
--variables \
'{
  "contractId": "gid://shopify/SubscriptionContract/398475269",
  "index": 1,
  "date": "2021-12-31T07:00:00-05:00"
}'

Direct API Access

const response = await fetch('shopify:admin/api/2026-07/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation subscriptionBillingCycleScheduleEdit($contractId: ID!, $index: Int!, $date: DateTime!) {
        subscriptionBillingCycleScheduleEdit(billingCycleInput: {contractId: $contractId, selector: {index: $index}}, input: {billingDate: $date, reason: BUYER_INITIATED}) {
          billingCycle {
            cycleIndex
            billingAttemptExpectedDate
          }
          userErrors {
            field
            message
          }
        }
      }
    `,
    variables: {
        "contractId": "gid://shopify/SubscriptionContract/398475269",
        "index": 1,
        "date": "2021-12-31T07:00:00-05:00"
    },
  }),
});

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

Response

{
  "subscriptionBillingCycleScheduleEdit": {
    "billingCycle": {
      "cycleIndex": 1,
      "billingAttemptExpectedDate": "2021-12-31T12:00:00Z"
    },
    "userErrors": []
  }
}

Skip a cycle

Description

Skips the billing and delivery for the billing cycle with cycle index `1`. The reason that is given for the skip is a customer request.

Query

mutation subscriptionBillingCycleScheduleEdit($contractId: ID!, $index: Int!) {
  subscriptionBillingCycleScheduleEdit(billingCycleInput: {contractId: $contractId, selector: {index: $index}}, input: {skip: true, reason: BUYER_INITIATED}) {
    billingCycle {
      cycleIndex
      skipped
    }
    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 subscriptionBillingCycleScheduleEdit($contractId: ID!, $index: Int!) { subscriptionBillingCycleScheduleEdit(billingCycleInput: {contractId: $contractId, selector: {index: $index}}, input: {skip: true, reason: BUYER_INITIATED}) { billingCycle { cycleIndex skipped } 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 subscriptionBillingCycleScheduleEdit($contractId: ID!, $index: Int!) {
    subscriptionBillingCycleScheduleEdit(billingCycleInput: {contractId: $contractId, selector: {index: $index}}, input: {skip: true, reason: BUYER_INITIATED}) {
      billingCycle {
        cycleIndex
        skipped
      }
      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 subscriptionBillingCycleScheduleEdit($contractId: ID!, $index: Int!) {
    subscriptionBillingCycleScheduleEdit(billingCycleInput: {contractId: $contractId, selector: {index: $index}}, input: {skip: true, reason: BUYER_INITIATED}) {
      billingCycle {
        cycleIndex
        skipped
      }
      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 subscriptionBillingCycleScheduleEdit($contractId: ID!, $index: Int!) {
      subscriptionBillingCycleScheduleEdit(billingCycleInput: {contractId: $contractId, selector: {index: $index}}, input: {skip: true, reason: BUYER_INITIATED}) {
        billingCycle {
          cycleIndex
          skipped
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "contractId": "gid://shopify/SubscriptionContract/398475269",
        "index": 1
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'mutation subscriptionBillingCycleScheduleEdit($contractId: ID!, $index: Int!) {
  subscriptionBillingCycleScheduleEdit(billingCycleInput: {contractId: $contractId, selector: {index: $index}}, input: {skip: true, reason: BUYER_INITIATED}) {
    billingCycle {
      cycleIndex
      skipped
    }
    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 subscriptionBillingCycleScheduleEdit($contractId: ID!, $index: Int!) {
        subscriptionBillingCycleScheduleEdit(billingCycleInput: {contractId: $contractId, selector: {index: $index}}, input: {skip: true, reason: BUYER_INITIATED}) {
          billingCycle {
            cycleIndex
            skipped
          }
          userErrors {
            field
            message
          }
        }
      }
    `,
    variables: {
        "contractId": "gid://shopify/SubscriptionContract/398475269",
        "index": 1
    },
  }),
});

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

Response

{
  "subscriptionBillingCycleScheduleEdit": {
    "billingCycle": {
      "cycleIndex": 1,
      "skipped": true
    },
    "userErrors": []
  }
}

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

subscriptionBillingCycleScheduleEdit(billingCycleInput: {contractId: $contractId, selector: {index: $index}}, input: {billingDate: $date, reason: BUYER_INITIATED}) {

billingCycle {

cycleIndex

billingAttemptExpectedDate

}

userErrors {

field

message

}

}`,

{

variables: {

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

"index": 1,

"date": "2021-12-31T07:00:00-05:00"

);

const json = await response.json();

return json.data;

}

GQL

mutation subscriptionBillingCycleScheduleEdit($contractId: ID!, $index: Int!, $date: DateTime!) {
  subscriptionBillingCycleScheduleEdit(billingCycleInput: {contractId: $contractId, selector: {index: $index}}, input: {billingDate: $date, reason: BUYER_INITIATED}) {
    billingCycle {
      cycleIndex
      billingAttemptExpectedDate
    }
    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 subscriptionBillingCycleScheduleEdit($contractId: ID!, $index: Int!, $date: DateTime!) { subscriptionBillingCycleScheduleEdit(billingCycleInput: {contractId: $contractId, selector: {index: $index}}, input: {billingDate: $date, reason: BUYER_INITIATED}) { billingCycle { cycleIndex billingAttemptExpectedDate } userErrors { field message } } }",
 "variables": {
    "contractId": "gid://shopify/SubscriptionContract/398475269",
    "index": 1,
    "date": "2021-12-31T07:00:00-05:00"
  }
}'

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 subscriptionBillingCycleScheduleEdit($contractId: ID!, $index: Int!, $date: DateTime!) {
    subscriptionBillingCycleScheduleEdit(billingCycleInput: {contractId: $contractId, selector: {index: $index}}, input: {billingDate: $date, reason: BUYER_INITIATED}) {
      billingCycle {
        cycleIndex
        billingAttemptExpectedDate
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "contractId": "gid://shopify/SubscriptionContract/398475269",
        "index": 1,
        "date": "2021-12-31T07:00:00-05:00"
    },
  },
  );
  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 subscriptionBillingCycleScheduleEdit($contractId: ID!, $index: Int!, $date: DateTime!) {
      subscriptionBillingCycleScheduleEdit(billingCycleInput: {contractId: $contractId, selector: {index: $index}}, input: {billingDate: $date, reason: BUYER_INITIATED}) {
        billingCycle {
          cycleIndex
          billingAttemptExpectedDate
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "contractId": "gid://shopify/SubscriptionContract/398475269",
        "index": 1,
        "date": "2021-12-31T07:00:00-05:00"
    },
  },
});

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 subscriptionBillingCycleScheduleEdit($contractId: ID!, $index: Int!, $date: DateTime!) {
    subscriptionBillingCycleScheduleEdit(billingCycleInput: {contractId: $contractId, selector: {index: $index}}, input: {billingDate: $date, reason: BUYER_INITIATED}) {
      billingCycle {
        cycleIndex
        billingAttemptExpectedDate
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "contractId": "gid://shopify/SubscriptionContract/398475269",
  "index": 1,
  "date": "2021-12-31T07:00:00-05:00"
}

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

Shopify CLI

shopify app execute \
--query \
'mutation subscriptionBillingCycleScheduleEdit($contractId: ID!, $index: Int!, $date: DateTime!) {
  subscriptionBillingCycleScheduleEdit(billingCycleInput: {contractId: $contractId, selector: {index: $index}}, input: {billingDate: $date, reason: BUYER_INITIATED}) {
    billingCycle {
      cycleIndex
      billingAttemptExpectedDate
    }
    userErrors {
      field
      message
    }
  }
}' \
--variables \
'{
  "contractId": "gid://shopify/SubscriptionContract/398475269",
  "index": 1,
  "date": "2021-12-31T07:00:00-05:00"
}'

Direct API Access

const response = await fetch('shopify:admin/api/2026-07/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation subscriptionBillingCycleScheduleEdit($contractId: ID!, $index: Int!, $date: DateTime!) {
        subscriptionBillingCycleScheduleEdit(billingCycleInput: {contractId: $contractId, selector: {index: $index}}, input: {billingDate: $date, reason: BUYER_INITIATED}) {
          billingCycle {
            cycleIndex
            billingAttemptExpectedDate
          }
          userErrors {
            field
            message
          }
        }
      }
    `,
    variables: {
        "contractId": "gid://shopify/SubscriptionContract/398475269",
        "index": 1,
        "date": "2021-12-31T07:00:00-05:00"
    },
  }),
});

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

Input variables

JSON

{

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

"index": 1,

"date": "2021-12-31T07:00:00-05:00"

}

Response

JSON

{

"subscriptionBillingCycleScheduleEdit": {

"billingCycle": {

"cycleIndex": 1,

"billingAttemptExpectedDate": "2021-12-31T12:00:00Z"

"userErrors": []

}