REST リソース: accounts.customers.serviceEntitlements

リソース: ServiceEntitlement

サービス エンタイトルメントは、サービスの使用を開始するための再販手段を提供するエンティティを表します。サービス エンタイトルメントは、顧客課金アカウントが存在する場合にのみ作成できます。サービス エンタイトルメントは読み取り専用で、注文の実行の一部として更新されます。

JSON 表現 

{
  "name": string,
  "billingEntitlements": [
    {
      object(BillingEntitlement)
    }
  ],
  "orderId": string,
  "status": enum(Status),
  "statusReason": string,
  "commitmentSettings": {
    object(CommitmentSettings)
  },
  "renewalType": enum(RenewalType),
  "createTime": string,
  "updateTime": string
}
フィールド
name

string

サービス エンタイトルメントのリソース名。形式は accounts/{account_id}/customers/{customer_id}/serviceEnitlements/{id} です。

billingEntitlements[]

object(BillingEntitlement)

このサービス アカウントが属する請求エンタイトルメント。請求エンタイトルメントのリソース名の形式は accounts/{account_id}/customers/{customer_id}/billingEntitlements/{id} です。

orderId

string

このエンタイトルメントを作成した注文 ID。

status

enum(Status)

サービス エンタイトルメントのステータス。

statusReason

string

サービス エンタイトルメントのステータスの説明。

commitmentSettings

object(CommitmentSettings)

サービス エンタイトルメントのコミットメント設定（該当する場合）。

renewalType

enum(RenewalType)

サービス エンタイトルメントの更新設定（該当する場合）。

createTime

string（Timestamp 形式）

読み取り専用。

RFC3339 UTC 「ズールー」形式でナノ秒の精度のタイムスタンプ。例: "2014-10-02T15:01:23.045123456Z"
updateTime

string（Timestamp 形式）

RFC3339 UTC「ズールー」形式でナノ秒の精度のタイムスタンプ。例: "2014-10-02T15:01:23.045123456Z"

ステータス

エンタイトルメントの現在の状態を示します。

列挙型
STATUS_UNSPECIFIED デフォルト値。この値が戻されてはいけません。
PENDING エンタイトルメントが作成されましたが、まだ開始されていません。
ACTIVE エンタイトルメントは現在アクティブです。
COMPLETE エンタイトルメントが失効し、更新されなかったか、またはキャンセルされました。エンタイトルメントが COMPLETE になった場合、このステータスが変更されることはありません。
CANCELED エンタイトルメントは処理されませんでした。エンタイトルメントが CANCELED になった場合、このステータスが変更されることはありません。

メソッド

get

 リクエストされた ServiceEntitlement リソースを返します。

list

 ある顧客に属する ServiceEntitlement のリストを取得します。