REST Resource: customers

Resource: Customer

When a Google customer's account is registered with a reseller, the customer's subscriptions for Google services are managed by this reseller. A customer is described by a primary domain name and a physical address.

JSON representation
{
  "customerId": string,
  "customerDomain": string,
  "postalAddress": {
    object (Address)
  },
  "phoneNumber": string,
  "alternateEmail": string,
  "resourceUiUrl": string,
  "customerDomainVerified": boolean,
  "kind": string
}
Fields
customerId

string

This property will always be returned in a response as the unique identifier generated by Google. In a request, this property can be either the primary domain or the unique identifier generated by Google.

customerDomain

string

The customer's primary domain name string. customerDomain is required when creating a new customer. Do not include the www prefix in the domain when adding a customer.

postalAddress

object (Address)

A customer's address information. Each field has a limit of 255 charcters.

phoneNumber

string

Customer contact phone number. Must start with "+" followed by the country code. The rest of the number can be contiguous numbers or respect the phone local format conventions, but it must be a real phone number and not, for example, "123". This field is silently ignored if invalid.

alternateEmail

string

Like the "Customer email" in the reseller tools, this email is the secondary contact used if something happens to the customer's service such as service outage or a security issue. This property is required when creating a new customer and should not use the same domain as customerDomain.

resourceUiUrl

string

URL to customer's Admin console dashboard. The read-only URL is generated by the API service. This is used if your client application requires the customer to complete a task in the Admin console.

customerDomainVerified

boolean

Whether the customer's primary domain has been verified.

kind

string

Identifies the resource as a customer. Value: reseller#customer

Address

JSON template for address of a customer.

JSON representation
{
  "countryCode": string,
  "kind": string,
  "region": string,
  "addressLine2": string,
  "locality": string,
  "addressLine3": string,
  "postalCode": string,
  "addressLine1": string,
  "organizationName": string,
  "contactName": string
}
Fields
countryCode

string

For countryCode information, see the ISO 3166 country code elements. Verify that country is approved for resale of Google products. This property is required when creating a new customer.

kind

string

Identifies the resource as a customer address. Value: customers#address

region

string

An example of a region value is CA for the state of California.

addressLine2

string

Line 2 of the address.

locality

string

An example of a locality value is the city of San Francisco.

addressLine3

string

Line 3 of the address.

postalCode

string

A postalCode example is a postal zip code such as 94043. This property is required when creating a new customer.

addressLine1

string

A customer's physical address. An address can be composed of one to three lines. The addressline2 and addressLine3 are optional.

organizationName

string

The company or company division name. This is required.

contactName

string

The customer contact's name. This is required.

Methods

get

Get a customer account.

insert

Order a new customer's account.

patch

Update a customer account's settings.

update

Update a customer account's settings.