Class Entitlement

Represents a procured product of a customer.

Inheritance
object
Entitlement
Implements
Inherited Members
Namespace: Google.Apis.CloudCommercePartnerProcurementService.v1.Data
Assembly: Google.Apis.CloudCommercePartnerProcurementService.v1.dll
Syntax
public class Entitlement : IDirectResponseSchema

Properties

Account

Output only. The resource name of the account that this entitlement is based on, if any.

Declaration
[JsonProperty("account")]
public virtual string Account { get; set; }
Property Value
Type Description
string

CancellationReason

Output only. The reason the entitlement was cancelled. If this entitlement wasn't cancelled, this field is empty. Possible values include "unknown", "expired", "user-cancelled", "account-closed", "billing-disabled" (if the customer has manually disabled billing to their resources), "user-aborted", and "migrated" (if the entitlement has migrated across products). Values of this field are subject to change, and we recommend that you don't build your technical integration to rely on these fields.

Declaration
[JsonProperty("cancellationReason")]
public virtual string CancellationReason { get; set; }
Property Value
Type Description
string

Consumers

Output only. The resources using this entitlement, if applicable.

Declaration
[JsonProperty("consumers")]
public virtual IList<Consumer> Consumers { get; set; }
Property Value
Type Description
IList<Consumer>

CreateTime

object representation of CreateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CreateTimeRaw

Output only. The creation timestamp.

Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

EntitlementBenefitIds

Output only. The entitlement benefit IDs associated with the purchase.

Declaration
[JsonProperty("entitlementBenefitIds")]
public virtual IList<string> EntitlementBenefitIds { get; set; }
Property Value
Type Description
IList<string>

InputProperties

Output only. The custom properties that were collected from the user to create this entitlement.

Declaration
[JsonProperty("inputProperties")]
public virtual IDictionary<string, object> InputProperties { get; set; }
Property Value
Type Description
IDictionary<string, object>

MessageToUser

Provider-supplied message that is displayed to the end user. Currently this is used to communicate progress and ETA for provisioning. This field can be updated only when a user is waiting for an action from the provider, i.e. entitlement state is EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED or EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL. This field is cleared automatically when the entitlement state changes.

Declaration
[JsonProperty("messageToUser")]
public virtual string MessageToUser { get; set; }
Property Value
Type Description
string

Name

Output only. The resource name of the entitlement. Entitlement names have the form providers/{provider_id}/entitlements/{entitlement_id}.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

NewOfferEndTime

object representation of NewOfferEndTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use NewOfferEndTimeDateTimeOffset instead.")]
public virtual object NewOfferEndTime { get; set; }
Property Value
Type Description
object

NewOfferEndTimeDateTimeOffset

DateTimeOffset representation of NewOfferEndTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? NewOfferEndTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

NewOfferEndTimeRaw

Output only. The end time of the new offer, determined from the offer's specified end date. If the offer des not have a specified end date then this field is not set. This field is populated even if the entitlement isn't active yet. If there's no upcoming offer, the field is empty. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE, or ENTITLEMENT_PENDING_CANCELLATION, then this field is empty. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE, and the upcoming offer has a specified end date, then this field is populated with the expected end time of the upcoming offer, in the future. Otherwise, this field is empty. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this field is empty.

Declaration
[JsonProperty("newOfferEndTime")]
public virtual string NewOfferEndTimeRaw { get; set; }
Property Value
Type Description
string

NewOfferStartTime

object representation of NewOfferStartTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use NewOfferStartTimeDateTimeOffset instead.")]
public virtual object NewOfferStartTime { get; set; }
Property Value
Type Description
object

NewOfferStartTimeDateTimeOffset

DateTimeOffset representation of NewOfferStartTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? NewOfferStartTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

NewOfferStartTimeRaw

