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 Arguments

Arguments

Anchor to actoractor

•SubscriptionActor

The actor who initiated a subscription action.

Show enum values

Anchor to billingCycleInputbillingCycleInput

•SubscriptionBillingCycleInput!

required

Input object for selecting and using billing cycles.

Show input fields

Was this section helpful?

Anchor to SubscriptionBillingCycleContractEditPayload returnsSubscriptionBillingCycleContractEditPayload returns

Anchor to draftdraft •SubscriptionDraft: The draft subscription contract object.

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

Show fields

Was this section helpful?

Examples

subscriptionBillingCycleContractEdit reference

Mutation Reference

mutation subscriptionBillingCycleContractEdit($actor: SubscriptionActor, $billingCycleInput: SubscriptionBillingCycleInput!) {

subscriptionBillingCycleContractEdit(actor: $actor, billingCycleInput: $billingCycleInput) {

draft {

# SubscriptionDraft fields

}

userErrors {

field

message

}

Input

{

"actor": "CUSTOMER",

"billingCycleInput": {

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

"selector": {

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

"index": 1

}

Variables

{
  "actor": "CUSTOMER",
  "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
}