Class GoogleCloudPaymentsResellerSubscriptionV1Subscription

A subscription serves as a central billing entity between an external partner and Google. The underlying Google services rely on the subscription state to grant or revoke the user's service entitlement. It's important to note that the subscription state may not always perfectly align with the user's service entitlement. For example, some Google services may continue providing access to the user until the current billing cycle ends, even if the subscription has been immediately canceled. However, other services may not do the same. To fully understand the specific details, please consult the relevant contract or product policy.

Inheritance

object

GoogleCloudPaymentsResellerSubscriptionV1Subscription

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.PaymentsResellerSubscription.v1.Data

Assembly: Google.Apis.PaymentsResellerSubscription.v1.dll

Syntax

public class GoogleCloudPaymentsResellerSubscriptionV1Subscription : IDirectResponseSchema

Properties

CancellationDetails

Output only. Describes the details of a cancelled subscription. Only applicable to subscription of state STATE_CANCELLED.

Declaration

[JsonProperty("cancellationDetails")]
public virtual GoogleCloudPaymentsResellerSubscriptionV1SubscriptionCancellationDetails CancellationDetails { get; set; }

Property Value

Type	Description
GoogleCloudPaymentsResellerSubscriptionV1SubscriptionCancellationDetails

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. System generated timestamp when the subscription is created. UTC timezone.

Declaration

[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }

Property Value

Type	Description
string

CycleEndTime

object representation of CycleEndTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CycleEndTimeDateTimeOffset instead.")]
public virtual object CycleEndTime { get; set; }

Property Value

Type	Description
object

CycleEndTimeDateTimeOffset

DateTimeOffset representation of CycleEndTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? CycleEndTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

CycleEndTimeRaw

Output only. The time at which the subscription is expected to be extended, in ISO 8061 format. UTC timezone. For example: "2019-08-31T17:28:54.564Z"

Declaration

