subscriptionContractExpire
mutation

Choose a version:

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

Expires a Subscription Contract.

Anchor to section titled 'Arguments'

Arguments

Anchor to subscriptionContractId subscriptionContractId ID! required: The ID of the Subscription Contract.

Was this section helpful?

Anchor to section titled 'SubscriptionContractExpirePayload returns'

SubscriptionContractExpirePayload returns

Anchor to SubscriptionContractExpirePayload.contract contract SubscriptionContract: The new Subscription Contract object.
Anchor to SubscriptionContractExpirePayload.userErrors userErrors [SubscriptionContractStatusUpdateUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: subscriptionContractExpire

Query Reference for MUTATION: subscriptionContractExpire

"mutation subscriptionContractExpire($subscriptionContractId: ID!) {\n  subscriptionContractExpire(subscriptionContractId: $subscriptionContractId) {\n    contract {\n      # SubscriptionContract fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: subscriptionContractExpire

"{\n  \"subscriptionContractId\": \"gid://shopify/<objectName>/10079785100\"\n}"

Schema Reference for MUTATION: subscriptionContractExpire

""

Display Examples for MUTATION: subscriptionContractExpire

[]

subscriptionContractExpiremutation

Arguments

SubscriptionContractExpirePayload returns

subscriptionContractExpire
mutation