GoogleCloudChannelV1Entitlement

import type { GoogleCloudChannelV1Entitlement } from "https://googleapis.deno.dev/v1/cloudchannel:v1.ts";

An entitlement is a representation of a customer's ability to use a service.

interface GoogleCloudChannelV1Entitlement {

associationInfo?: GoogleCloudChannelV1AssociationInfo;

billingAccount?: string;

commitmentSettings?: GoogleCloudChannelV1CommitmentSettings;

readonly createTime?: Date;

readonly name?: string;

offer?: string;

parameters?: GoogleCloudChannelV1Parameter[];

readonly provisionedService?: GoogleCloudChannelV1ProvisionedService;

readonly provisioningState?: "PROVISIONING_STATE_UNSPECIFIED" | "ACTIVE" | "SUSPENDED";

purchaseOrderId?: string;

readonly suspensionReasons?:

| "SUSPENSION_REASON_UNSPECIFIED"

| "RESELLER_INITIATED"

| "TRIAL_ENDED"

| "RENEWAL_WITH_TYPE_CANCEL"

| "PENDING_TOS_ACCEPTANCE"

| "OTHER"[];

readonly trialSettings?: GoogleCloudChannelV1TrialSettings;

readonly updateTime?: Date;

}

§Properties

associationInfo?: GoogleCloudChannelV1AssociationInfo

[src]

Association information to other entitlements.

billingAccount?: string

[src]

Optional. The billing account resource name that is used to pay for this entitlement.

commitmentSettings?: GoogleCloudChannelV1CommitmentSettings

[src]

Commitment settings for a commitment-based Offer. Required for commitment based offers.

readonly createTime?: Date

[src]

Output only. The time at which the entitlement is created.

readonly name?: string

[src]

Output only. Resource name of an entitlement in the form: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}.

offer?: string

[src]

Required. The offer resource name for which the entitlement is to be created. Takes the form: accounts/{account_id}/offers/{offer_id}.

parameters?: GoogleCloudChannelV1Parameter[]

[src]

Extended entitlement parameters. When creating an entitlement, valid parameter names and values are defined in the Offer.parameter_definitions. For Google Workspace, the following Parameters may be accepted as input: - max_units: The maximum assignable units for a flexible offer OR - num_units: The total commitment for commitment-based offers The response may additionally include the following output-only Parameters: - assigned_units: The number of licenses assigned to users. For Google Cloud billing subaccounts, the following Parameter may be accepted as input: - display_name: The display name of the billing subaccount.

readonly provisionedService?: GoogleCloudChannelV1ProvisionedService

[src]

Output only. Service provisioning details for the entitlement.

readonly provisioningState?: "PROVISIONING_STATE_UNSPECIFIED" | "ACTIVE" | "SUSPENDED"

[src]

Output only. Current provisioning state of the entitlement.

purchaseOrderId?: string

[src]

Optional. This purchase order (PO) information is for resellers to use for their company tracking usage. If a purchaseOrderId value is given, it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters. This is only supported for Google Workspace entitlements.

[src]

Output only. Enumerable of all current suspension reasons for an entitlement.

readonly trialSettings?: GoogleCloudChannelV1TrialSettings

[src]

Output only. Settings for trial offers.

readonly updateTime?: Date

[src]

Output only. The time at which the entitlement is updated.