Output only. The timestamp when the new offer becomes effective. This field is populated even if the entitlement isn't active yet. If there's no upcoming offer, the field is empty. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, this field isn't populated when the entitlement isn't yet approved. After the entitlement is approved, this field is populated with the effective time of the upcoming offer. * If the entitlement is in the state ENTITLEMENT_ACTIVE or ENTITLEMENT_PENDING_CANCELLATION, this field isn't populated. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL, this field isn't populated, because the entitlement change is waiting on approval. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE, this field is populated with the expected effective time of the upcoming offer, which is in the future. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this field is empty.

Declaration
[JsonProperty("newOfferStartTime")]
public virtual string NewOfferStartTimeRaw { get; set; }
Property Value
Type Description
string

NewPendingOffer

Output only. Upon a pending plan change, the name of the offer that the entitlement is switching to. Only exists if the pending plan change is moving to an offer. This field isn't populated for entitlements which aren't active yet. Format: 'projects/{project}/services/{service}/privateOffers/{offer}' OR 'projects/{project}/services/{service}/standardOffers/{offer}', depending on whether the offer is private or public. The {service} in the name is the listing service of the offer. It could be either the product service that the offer is referencing, or a generic private offer parent service. We recommend that you don't build your integration to rely on the meaning of this {service} part. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE or ENTITLEMENT_PENDING_CANCELLATION, then this field is empty. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE, then this field is populated with the upcoming offer. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this is empty.

Declaration
[JsonProperty("newPendingOffer")]
public virtual string NewPendingOffer { get; set; }
Property Value
Type Description
string

NewPendingOfferDuration

Output only. The duration of the new offer, in ISO 8601 duration format. This field is populated for pending offer changes. It isn't populated for entitlements which aren't active yet. If the offer has a specified end date instead of a duration, this field is empty. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE, or ENTITLEMENT_PENDING_CANCELLATION, this field is empty. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE, and the upcoming offer doesn't have a specified end date, then this field is populated with the duration of the upcoming offer. Otherwise, this field is empty. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this field is empty.

Declaration
[JsonProperty("newPendingOfferDuration")]
public virtual string NewPendingOfferDuration { get; set; }
Property Value
Type Description
string

NewPendingPlan

Output only. The identifier of the pending new plan. Required if the product has plans and the entitlement has a pending plan change.

Declaration
[JsonProperty("newPendingPlan")]
public virtual string NewPendingPlan { get; set; }
Property Value
Type Description
string

Offer

Output only. The name of the offer that was procured. Field is empty if order wasn't made using an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer}' OR 'projects/{project}/services/{service}/standardOffers/{offer}', depending on whether the offer is private or public. The {service} in the name is the listing service of the offer. It could be either the product service that the offer is referencing, or a generic private offer parent service. We recommend that you don't build your integration to rely on the meaning of this {service} part. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, this field is populated with the upcoming offer. * If the entitlement is in the state ENTITLEMENT_ACTIVE, ENTITLEMENT_PENDING_CANCELLATION, ENTITLEMENT_PENDING_PLAN_CHANGE, or ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL, this field is populated with the current offer. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this field is populated with the latest offer that the order was associated with.

Declaration
[JsonProperty("offer")]
public virtual string Offer { get; set; }
Property Value
Type Description
string

OfferDuration

Output only. The offer duration of the current offer, in ISO 8601 duration format. This is empty if the entitlement wasn't made using an offer, or if the offer has a specified end date instead of a duration. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, and the upcoming offer doesn't have a specified end date, then this field is populated with the duration of the upcoming offer. Otherwise, this field is empty. * If the entitlement is in the state ENTITLEMENT_ACTIVE, ENTITLEMENT_PENDING_CANCELLATION, ENTITLEMENT_PENDING_PLAN_CHANGE, or ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL, and the current offer doesn't have a specified end date, then this field contains the duration of the current offer. Otherwise, this field is empty. * If the entitlement is in the state ENTITLEMENT_CANCELLED, and the offer doesn't have a specified end date, then this field is populated with the duration of the latest offer that the order was associated with. Otherwise, this field is empty.

Declaration
[JsonProperty("offerDuration")]
public virtual string OfferDuration { get; set; }
Property Value
Type Description
string

OfferEndTime

