subscriptionContractBillingCycleReschedule

mutation

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

Reschedules the billing date for a selected and subsequent billing cycles within a subscription contract.

Anchor to Arguments

Arguments

Anchor to billingDatebillingDate

•DateTime!

required

The new billing date for the selected billing cycle.

Anchor to targetBillingCycletargetBillingCycle

•SubscriptionBillingCycleInput!

required

Input object for selecting and using billing cycles within a subscription contract.

Was this section helpful?

Anchor to SubscriptionContractBillingCycleReschedulePayload returnsSubscriptionContractBillingCycleReschedulePayload returns

Anchor to billingCyclebillingCycle •SubscriptionBillingCycle: The updated billing cycle.
Anchor to userErrorsuserErrors •[SubscriptionContractBillingCycleRescheduleUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

subscriptionContractBillingCycleReschedule reference

Mutation Reference

mutation subscriptionContractBillingCycleReschedule($billingDate: DateTime!, $targetBillingCycle: SubscriptionBillingCycleInput!) {

subscriptionContractBillingCycleReschedule(billingDate: $billingDate, targetBillingCycle: $targetBillingCycle) {

billingCycle {

# SubscriptionBillingCycle fields

}

userErrors {

field

message

}

Input

{

"billingDate": "2019-09-07T15:50:00Z",

"targetBillingCycle": {

"contractId": "gid://shopify/<objectName>/10079785100",

"selector": {

"date": "2019-09-07T15:50:00Z",

"index": 1

}

Variables

{
  "billingDate": "2019-09-07T15:50:00Z",
  "targetBillingCycle": {
    "contractId": "gid://shopify/<objectName>/10079785100",
    "selector": {
      "date": "2019-09-07T15:50:00Z",
      "index": 1
    }
  }
}

Schema

input SubscriptionBillingCycleInput {
  contractId: ID!
  selector: SubscriptionBillingCycleSelector!
}

input SubscriptionBillingCycleSelector {
  date: DateTime
  index: Int
}