Google Workspace Reseller API
Stay organized with collections
Save and categorize content based on your preferences.
Perform common functions that are available on the Channel Services console at scale, like placing orders and viewing customer information
Service: reseller.googleapis.com
To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.
Discovery document
A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:
Service endpoint
A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:
https://reseller.googleapis.com
| Methods |
get |
GET /apps/reseller/v1/customers/{customerId}
Gets a customer account. |
insert |
POST /apps/reseller/v1/customers
Orders a new customer's account. |
patch |
PATCH /apps/reseller/v1/customers/{customerId}
Updates a customer account's settings. |
update |
PUT /apps/reseller/v1/customers/{customerId}
Updates a customer account's settings. |
| Methods |
getwatchdetails |
GET /apps/reseller/v1/resellernotify/getwatchdetails
Returns all the details of the watch corresponding to the reseller. |
register |
POST /apps/reseller/v1/resellernotify/register
Registers a Reseller for receiving notifications. |
unregister |
POST /apps/reseller/v1/resellernotify/unregister
Unregisters a Reseller for receiving notifications. |
| Methods |
activate |
POST /apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/activate
Activates a subscription previously suspended by the reseller. |
changePlan |
POST /apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/changePlan
Updates a subscription plan. |
changeRenewalSettings |
POST /apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/changeRenewalSettings
Updates a user license's renewal settings. |
changeSeats |
POST /apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/changeSeats
Updates a subscription's user license settings. |
delete |
DELETE /apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}
Cancels, suspends, or transfers a subscription to direct. |
get |
GET /apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}
Gets a specific subscription. |
insert |
POST /apps/reseller/v1/customers/{customerId}/subscriptions
Creates or transfer a subscription. |
list |
GET /apps/reseller/v1/subscriptions
Lists of subscriptions managed by the reseller. |
startPaidService |
POST /apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/startPaidService
Immediately move a 30-day free trial subscription to a paid service subscription. |
suspend |
POST /apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/suspend
Suspends an active subscription. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-25 UTC.
[null,null,["Last updated 2025-03-25 UTC."],[],[],null,["# Google Workspace Reseller API\n\nPerform common functions that are available on the Channel Services console at scale, like placing orders and viewing customer information\n\n- [REST Resource: v1.customers](#v1.customers)\n- [REST Resource: v1.resellernotify](#v1.resellernotify)\n- [REST Resource: v1.subscriptions](#v1.subscriptions)\n\nService: reseller.googleapis.com\n--------------------------------\n\nTo call this service, we recommend that you use the Google-provided [client libraries](https://cloud.google.com/apis/docs/client-libraries-explained). If your application needs to use your own libraries to call this service, use the following information when you make the API requests.\n\n### Discovery document\n\nA [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:\n\n- \u003chttps://reseller.googleapis.com/$discovery/rest?version=v1\u003e\n\n### Service endpoint\n\nA [service endpoint](https://cloud.google.com/apis/design/glossary#api_service_endpoint) is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:\n\n- `https://reseller.googleapis.com`\n\nREST Resource: [v1.customers](/workspace/admin/reseller/reference/rest/v1/customers)\n------------------------------------------------------------------------------------\n\n| Methods ||\n|------------------------------------------------------------------------|-----------------------------------------------------------------------------------------|\n| [get](/workspace/admin/reseller/reference/rest/v1/customers/get) | `GET /apps/reseller/v1/customers/{customerId}` Gets a customer account. |\n| [insert](/workspace/admin/reseller/reference/rest/v1/customers/insert) | `POST /apps/reseller/v1/customers` Orders a new customer's account. |\n| [patch](/workspace/admin/reseller/reference/rest/v1/customers/patch) | `PATCH /apps/reseller/v1/customers/{customerId}` Updates a customer account's settings. |\n| [update](/workspace/admin/reseller/reference/rest/v1/customers/update) | `PUT /apps/reseller/v1/customers/{customerId}` Updates a customer account's settings. |\n\nREST Resource: [v1.resellernotify](/workspace/admin/reseller/reference/rest/v1/resellernotify)\n----------------------------------------------------------------------------------------------\n\n| Methods ||\n|-----------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|\n| [getwatchdetails](/workspace/admin/reseller/reference/rest/v1/resellernotify/getwatchdetails) | `GET /apps/reseller/v1/resellernotify/getwatchdetails` Returns all the details of the watch corresponding to the reseller. |\n| [register](/workspace/admin/reseller/reference/rest/v1/resellernotify/register) | `POST /apps/reseller/v1/resellernotify/register` Registers a Reseller for receiving notifications. |\n| [unregister](/workspace/admin/reseller/reference/rest/v1/resellernotify/unregister) | `POST /apps/reseller/v1/resellernotify/unregister` Unregisters a Reseller for receiving notifications. |\n\nREST Resource: [v1.subscriptions](/workspace/admin/reseller/reference/rest/v1/subscriptions)\n--------------------------------------------------------------------------------------------\n\n| Methods ||\n|----------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [activate](/workspace/admin/reseller/reference/rest/v1/subscriptions/activate) | `POST /apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/activate` Activates a subscription previously suspended by the reseller. |\n| [changePlan](/workspace/admin/reseller/reference/rest/v1/subscriptions/changePlan) | `POST /apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/changePlan` Updates a subscription plan. |\n| [changeRenewalSettings](/workspace/admin/reseller/reference/rest/v1/subscriptions/changeRenewalSettings) | `POST /apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/changeRenewalSettings` Updates a user license's renewal settings. |\n| [changeSeats](/workspace/admin/reseller/reference/rest/v1/subscriptions/changeSeats) | `POST /apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/changeSeats` Updates a subscription's user license settings. |\n| [delete](/workspace/admin/reseller/reference/rest/v1/subscriptions/delete) | `DELETE /apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}` Cancels, suspends, or transfers a subscription to direct. |\n| [get](/workspace/admin/reseller/reference/rest/v1/subscriptions/get) | `GET /apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}` Gets a specific subscription. |\n| [insert](/workspace/admin/reseller/reference/rest/v1/subscriptions/insert) | `POST /apps/reseller/v1/customers/{customerId}/subscriptions` Creates or transfer a subscription. |\n| [list](/workspace/admin/reseller/reference/rest/v1/subscriptions/list) | `GET /apps/reseller/v1/subscriptions` Lists of subscriptions managed by the reseller. |\n| [startPaidService](/workspace/admin/reseller/reference/rest/v1/subscriptions/startPaidService) | `POST /apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/startPaidService` Immediately move a 30-day free trial subscription to a paid service subscription. |\n| [suspend](/workspace/admin/reseller/reference/rest/v1/subscriptions/suspend) | `POST /apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/suspend` Suspends an active subscription. |"]]
