Anchor to section titled 'undefined'

subscriptionBillingCycleScheduleEdit
mutation

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

Modify the schedule of a specific billing cycle.


Input object for selecting and using billing cycles.

Data used to create or modify billing cycle schedule edit.


Was this section helpful?

The list of errors that occurred from executing the mutation.


Was this section helpful?

Examples

Hide code
DescriptionCopy
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 -X POST \
https://your-development-store.myshopify.com/admin/api/2024-01/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"
  }
}'
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 data = await response.json();
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)
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"
    },
  },
});
use Shopify\Clients\Graphql;

$client = new Graphql("your-development-store.myshopify.com", $accessToken);
$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]);
Hide code
Input variables
Copy
{
  "contractId": "gid://shopify/SubscriptionContract/398475269",
  "index": 1,
  "date": "2021-12-31T07:00:00-05:00"
}
Hide code
Response
JSON
{
  "subscriptionBillingCycleScheduleEdit": {
    "billingCycle": {
      "cycleIndex": 1,
      "billingAttemptExpectedDate": "2021-12-31T12:00:00Z"
    },
    "userErrors": []
  }
}