Anchor to section titled 'undefined'

subscriptionContractActivate
mutation

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

Activates 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 'SubscriptionContractActivatePayload returns'

SubscriptionContractActivatePayload returns

Anchor to SubscriptionContractActivatePayload.contract
contract
SubscriptionContract

The new Subscription Contract object.

Anchor to SubscriptionContractActivatePayload.userErrors
userErrors
[SubscriptionContractStatusUpdateUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?
Hide code
Mutation reference
Copy
mutation subscriptionContractActivate($subscriptionContractId: ID!) {
  subscriptionContractActivate(subscriptionContractId: $subscriptionContractId) {
    contract {
      # SubscriptionContract fields
    }
    userErrors {
      field
      message
    }
  }
}
Hide code
Input
Copy
{
  "subscriptionContractId": "gid://shopify/<objectName>/10079785100"
}