GoogleCloudChannelV1alpha1Entitlement

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

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

interface GoogleCloudChannelV1alpha1Entitlement {

assignedUnits?: number;

associationInfo?: GoogleCloudChannelV1alpha1AssociationInfo;

billingAccount?: string;

channelPartnerId?: string;

commitmentSettings?: GoogleCloudChannelV1alpha1CommitmentSettings;

readonly createTime?: Date;

maxUnits?: number;

readonly name?: string;

numUnits?: number;

offer?: string;

parameters?: GoogleCloudChannelV1alpha1Parameter[];

readonly provisionedService?: GoogleCloudChannelV1alpha1ProvisionedService;

readonly provisioningState?:

| "PROVISIONING_STATE_UNSPECIFIED"

| "ACTIVE"

| "CANCELED"

| "COMPLETE"

| "PENDING"

| "SUSPENDED";

purchaseOrderId?: string;

readonly suspensionReasons?:

| "SUSPENSION_REASON_UNSPECIFIED"

| "RESELLER_INITIATED"

| "TRIAL_ENDED"

| "RENEWAL_WITH_TYPE_CANCEL"

| "PENDING_TOS_ACCEPTANCE"

| "OTHER"[];

readonly trialSettings?: GoogleCloudChannelV1alpha1TrialSettings;

readonly updateTime?: Date;

}

§Properties

assignedUnits?: number

[src]

The current number of users that are assigned a license for the product defined in provisioned_service.skuId. Read-only. Deprecated: Use parameters instead.

associationInfo?: GoogleCloudChannelV1alpha1AssociationInfo

[src]

Association information to other entitlements.

billingAccount?: string

[src]

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

channelPartnerId?: string

[src]

Cloud Identity ID of a channel partner who will be the direct reseller for the customer's order. This field is generally used in 2-tier ordering, where the order is placed by a top-level distributor on behalf of their channel partner or reseller. Required for distributors. Deprecated: channel_partner_id has been moved to the Customer.

commitmentSettings?: GoogleCloudChannelV1alpha1CommitmentSettings

[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.

maxUnits?: number

[src]

Maximum number of units for a non commitment-based Offer, such as Flexible, Trial or Free entitlements. For commitment-based entitlements, this is a read-only field, which only the internal support team can update. Deprecated: Use parameters instead.

readonly name?: string

[src]

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

numUnits?: number

[src]

Number of units for a commitment-based Offer. For example, for seat-based Offers, this would be the number of seats; for license-based Offers, this would be the number of licenses. Required for creating commitment-based Offers. Deprecated: Use parameters instead.

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?: GoogleCloudChannelV1alpha1Parameter[]

[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?: GoogleCloudChannelV1alpha1ProvisionedService

[src]

Output only. Service provisioning details for the entitlement.

[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?: GoogleCloudChannelV1alpha1TrialSettings

[src]

Output only. Settings for trial offers.

readonly updateTime?: Date

[src]

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