Update subscription

updateSubscription(input: UpdateSubscriptionInput!): SubscriptionChange!

Requires account.billing.manage.

Arguments

ArgumentTypeRequired
inputUpdateSubscriptionInput!Yes

Input fields

input

UpdateSubscriptionInput

FieldTypeRequiredDescription
typeSubscriptionType!Yes
cycleSubscriptionCycle!Yes
quantityIntNoSeat quantity for licensed subscriptions
serverQuantityIntNoRecurring server add-on quantity
sandboxQuantityIntNoRecurring sandbox add-on quantity
successUrlStringNoURL to redirect to after successful payment
cancelUrlStringNoURL to redirect to if payment is canceled.

Response

Returns SubscriptionChange!. Open the type for its fields and nested types.

FieldTypeDescription
statusString!One of subscription_updated, seats_updated, add_ons_updated or checkout_created
amountStringExact decimal amount due, without a currency suffix. Null when no amount is due or known.
currencyStringISO 4217 currency of amount in upper case. Null without an amount.
checkoutUrlStringStripe checkout session URL when payment is required. Null when the change was applied in place.

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

graphql
mutation UpdateSubscription($input: UpdateSubscriptionInput!) {
  updateSubscription(input: $input) {
    status
    amount
    checkoutUrl
    currency
  }
}
json
{
  "input": {
    "type": "free",
    "cycle": "monthly"
  }
}