[JsonProperty("cycleEndTime")]
public virtual string CycleEndTimeRaw { 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

EndUserEntitled

Output only. Indicates if the subscription is entitled to the end user.

Declaration

[JsonProperty("endUserEntitled")]
public virtual bool? EndUserEntitled { get; set; }

Property Value

Type	Description
bool?

FreeTrialEndTime

object representation of FreeTrialEndTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use FreeTrialEndTimeDateTimeOffset instead.")]
public virtual object FreeTrialEndTime { get; set; }

Property Value

Type	Description
object

FreeTrialEndTimeDateTimeOffset

DateTimeOffset representation of FreeTrialEndTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? FreeTrialEndTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

FreeTrialEndTimeRaw

Output only. End of the free trial period, in ISO 8061 format. For example, "2019-08-31T17:28:54.564Z". It will be set the same as createTime if no free trial promotion is specified.

Declaration

[JsonProperty("freeTrialEndTime")]
public virtual string FreeTrialEndTimeRaw { get; set; }

Property Value

Type	Description
string

LineItems

Required. The line items of the subscription.

Declaration

[JsonProperty("lineItems")]
public virtual IList<GoogleCloudPaymentsResellerSubscriptionV1SubscriptionLineItem> LineItems { get; set; }

Property Value

Type	Description
IList<GoogleCloudPaymentsResellerSubscriptionV1SubscriptionLineItem>

MigrationDetails

Output only. Describes the details of the migrated subscription. Only populated if this subscription is migrated from another system.

Declaration

[JsonProperty("migrationDetails")]
public virtual GoogleCloudPaymentsResellerSubscriptionV1SubscriptionMigrationDetails MigrationDetails { get; set; }

Property Value

Type	Description
GoogleCloudPaymentsResellerSubscriptionV1SubscriptionMigrationDetails

Name

Identifier. Resource name of the subscription. It will have the format of "partners/{partner_id}/subscriptions/{subscription_id}". This is available for authorizeAddon, but otherwise is response only.

Declaration

[JsonProperty("name")]
public virtual string Name { get; set; }

Property Value

Type	Description
string

PartnerUserToken

Required. Identifier of the end-user in partner’s system. The value is restricted to 63 ASCII characters at the maximum.

Declaration

[JsonProperty("partnerUserToken")]
public virtual string PartnerUserToken { get; set; }

Property Value

Type	Description
string

ProcessingState

Output only. Describes the processing state of the subscription. See more details at the lifecycle of a subscription.

Declaration

[JsonProperty("processingState")]
public virtual string ProcessingState { get; set; }

Property Value

Type	Description
string

Products

Optional. Deprecated: consider using line_items as the input. Required. Resource name that identifies the purchased products. The format will be 'partners/{partner_id}/products/{product_id}'.

Declaration

[JsonProperty("products")]
public virtual IList<string> Products { get; set; }

Property Value

Type	Description
IList<string>

PromotionSpecs

Optional. Subscription-level promotions. Only free trial is supported on this level. It determines the first renewal time of the subscription to be the end of the free trial period. Specify the promotion resource name only when used as input.

Declaration

[JsonProperty("promotionSpecs")]
public virtual IList<GoogleCloudPaymentsResellerSubscriptionV1SubscriptionPromotionSpec> PromotionSpecs { get; set; }

Property Value

Type	Description
IList<GoogleCloudPaymentsResellerSubscriptionV1SubscriptionPromotionSpec>

Promotions

Optional. Deprecated: consider using the top-level promotion_specs as the input. Optional. Resource name that identifies one or more promotions that can be applied on the product. A typical promotion for a subscription is Free trial. The format will be 'partners/{partner_id}/promotions/{promotion_id}'.

Declaration

[JsonProperty("promotions")]
public virtual IList<string> Promotions { get; set; }

Property Value

Type	Description
IList<string>

PurchaseTime

object representation of PurchaseTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use PurchaseTimeDateTimeOffset instead.")]
public virtual object PurchaseTime { get; set; }

Property Value

Type	Description
object

PurchaseTimeDateTimeOffset

DateTimeOffset representation of PurchaseTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? PurchaseTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

PurchaseTimeRaw

Optional. The timestamp when the user transaction was made with the Partner. Specify for the case of "bundle with choice", and it must be before the provision_time (when the user makes a selection).

Declaration

[JsonProperty("purchaseTime")]
public virtual string PurchaseTimeRaw { get; set; }

Property Value

Type	Description
string

RedirectUri

Output only. The place where partners should redirect the end-user to after creation. This field might also be populated when creation failed. However, Partners should always prepare a default URL to redirect the user in case this field is empty.

Declaration

[JsonProperty("redirectUri")]
public virtual string RedirectUri { get; set; }

Property Value

Type	Description
string

RenewalTime

object representation of RenewalTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use RenewalTimeDateTimeOffset instead.")]
public virtual object RenewalTime { get; set; }

Property Value

Type	Description
object

RenewalTimeDateTimeOffset

DateTimeOffset representation of RenewalTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? RenewalTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

RenewalTimeRaw

Output only. The time at which the subscription is expected to be renewed by Google - a new charge will be incurred and the service entitlement will be renewed. A non-immediate cancellation will take place at this time too, before which, the service entitlement for the end user will remain valid. UTC timezone in ISO 8061 format. For example: "2019-08-31T17:28:54.564Z"

Declaration

[JsonProperty("renewalTime")]
public virtual string RenewalTimeRaw { get; set; }

Property Value

Type	Description
string

ServiceLocation

Required. The location that the service is provided as indicated by the partner.

Declaration

[JsonProperty("serviceLocation")]
public virtual GoogleCloudPaymentsResellerSubscriptionV1Location ServiceLocation { get; set; }

Property Value

Type	Description
GoogleCloudPaymentsResellerSubscriptionV1Location

State

Output only. Describes the state of the subscription. See more details at the lifecycle of a subscription.

Declaration

[JsonProperty("state")]
public virtual string State { 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. System generated timestamp when the subscription is most recently updated. UTC timezone.

Declaration

[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }

Property Value

Type	Description
string

UpgradeDowngradeDetails

Optional. Details about the previous subscription that this new subscription upgrades/downgrades from. Only populated if this subscription is an upgrade/downgrade from another subscription.

Declaration

[JsonProperty("upgradeDowngradeDetails")]
public virtual GoogleCloudPaymentsResellerSubscriptionV1SubscriptionUpgradeDowngradeDetails UpgradeDowngradeDetails { get; set; }

Property Value

Type	Description
GoogleCloudPaymentsResellerSubscriptionV1SubscriptionUpgradeDowngradeDetails

Implements

IDirectResponseSchema