subscriptionBillingCycleContractEdit
mutation

Choose a version:

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?

Code examples for MUTATION: subscriptionBillingCycleContractEdit

Query Reference for MUTATION: subscriptionBillingCycleContractEdit

"mutation subscriptionBillingCycleContractEdit($billingCycleInput: SubscriptionBillingCycleInput!) {\n  subscriptionBillingCycleContractEdit(billingCycleInput: $billingCycleInput) {\n    draft {\n      # SubscriptionDraft fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: subscriptionBillingCycleContractEdit

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

Schema Reference for MUTATION: subscriptionBillingCycleContractEdit

"input SubscriptionBillingCycleInput {\n  contractId: ID!\n  selector: SubscriptionBillingCycleSelector!\n}\n\ninput SubscriptionBillingCycleSelector {\n  date: DateTime\n  index: Int\n}\n"

Display Examples for MUTATION: subscriptionBillingCycleContractEdit

[]

subscriptionBillingCycleContractEditmutation

Arguments

SubscriptionBillingCycleContractEditPayload returns

subscriptionBillingCycleContractEdit
mutation