object representation of OfferEndTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use OfferEndTimeDateTimeOffset instead.")]
public virtual object OfferEndTime { get; set; }
Property Value
Type Description
object

OfferEndTimeDateTimeOffset

DateTimeOffset representation of OfferEndTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? OfferEndTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

OfferEndTimeRaw

Output only. End time for the current term of the Offer associated with this entitlement. The value of this field can change naturally over time due to auto-renewal, even if the offer isn't changed. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, then: * If the entitlement isn't approved yet approved, and the offer has a specified end date, then this field is populated with the expected end time of the upcoming offer, in the future. Otherwise, this field is empty. * If the entitlement is approved, then this field is populated with the expected end time of the upcoming offer, in the future. This means that this field and the field offer_duration can both exist. * If the entitlement is in the state ENTITLEMENT_ACTIVE or ENTITLEMENT_PENDING_CANCELLATION, then this field is populated with the expected end time of the current offer, in the future. This field's value is set regardless of whether the offer has a specific end date or a duration. This means that this field and the field offer_duration can both exist. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE: * If the entitlement's pricing model is usage based and the associated offer is a private offer whose term has ended, then this field reflects the ACTUAL end time of the entitlement's associated offer (in the past), even though the entitlement associated with this private offer does not terminate at the end of that private offer's term. * Otherwise, this is the expected end date of the current offer, in the future. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this field is populated with the end time, in the past, of the latest offer that the order was associated with. If the entitlement was cancelled before any offer started, then this field is empty.

Declaration
[JsonProperty("offerEndTime")]
public virtual string OfferEndTimeRaw { get; set; }
Property Value
Type Description
string

OrderId

Output only. The order ID of this entitlement, without any orders/ resource name prefix.

Declaration
[JsonProperty("orderId")]
public virtual string OrderId { get; set; }
Property Value
Type Description
string

Plan

Output only. The identifier of the plan that was procured. Required if the product has plans.

Declaration
[JsonProperty("plan")]
public virtual string Plan { get; set; }
Property Value
Type Description
string

Product

Output only. The identifier of the entity that was purchased. This may actually represent a product, quote, or offer. We strongly recommend that you use the following more explicit fields: productExternalName, quoteExternalName, or offer.

Declaration
[JsonProperty("product")]
public virtual string Product { get; set; }
Property Value
Type Description
string

ProductExternalName

Output only. The identifier of the product that was procured.

Declaration
[JsonProperty("productExternalName")]
public virtual string ProductExternalName { get; set; }
Property Value
Type Description
string

Provider

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

Declaration
[JsonProperty("provider")]
public virtual string Provider { get; set; }
Property Value
Type Description
string

QuoteExternalName

Output only. The identifier of the quote that was used to procure. Empty if the order is not purchased using a quote.

Declaration
[JsonProperty("quoteExternalName")]
public virtual string QuoteExternalName { get; set; }
Property Value
Type Description
string

State

Output only. The state of the entitlement.

Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type Description
string

SubscriptionEndTime

object representation of SubscriptionEndTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use SubscriptionEndTimeDateTimeOffset instead.")]
public virtual object SubscriptionEndTime { get; set; }
Property Value
Type Description
object

SubscriptionEndTimeDateTimeOffset

DateTimeOffset representation of SubscriptionEndTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? SubscriptionEndTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

SubscriptionEndTimeRaw

Output only. End time for the subscription corresponding to this entitlement.

Declaration
[JsonProperty("subscriptionEndTime")]
public virtual string SubscriptionEndTimeRaw { get; set; }
Property Value
Type Description
string

UpdateTime

object representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }
Property Value
Type Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

UpdateTimeRaw

Output only. The last update timestamp.

Declaration
[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }
Property Value
Type Description
string

UsageReportingId

Output only. The consumerId to use when reporting usage through the Service Control API. See the consumerId field at Reporting Metrics for more details. This field is present only if the product has usage-based billing configured.

Declaration
[JsonProperty("usageReportingId")]
public virtual string UsageReportingId { get; set; }
Property Value
Type Description
string

Implements