Anchor to subscriptionContractExpiresubscription
subscriptionContractExpire
mutation
Requires access scope. Also: The user must have manage_orders_information permission.
Expires a Subscription Contract.
Anchor to Arguments
Arguments
- Anchor to subscriptionContractIdsubscription•
Contract Id ID!required The ID of the Subscription Contract.
Was this section helpful?
Anchor to SubscriptionContractExpirePayload returnsSubscriptionContractExpirePayload returns
- Anchor to contractcontract•
The new Subscription Contract object.
- Anchor to userErrorsuser•
Errors The list of errors that occurred from executing the mutation.
Was this section helpful?
Mutation Reference
mutation subscriptionContractExpire($subscriptionContractId: ID!) {
subscriptionContractExpire(subscriptionContractId: $subscriptionContractId) {
contract {
# SubscriptionContract fields
}
userErrors {
field
message
}
}
}
Input
{
"subscriptionContractId": "gid://shopify/<objectName>/10079785100"
}
{
"subscriptionContractId": "gid://shopify/<objectName>/10079785100"
}