REST Resource: accounts.customers.serviceEntitlements

Resource: ServiceEntitlement

A service entitlement represents an entity which provides a resold means to start using a service. A service entitlement can be created only after customer billing account(s) exist. Service entitlements are read-only and updated as part of order execuctions.

JSON representation 
{
  "name": string,
  "billingEntitlements": [
    {
      object(BillingEntitlement)
    }
  ],
  "orderId": string,
  "status": enum(Status),
  "statusReason": string,
  "commitmentSettings": {
    object(CommitmentSettings)
  },
  "renewalType": enum(RenewalType),
  "createTime": string,
  "updateTime": string
}
Fields
name

string

Resource name of a service entitlement of the form: accounts/{account_id}/customers/{customer_id}/serviceEnitlements/{id}

billingEntitlements[]

object(BillingEntitlement)

Billing entitlements to which this service account belongs to. The resource name of billing entitlement is of the form: accounts/{account_id}/customers/{customer_id}/billingEntitlements/{id}

orderId

string

An order id that resulted in the creation of this entitlement.

status

enum(Status)

Status of the service entitlement.

statusReason

string

An explanation of the service entitlement's status.

commitmentSettings

object(CommitmentSettings)

Commitment settings if applicable for the service entitlement.

renewalType

enum(RenewalType)

Renewal settings if applicable for the service entitlement.

createTime

string (Timestamp format)

Read-only.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

Status

Indicates the current state of the entitlement.

Enums
STATUS_UNSPECIFIED Default value. This value should never be returned.
PENDING The entitlement has been created but has not yet begun.
ACTIVE The entitlement is currently active.
COMPLETE The entitlement expired and was not renewed, or was canceled. Once an entitlement is COMPLETE its status will not change.
CANCELED The entitlement was not not fulfilled. Once an entitlement is CANCELED, its status will not change.

Methods

get

 Returns a requested ServiceEntitlement resource.

list

 List ServiceEntitlements belonging to a customer.