Loading...

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

Add a Google Workspace Order Using the API

When you want to place a Google Workspace order using the API. This article explains order parameters, billing options, supported plans, and API request details. 

Description

Places a G Suite Order for the specified domain name.

Parameters

Name
Data Type
Required / Optional
Description
auth-userid
Integer
Required
Authentication Parameter
api-key
String
Required
Authentication Parameter
domain-name
String
Required
The domain name for which the Order to be placed
months
Integer
Required
The number of months for which the Order is placed
no-of-accounts
Integer
Required
The number of accounts required
customer-id
Integer
Required
The Customer under whom the Order should be added
auto-renew
Boolean
Optional
Enables / Disables the Autorenewal setting for the Order
invoice-option
String
Required
This parameter will decide how the Customer's Invoice will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice or OnlyAdd.
transfer-token
String
Optional
The Transfer token for the G Suite order.
discount-amount
Float
Optional
Discount amount for the order value.
plan-id
Integer
Optional
If there is no plan-id specified, the order will be provisioned for G Suite Basic

 

HTTP Method
 

POST

 

Example Test URL Request


India
https://test.httpapi.com/api/gapps/in/add.json?auth-userid=0&api-key=key&domain-name=domain.com&customer-id=0&months=0&no-of-accounts=0&invoice-option=NoInvoice&discount-amount=0.00
 
South East Asia & Egypt
https://test.httpapi.com/api/gapps/se/add.json?auth-userid=0&api-key=key&domain-name=domain.com&customer-id=0&months=0&no-of-accounts=0&invoice-option=NoInvoice&discount-amount=0.00
 
Rest of the World
https://test.httpapi.com/api/gapps/gbl/add.json?auth-userid=0&api-key=key&domain-name=domain.com&customer-id=0&months=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 G Suite Order (entityid)
  • Action Type (actiontype)
  • Description of the G Suite Order Add Action (actiontypedesc)
  • Action ID of the G Suite Order Add Action (eaqid)
  • G Suite Order Add Action Status (actionstatus)
  • Description of the G Suite Order Add Action Status (actionstatusdesc)
  • Invoice ID of the G Suite Order Add Invoice (invoiceid)
  • Selling Currency of the Reseller (sellingcurrencysymbol)
  • Transaction Amount in the Selling Currency (sellingamount)
  • Unutilized Transaction Amount in the Selling Currency (unutilisedsellingamount)
  • Customer ID associated with the G Suite Order (customerid)
  • Discount Amount (discount-amount)
NOTE
  • INVOICEID, SELLINGCURRENCYSYMBOL, SELLINGAMOUNT, UNUTILISEDSELLINGAMOUNT and CUSTOMERID will not be returned if INVOICE-OPTION is set to NoInvoice.
  • Currently, we are offering a 40% discount for upto 20 accounts on G Suite Basic Plans. This will be applicable to your account invoice.
In case of any errors, a status key with value as ERROR along with an error message will be returned.