Anchor to section titled 'undefined'

subscriptionBillingCycleSkip
mutation

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

Skips a Subscription Billing Cycle.

Anchor to section titled 'Arguments'

Arguments

Anchor to billingCycleInput
billingCycleInput
SubscriptionBillingCycleInput!
required

Input object for selecting and using billing cycles.

Was this section helpful?
Anchor to section titled 'SubscriptionBillingCycleSkipPayload returns'

SubscriptionBillingCycleSkipPayload returns

Anchor to SubscriptionBillingCycleSkipPayload.billingCycle
billingCycle
SubscriptionBillingCycle

The updated billing cycle.

Anchor to SubscriptionBillingCycleSkipPayload.userErrors
userErrors
[SubscriptionBillingCycleSkipUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?
Hide code
Mutation reference
Copy
mutation subscriptionBillingCycleSkip($billingCycleInput: SubscriptionBillingCycleInput!) {
  subscriptionBillingCycleSkip(billingCycleInput: $billingCycleInput) {
    billingCycle {
      # SubscriptionBillingCycle fields
    }
    userErrors {
      field
      message
    }
  }
}
Hide code
Input
Copy
{
  "billingCycleInput": {
    "contractId": "gid://shopify/<objectName>/10079785100",
    "selector": {
      "date": "2019-09-07T15:50:00Z",
      "index": 1
    }
  }
}
input SubscriptionBillingCycleInput {
  contractId: ID!
  selector: SubscriptionBillingCycleSelector!
}

input SubscriptionBillingCycleSelector {
  date: DateTime
  index: Int
}