# subscriptionBillingCycleScheduleEdit - admin-graphql - MUTATION
Version: 2024-10

## Description
Modify the schedule of a specific billing cycle.

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


## Arguments
* [billingCycleInput](/docs/api/admin-graphql/2024-10/input-objects/SubscriptionBillingCycleInput): SubscriptionBillingCycleInput! - Input object for selecting and using billing cycles.
* [input](/docs/api/admin-graphql/2024-10/input-objects/SubscriptionBillingCycleScheduleEditInput): SubscriptionBillingCycleScheduleEditInput! - Data used to create or modify billing cycle schedule edit.


## Returns
* [billingCycle](/docs/api/admin-graphql/2024-10/objects/SubscriptionBillingCycle): SubscriptionBillingCycle The updated billing cycle.
* [userErrors](/docs/api/admin-graphql/2024-10/objects/SubscriptionBillingCycleUserError): SubscriptionBillingCycleUserError! The list of errors that occurred from executing the mutation.


## Examples
### Change the billing date of a cycle
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 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 } } }\",\n \"variables\": {\n    \"contractId\": \"gid://shopify/SubscriptionContract/398475269\",\n    \"index\": 1,\n    \"date\": \"2021-12-31T07:00:00-05:00\"\n  }\n}'\n"
Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation subscriptionBillingCycleScheduleEdit($contractId: ID!, $index: Int!, $date: DateTime!) {\n      subscriptionBillingCycleScheduleEdit(billingCycleInput: {contractId: $contractId, selector: {index: $index}}, input: {billingDate: $date, reason: BUYER_INITIATED}) {\n        billingCycle {\n          cycleIndex\n          billingAttemptExpectedDate\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"contractId\": \"gid://shopify/SubscriptionContract/398475269\",\n      \"index\": 1,\n      \"date\": \"2021-12-31T07:00:00-05:00\"\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 subscriptionBillingCycleScheduleEdit($contractId: ID!, $index: Int!, $date: DateTime!) {\n    subscriptionBillingCycleScheduleEdit(billingCycleInput: {contractId: $contractId, selector: {index: $index}}, input: {billingDate: $date, reason: BUYER_INITIATED}) {\n      billingCycle {\n        cycleIndex\n        billingAttemptExpectedDate\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"contractId\": \"gid://shopify/SubscriptionContract/398475269\",\n  \"index\": 1,\n  \"date\": \"2021-12-31T07:00:00-05:00\"\n}\n\nresponse = 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 subscriptionBillingCycleScheduleEdit($contractId: ID!, $index: Int!, $date: DateTime!) {\n    subscriptionBillingCycleScheduleEdit(billingCycleInput: {contractId: $contractId, selector: {index: $index}}, input: {billingDate: $date, reason: BUYER_INITIATED}) {\n      billingCycle {\n        cycleIndex\n        billingAttemptExpectedDate\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"contractId\": \"gid://shopify/SubscriptionContract/398475269\",\n      \"index\": 1,\n      \"date\": \"2021-12-31T07:00:00-05:00\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
Graphql query: "mutation subscriptionBillingCycleScheduleEdit($contractId: ID!, $index: Int!, $date: DateTime!) {\n  subscriptionBillingCycleScheduleEdit(billingCycleInput: {contractId: $contractId, selector: {index: $index}}, input: {billingDate: $date, reason: BUYER_INITIATED}) {\n    billingCycle {\n      cycleIndex\n      billingAttemptExpectedDate\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"
#### Graphql Input
{
  "contractId": "gid://shopify/SubscriptionContract/398475269",
  "index": 1,
  "date": "2021-12-31T07:00:00-05:00"
}
#### Graphql Response
{
  "data": {
    "subscriptionBillingCycleScheduleEdit": {
      "billingCycle": {
        "cycleIndex": 1,
        "billingAttemptExpectedDate": "2021-12-31T12:00:00Z"
      },
      "userErrors": []
    }
  }
}

### Skip a cycle
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 subscriptionBillingCycleScheduleEdit($contractId: ID!, $index: Int!) { subscriptionBillingCycleScheduleEdit(billingCycleInput: {contractId: $contractId, selector: {index: $index}}, input: {skip: true, reason: BUYER_INITIATED}) { billingCycle { cycleIndex skipped } userErrors { field message } } }\",\n \"variables\": {\n    \"contractId\": \"gid://shopify/SubscriptionContract/398475269\",\n    \"index\": 1\n  }\n}'\n"
Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation subscriptionBillingCycleScheduleEdit($contractId: ID!, $index: Int!) {\n      subscriptionBillingCycleScheduleEdit(billingCycleInput: {contractId: $contractId, selector: {index: $index}}, input: {skip: true, reason: BUYER_INITIATED}) {\n        billingCycle {\n          cycleIndex\n          skipped\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"contractId\": \"gid://shopify/SubscriptionContract/398475269\",\n      \"index\": 1\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 subscriptionBillingCycleScheduleEdit($contractId: ID!, $index: Int!) {\n    subscriptionBillingCycleScheduleEdit(billingCycleInput: {contractId: $contractId, selector: {index: $index}}, input: {skip: true, reason: BUYER_INITIATED}) {\n      billingCycle {\n        cycleIndex\n        skipped\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"contractId\": \"gid://shopify/SubscriptionContract/398475269\",\n  \"index\": 1\n}\n\nresponse = 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 subscriptionBillingCycleScheduleEdit($contractId: ID!, $index: Int!) {\n    subscriptionBillingCycleScheduleEdit(billingCycleInput: {contractId: $contractId, selector: {index: $index}}, input: {skip: true, reason: BUYER_INITIATED}) {\n      billingCycle {\n        cycleIndex\n        skipped\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"contractId\": \"gid://shopify/SubscriptionContract/398475269\",\n      \"index\": 1\n    },\n  },\n);\n\nconst data = await response.json();\n"
Graphql query: "mutation subscriptionBillingCycleScheduleEdit($contractId: ID!, $index: Int!) {\n  subscriptionBillingCycleScheduleEdit(billingCycleInput: {contractId: $contractId, selector: {index: $index}}, input: {skip: true, reason: BUYER_INITIATED}) {\n    billingCycle {\n      cycleIndex\n      skipped\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"
#### Graphql Input
{
  "contractId": "gid://shopify/SubscriptionContract/398475269",
  "index": 1
}
#### Graphql Response
{
  "data": {
    "subscriptionBillingCycleScheduleEdit": {
      "billingCycle": {
        "cycleIndex": 1,
        "skipped": true
      },
      "userErrors": []
    }
  }
}