AssociatedAccountDetails

JSON representation
{
  "accountNickname": {
    object (AssociatedAccountNickname)
  },
  "accountAlias": {
    object (AccountAlias)
  },
  "accountType": {
    object (AccountType)
  }
}
Fields
accountNickname

object (AssociatedAccountNickname)

Nickname by which the user knows this account for display purposes.

accountAlias

object (AccountAlias)

OPTIONAL: An additional account alias the user might use to identify their vendor account. These are used by Google customer operation agents to help customers diagnose issues. These aliases should be user recognizable (for example the user knows this alias because it appears on their statement or appears on the website after they log into the account).

accountType

object (AccountType)

OPTIONAL: Account type information that will be used to tailor display messages to users. For example, this could contain information about the payment plan the user has with the integrator for this account.

AssociatedAccountNickname

JSON representation
{

  // Union field account_names can be only one of the following:
  "partialAccountNickname": string,
  "fullAccountNickname": string
  // End of list of possible types for union field account_names.
}
Fields

Union field account_names.

account_names can be only one of the following:

partialAccountNickname

string

String by which the user knows this account for display purposes. This is a suffix of the account nickname. For example last four digits of a phone number. Google will indicate in the user interface that this is only a suffix of the nickname.

This value will be displayed in UIs like the purchase flow to allow the user to distinguish between payment methods.

fullAccountNickname

string

String by which the user knows this account for display purposes. Unlike accountNickname this is the full account nickname. For example 56565-56501 for a phone number or sally@sample-email.com for an email identity.

This value will be displayed in UIs like the purchase flow to allow the user to distinguish between payment methods.

AccountAlias

Defines the type and value of an alias that a user associates with their vendor account.

JSON representation
{

  // Union field account_alias can be only one of the following:
  "phoneNumber": {
    object (PhoneNumber)
  },
  "emailAddress": string
  // End of list of possible types for union field account_alias.
}
Fields
Union field account_alias. REQUIRED: An account alias the user has with the integrator. account_alias can be only one of the following:
phoneNumber

object (PhoneNumber)

The phone number the user has on file with the integrator.

emailAddress

string

The email address the user has on file with the integrator.

PhoneNumber

An E.164 formatted phone number. Examples include +14035551111 and +918067218000. This will always lead with a + and include only numbers afterwards (no dashes).

JSON representation
{
  "value": string
}
Fields
value

string

REQUIRED: This is a E.164 formatted phone number. Examples include +14035551111 and +918067218000. This will always lead with a + and include only numbers afterwards (no dashes).

AccountType

JSON representation
{

  // Union field account_type can be only one of the following:
  "wirelessCarrierAccountType": {
    object (WirelessCarrierAccountType)
  }
  // End of list of possible types for union field account_type.
}
Fields

Union field account_type.

account_type can be only one of the following:

wirelessCarrierAccountType

object (WirelessCarrierAccountType)

WirelessCarrierAccountType

The account type the user has with a wireless carrier. This is used to tailor display messages to the users. For example, the payment dialog for a user with a prepaid plan may say "deduct from your carrier balance", rather than "bill to your carrier account."

JSON representation
{

  // Union field carrier_account_type can be only one of the following:
  "prepaid": {
    object (Empty)
  },
  "postpaid": {
    object (Empty)
  },
  "enterprise": {
    object (Empty)
  },
  "willNotProvidePii": {
    object (Empty)
  },
  "controlPlan": {
    object (Empty)
  }
  // End of list of possible types for union field carrier_account_type.
}
Fields

Union field carrier_account_type.

carrier_account_type can be only one of the following:

prepaid

object (Empty)

Indicates the user is on a prepaid payment plan with their wireless carrier (e.g. the user pays for the coming month). Payments made with this account will be deducted from the prepaid balance.

postpaid

object (Empty)

Indicates the user is on a postpaid payment plan with their wireless carrier (e.g. the user pays for the prior month). Payments made with this account will accrue until the balance is paid off.

enterprise

object (Empty)

Indicates the user is part of an enterprise wireless plan (e.g. the user is on a shared corporate phone plan).

willNotProvidePii

object (Empty)

Indicates the carrier will not provide this information because a user's payment plan is considered PII, or because the carrier is otherwise legally obligated not to share this information.

controlPlan

object (Empty)

Indicates the user is on a control plan with their wireless carrier. This could be a payment plan where the user pays the same monthly fee, and calls or charges made against by the user are debited from this monthly fee. Once the monthly fee amount is exhausted, certain services are limited or disabled unless the user makes a mid-cycle payment to re-enable these services.