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.

Arguments

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

Was this section helpful?

Anchor to SubscriptionBillingCycleContractEditPayload returnsSubscriptionBillingCycleContractEditPayload returns

Anchor to draftdraft • SubscriptionDraft: The draft subscription contract object.
Anchor to userErrorsuserErrors • [SubscriptionDraftUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Mutation Reference

1mutation subscriptionBillingCycleContractEdit($billingCycleInput: SubscriptionBillingCycleInput!) {
2  subscriptionBillingCycleContractEdit(billingCycleInput: $billingCycleInput) {
3    draft {
4      # SubscriptionDraft fields
5    }
6    userErrors {
7      field
8      message
9    }
10  }
11}

Input

1{
2  "billingCycleInput": {
3    "contractId": "gid://shopify/<objectName>/10079785100",
4    "selector": {
5      "date": "2019-09-07T15:50:00Z",
6      "index": 1
7    }
8  }
9}

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