Anchor to section titled 'undefined'

subscriptionBillingCycleContractEdit
mutation

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

Edit the contents of a subscription contract for the specified 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 'SubscriptionBillingCycleContractEditPayload returns'

SubscriptionBillingCycleContractEditPayload returns

Anchor to SubscriptionBillingCycleContractEditPayload.draft
draft
SubscriptionDraft

The draft subscription contract object.

Anchor to SubscriptionBillingCycleContractEditPayload.userErrors
userErrors
[SubscriptionDraftUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?
Hide code
Mutation reference
Copy
mutation subscriptionBillingCycleContractEdit($billingCycleInput: SubscriptionBillingCycleInput!) {
  subscriptionBillingCycleContractEdit(billingCycleInput: $billingCycleInput) {
    draft {
      # SubscriptionDraft 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
}