REST Resource: providers.accounts

Resource: Account

Represents an account that was established by the customer on the service provider's system.

JSON representation 
{
  "name": string,
  "updateTime": string,
  "createTime": string,
  "provider": string,
  "state": enum (AccountState),
  "inputProperties": {
    object
  },
  "approvals": [
    {
      object (Approval)
    }
  ]
}
Fields
name

string

Output only. The resource name of the account. Account names have the form accounts/{account_id}.
updateTime

string (Timestamp format)

Output only. The last update timestamp.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
createTime

string (Timestamp format)

Output only. The creation timestamp.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
provider

string

Output only. The identifier of the service provider that this account was created against. Each service provider is assigned a unique provider value when they onboard with Cloud Commerce platform.
state

enum (AccountState)

Output only. The state of the account. This is used to decide whether the customer is in good standing with the provider and is able to make purchases. An account might not be able to make a purchase if the billing account is suspended, for example.
inputProperties
(deprecated)

object (Struct format)

Output only. The custom properties that were collected from the user to create this account.
approvals[]

object (Approval)

Output only. The approvals for this account. These approvals are used to track actions that are permitted or have been completed by a customer within the context of the provider. This might include a sign up flow or a provisioning step, for example, that the provider can admit to having happened.

AccountState

AccountState indicates the current status of the account.

Enums
ACCOUNT_STATE_UNSPECIFIED Default state of the account. It's only set to this value when the account is first created and has not been initialized.
ACCOUNT_ACTIVATION_REQUESTED

The customer has requested the creation of the account resource, and the provider notification message is dispatched.

This state has been deprecated, as accounts now immediately transition to AccountState.ACCOUNT_ACTIVE.
ACCOUNT_ACTIVE

The account is active and ready for use.

The next possible states are: - Account getting deleted: After the user invokes delete from another API.

Approval

An approval for some action on an account.

JSON representation 
{
  "name": string,
  "state": enum (State),
  "reason": string,
  "updateTime": string
}
Fields
name

string

Output only. The name of the approval.
state

enum (State)

Output only. The state of the approval.
reason

string

Output only. An explanation for the state of the approval.
updateTime

string (Timestamp format)

Optional. The last update timestamp of the approval.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

State

The current status of an approval.

Enums
STATE_UNSPECIFIED Sentinel value; do not use.
PENDING

The approval is pending response from the provider.

The approval state can transition to Account.Approval.State.APPROVED or Account.Approval.State.REJECTED.
APPROVED The approval has been granted by the provider.
REJECTED

The approval has been rejected by the provider.

A provider may choose to approve a previously rejected approval, so is it possible to transition to Account.Approval.State.APPROVED.

Methods

approve

 Grants an approval on an Account.

get

 Gets a requested Account resource.

list

 Lists Accounts that the provider has access to.

reject

 Rejects an approval on an Account.

reset

 Resets an Account and cancels all associated Entitlements.