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.

Anchor to Arguments

Arguments

Anchor to billingCycleInputbillingCycleInput

•SubscriptionBillingCycleInput!

required

Input object for selecting and using billing cycles.

Show input fields

Was this section helpful?

Anchor to SubscriptionBillingCycleSkipPayload returnsSubscriptionBillingCycleSkipPayload returns

Anchor to billingCyclebillingCycle •SubscriptionBillingCycle: The updated billing cycle.

Show fields
Anchor to userErrorsuserErrors •[SubscriptionBillingCycleSkipUserError!]! non-null: The list of errors that occurred from executing the mutation.

Show fields

Was this section helpful?

Examples

subscriptionBillingCycleSkip reference

Mutation Reference

mutation subscriptionBillingCycleSkip($billingCycleInput: SubscriptionBillingCycleInput!) {

subscriptionBillingCycleSkip(billingCycleInput: $billingCycleInput) {

billingCycle {

# SubscriptionBillingCycle fields

}

userErrors {

field

message

}

Input

{

"billingCycleInput": {

"contractId": "gid://shopify/SubscriptionContract/10079785100",

"selector": {

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

"index": 1

}

Variables

{
  "billingCycleInput": {
    "contractId": "gid://shopify/SubscriptionContract/10079785100",
    "selector": {
      "date": "2019-09-07T15:50:00Z",
      "index": 1
    }
  }
}

Schema

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

input SubscriptionBillingCycleSelector {
  date: DateTime
  index: Int
}