The "customers" collection of methods.
Gets a customer account. Use this operation to see a customer account already in your reseller management, or to see the minimal account information for an existing customer that you do not manage. For more information about the API response for existing customers, see retrieving a customer account.
Orders a new customer's account. Before ordering a new customer account, establish whether the customer
account already exists using the
customers.get If the
customer account exists as a direct Google account or as a resold customer account from another reseller,
customerAuthToken\ as described in order a resold account for an existing
customer. For more information
about ordering a new customer account, see order a new customer
account. After creating a new customer
account, you must provision a user as an administrator. The customer's administrator is required to sign in
to the Admin console and sign the G Suite via Reseller agreement to activate the account. Resellers are
prohibited from signing the G Suite via Reseller agreement on the customer's behalf. For more information,
see order a new customer account.
Updates a customer account's settings. This method supports patch semantics. You cannot update
customerType via the Reseller API, but a
"team" customer can verify their domain and become
customerType = "domain". For more information, see Verify your domain to unlock Essentials
Updates a customer account's settings. You cannot update
customerType via the Reseller API, but a
customer can verify their domain and become
customerType = "domain". For more information, see update a
A base abstract class for Reseller requests.
The "resellernotify" collection of methods.
Returns all the details of the watch corresponding to the reseller.
Registers a Reseller for receiving notifications.
Unregisters a Reseller for receiving notifications.
The Reseller Service.
Available OAuth 2.0 scopes for use with the Google Workspace Reseller API.
Available OAuth 2.0 scope constants for use with the Google Workspace Reseller API.
The "subscriptions" collection of methods.
Activates a subscription previously suspended by the reseller. If you did not suspend the customer subscription and it is suspended for any other reason, such as for abuse or a pending ToS acceptance, this call will not reactivate the customer subscription.
Updates a subscription plan. Use this method to update a plan for a 30-day trial or a flexible plan subscription to an annual commitment plan with monthly or yearly payments. How a plan is updated differs depending on the plan and the products. For more information, see the description in manage subscriptions.
Updates a user license's renewal settings. This is applicable for accounts with annual commitment plans only. For more information, see the description in manage subscriptions.
Updates a subscription's user license settings. For more information about updating an annual commitment plan or a flexible plan subscription’s licenses, see Manage Subscriptions.
Cancels, suspends, or transfers a subscription to direct.
Gets a specific subscription. The
subscriptionId can be found using the Retrieve all reseller
subscriptions method. For more
information about retrieving a specific subscription, see the information descrived in manage
Creates or transfer a subscription. Create a subscription for a customer's account that you ordered using
the Order a new customer account method. For more
information about creating a subscription for different payment plans, see manage
subscriptions.\ If you did not
order the customer's account using the customer insert method, use the customer's
creating a subscription for that customer. If transferring a G Suite subscription with an associated Google
Drive or Google Vault subscription, use the batch operation to
transfer all of these subscriptions. For more information, see how to transfer
Lists of subscriptions managed by the reseller. The list can be all subscriptions, all of a customer's
subscriptions, or all of a customer's transferable subscriptions. Optionally, this method can filter the
response by a
customerNamePrefix. For more information, see manage
Immediately move a 30-day free trial subscription to a paid service subscription. This method is only applicable if a payment plan has already been set up for the 30-day trial subscription. For more information, see manage subscriptions.
Suspends an active subscription. You can use this method to suspend a paid subscription that is currently in
ACTIVE state. * For
FLEXIBLE subscriptions, billing is paused. * For
ANNUAL_YEARLY_PAY subscriptions: * Suspending the subscription does not change the renewal date that was
originally committed to. * A suspended subscription does not renew. If you activate the subscription after
the original renewal date, a new annual subscription will be created, starting on the day of activation. We
strongly encourage you to suspend subscriptions only for short periods of time as suspensions over 60 days
may result in the subscription being cancelled.
Data format for response.
V1 error format.
deletionType query string enables the cancellation, downgrade, or suspension of a subscription.
The intented insert action. The usage of this field is governed by certain policies which are being developed & tested currently. Hence, these might not work as intended. Once this is fully tested & available to consume, we will share more information about its usage, limitations and policy documentation.