Choose a version:

subscriptionBillingCycleSkip

mutation

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

Skips a Subscription Billing Cycle.

Arguments

Anchor to billingCycleInputbillingCycleInput • SubscriptionBillingCycleInput!required: Input object for selecting and using billing cycles.

Was this section helpful?

Anchor to SubscriptionBillingCycleSkipPayload returnsSubscriptionBillingCycleSkipPayload returns

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

Was this section helpful?

Mutation Reference

mutation subscriptionBillingCycleSkip($billingCycleInput: SubscriptionBillingCycleInput!) {

subscriptionBillingCycleSkip(billingCycleInput: $billingCycleInput) {

billingCycle {

# SubscriptionBillingCycle fields

}

userErrors {

field

message

}

Input

{

"billingCycleInput": {

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

"selector": {

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

"index": 1

}

{
  "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
}