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.

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?

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/<objectName>/10079785100",

"selector": {

"index": 1,

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

}

Variables

{
  "actor": "CUSTOMER",
  "billingCycleInput": {
    "contractId": "gid://shopify/<objectName>/10079785100",
    "selector": {
      "index": 1,
      "date": "2019-09-07T15:50:00Z"
    }
  }
}

Schema

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

input SubscriptionBillingCycleSelector {
  index: Int
  date: DateTime
}