Loading...

Knowledge Base
Home 
 
/
 Add Google Workspace Accounts Using the API
Categories: Google Workspace API

Add Google Workspace Accounts Using the API

When you want to add additional accounts to an existing Google Workspace order using the API. This article explains account parameters, billing options, and API request details for account addition.

Add Accounts

 

Description

Places additional accounts under an existing Google Workspace Order.

Parameters

NameData TypeRequired / OptionalDescription
auth-useridIntegerRequiredAuthentication Parameter
api-keyStringRequiredAuthentication Parameter
order-idIntegerRequiredThe OrderId under which the accounts are to be added.
no-of-accountsIntegerRequiredThe number of accounts required
invoice-optionStringRequiredThis parameter will decide how the Customer's Invoice will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice or OnlyAdd.
discount-amountFloatOptionalDiscount amount for the order value.

HTTP Method

POST

Example Test URL Request

India

https://test.httpapi.com/api/gapps/in/add-account.json?auth-userid=0&api-key=key&order-id=0&no-of-accounts=0&invoice-option=NoInvoice&discount-amount=0.00

South East Asia & Egypt

https://test.httpapi.com/api/gapps/se/add-account.json?auth-userid=0&api-key=key&order-id=0&no-of-accounts=0&invoice-option=NoInvoice&discount-amount=0.00

Rest of the World

https://test.httpapi.com/api/gapps/gbl/add-account.json?auth-userid=0&api-key=key&order-id=0&no-of-accounts=0&invoice-option=NoInvoice&discount-amount=0.00

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order Id of the Google Workspace Order (entityid)

  • Action Type (actiontype)

  • Description of the Accounts Addition Action (actiontypedesc)

  • Action Id of the Accounts Addition Action (eaqid)

  • Accounts Addition Action Status (actionstatus)

  • Description of the Accounts Addition Action Status (actionstatusdesc)

  • Invoice Id of the Domain Renewal Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Selling Curreny Amount (sellingamount)

  • Customer Id associated with the Domain Name Order (customerid)

  • Discount Amount (discount-amount)

Note

invoiceid, sellingcurrencysymbol, sellingamount and customerid will not be returned if invoice-option is set to NoInvoice.

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.