Google Workspace Reseller API
Perform common functions that are available on the Channel Services console at scale, like placing orders and viewing customer information
Productivity & workspace#openapi#analytics#media
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Perform common functions that are available on the Channel Services console at scale, like placing orders and viewing customer information
Endpoints 17
customers
- GETGets a customer account
/apps/reseller/v1/customers/:customerIdGets 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… - PUTUpdates a customer account's settings
/apps/reseller/v1/customers/:customerIdUpdates a customer account's settings. You cannot update customerType via the Reseller API, but a "team" customer can verify their domain and become… - PATCHUpdates a customer account's settings
/apps/reseller/v1/customers/:customerIdUpdates a customer account's settings. This method supports patch semantics. You cannot update customerType via the Reseller API, but a "team" customer can… - POSTOrders a new customer's account
/apps/reseller/v1/customers?customerAuthToken=stringOrders a new customer's account. Before ordering a new customer account, establish whether the customer account already exists using the customers.get If the…
resellernotify
- GETReturns all the details of the watch corresponding to the reseller.
/apps/reseller/v1/resellernotify/getwatchdetailsReturns all the details of the watch corresponding to the reseller. - POSTRegisters a Reseller for receiving notifications.
/apps/reseller/v1/resellernotify/register?serviceAccountEmailAddress=stringRegisters a Reseller for receiving notifications. - POSTUnregisters a Reseller for receiving notifications.
/apps/reseller/v1/resellernotify/unregister?serviceAccountEmailAddress=stringUnregisters a Reseller for receiving notifications.
subscriptions
- POSTActivates a subscription previously suspended by the reseller
/apps/reseller/v1/customers/:customerId/subscriptions/:subscriptionId/activateActivates a subscription previously suspended by the reseller. If you did not suspend the customer subscription and it is suspended for any other reason, such… - POSTUpdates a subscription plan
/apps/reseller/v1/customers/:customerId/subscriptions/:subscriptionId/changePlanUpdates 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… - POSTUpdates a user license's renewal settings
/apps/reseller/v1/customers/:customerId/subscriptions/:subscriptionId/changeRenewalSettingsUpdates a user license's renewal settings. This is applicable for accounts with annual commitment plans only. For more information, see the description in… - POSTUpdates a subscription's user license settings
/apps/reseller/v1/customers/:customerId/subscriptions/:subscriptionId/changeSeatsUpdates a subscription's user license settings. For more information about updating an annual commitment plan or a flexible plan subscription’s licenses, see… - GETGets a specific subscription
/apps/reseller/v1/customers/:customerId/subscriptions/:subscriptionIdGets a specific subscription. The subscriptionId can be found using the Retrieve all reseller subscriptions method. For more information about retrieving a… - DELETECancels, suspends, or transfers a subscription to direct.
/apps/reseller/v1/customers/:customerId/subscriptions/:subscriptionId?deletionType=deletion_type_undefinedCancels, suspends, or transfers a subscription to direct. - POSTCreates or transfer a subscription
/apps/reseller/v1/customers/:customerId/subscriptions?action=actionUnspecified&customerAuthToken=string&sourceSkuId=stringCreates 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… - GETLists of subscriptions managed by the reseller
/apps/reseller/v1/subscriptions?customerAuthToken=string&customerId=string&customerNamePrefix=string&maxResults=0&pageToken=stringLists 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… - POSTImmediately move a 30-day free trial subscription to a paid service subscription
/apps/reseller/v1/customers/:customerId/subscriptions/:subscriptionId/startPaidServiceImmediately 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… - POSTSuspends an active subscription
/apps/reseller/v1/customers/:customerId/subscriptions/:subscriptionId/suspendSuspends an active subscription. You can use this method to suspend a paid subscription that is currently in the ACTIVE state. * For FLEXIBLE subscriptions,…
API details
- Base URL
https://reseller.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 2 scopes
An API key in the key query parameter - Operations
- 17 operations on 14 pathsPOST 10GET 4PUT 1PATCH 1DELETE 1
- Main resources
- subscriptions 10customers 4resellernotify 3
- Response formats
application/json- Description format
- Google API Discovery, API version
v1 - Links
- Documentation · OpenAPI document
- Listed from
- Google API Discovery document (googleapis/discovery-artifact-manager) (Apache-2.0)
How to test the Google Workspace Reseller API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Google Workspace Reseller API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 2 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Gets a customer account” (GET /apps/reseller/v1/customers/:customerId), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Google Workspace Reseller API?
Perform common functions that are available on the Channel Services console at scale, like placing orders and viewing customer information It is listed under Productivity & workspace and has 17 endpoints.
Who publishes the Google Workspace Reseller API?
It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Google Workspace Reseller API?
Requests go to https://reseller.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the Google Workspace Reseller API?
It accepts 2 methods: OAuth 2.0 (authorization code flow) with 2 scopes; an API key in the key query parameter.
How many endpoints does the Google Workspace Reseller API have?
17 operations on 14 paths (10 POST, 4 GET, 1 PUT, 1 PATCH, 1 DELETE). The largest groups are subscriptions, customers, resellernotify.
Is forking the Google Workspace Reseller API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.