Subscriptions: changeSeats

Requires authorization

Update a subscription's user license settings. Try it now.

For more information about updating an annual commitment plan or a flexible plan subscription’s licenses, see Manage Subscriptions.


HTTP request



Parameter name Value Description
Path parameters
customerId string Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.
subscriptionId string This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method.


This request requires authorization with the following scope (read more about authentication and authorization).


Request body

In the request body, supply data with the following structure:

  "kind": "subscriptions#seats",
  "licensedNumberOfSeats": integer,
  "numberOfSeats": integer,
  "maximumNumberOfSeats": integer
Property name Value Description Notes
kind string Identifies the resource as a subscription seat setting. Value: subscriptions#seats
numberOfSeats integer This is a required property and is exclusive to subscriptions with ANNUAL_MONTHLY_PAY and ANNUAL_YEARLY_PAY plans. This property sets the maximum number of licenses assignable to users on a subscription. The reseller can add more licenses, but once set, the numberOfSeats cannot be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are assigned.
maximumNumberOfSeats integer This is a required property and is exclusive to subscriptions with FLEXIBLE or TRIAL plans. This property sets the maximum number of licensed users allowed on a subscription. This quantity can be increased up to the maximum limit defined in the reseller's contract. The minimum quantity is the current number of users in the customer account.
licensedNumberOfSeats integer Read-only field containing the current number of users that are assigned a license for the product defined in skuId. This field's value is equivalent to the numerical count of users returned by the Enterprise License Manager API method: listForProductAndSku


If successful, this method returns a Subscriptions resource in the response body.

Try it!

Use the APIs Explorer below to call this method on live data and see the response. Alternatively, try the standalone Explorer.