Class Subscription

JSON template for a subscription.

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

Properties

BillingMethod

Read-only field that returns the current billing method for a subscription.

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

CreationTime

The creationTime property is the date when subscription was created. It is in milliseconds using the Epoch format. See an example Epoch converter.

Declaration
[JsonProperty("creationTime")]
public virtual long? CreationTime { get; set; }
Property Value
Type Description
long?

CustomerDomain

Primary domain name of the customer

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

CustomerId

This property will always be returned in a response as the unique identifier generated by Google. In a request, this property can be either the primary domain or the unique identifier generated by Google.

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

DealCode

Google-issued code (100 char max) for discounted pricing on subscription plans. Deal code must be included in insert requests in order to receive discounted rate. This property is optional, regular pricing applies if left empty.

Declaration
[JsonProperty("dealCode")]
public virtual string DealCode { 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

Kind

Identifies the resource as a Subscription. Value: reseller#subscription

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

Plan

The plan property is required. In this version of the API, the G Suite plans are the flexible plan, annual commitment plan, and the 30-day free trial plan. For more information about the API"s payment plans, see the API concepts.

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

PurchaseOrderId

This is an optional property. 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.

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

RenewalSettings

Renewal settings for the annual commitment plan. For more detailed information, see renewal options in the administrator help center.

Declaration
[JsonProperty("renewalSettings")]
public virtual RenewalSettings RenewalSettings { get; set; }
Property Value
Type Description
RenewalSettings

ResourceUiUrl

URL to customer's Subscriptions page in the Admin console. The read-only URL is generated by the API service. This is used if your client application requires the customer to complete a task using the Subscriptions page in the Admin console.

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

Seats

This is a required property. The number and limit of user seat licenses in the plan.

Declaration
[JsonProperty("seats")]
public virtual Seats Seats { get; set; }
Property Value
Type Description
Seats

SkuId

A required property. The skuId is a unique system identifier for a product's SKU assigned to a customer in the subscription. For products and SKUs available in this version of the API, see Product and SKU IDs.

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

SkuName

Read-only external display name for a product's SKU assigned to a customer in the subscription. SKU names are subject to change at Google's discretion. For products and SKUs available in this version of the API, see Product and SKU IDs.

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

Status

This is an optional property.

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

SubscriptionId

The subscriptionId is the subscription identifier and is unique for each customer. This is a required property. Since a subscriptionId changes when a subscription is updated, we recommend not using this ID as a key for persistent data. Use the subscriptionId as described in retrieve all reseller subscriptions.

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

SuspensionReasons

Read-only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all pending suspensions are removed. Possible options include: - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the G Suite Resold Terms of Services.

  • RENEWAL_WITH_TYPE_CANCEL - The customer's commitment ended and their service was cancelled at the end of their term. - RESELLER_INITIATED - A manual suspension invoked by a Reseller. - TRIAL_ENDED - The customer's trial expired without a plan selected. - OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise).
Declaration
[JsonProperty("suspensionReasons")]
public virtual IList<string> SuspensionReasons { get; set; }
Property Value
Type Description
IList<string>

TransferInfo

Read-only transfer related information for the subscription. For more information, see retrieve transferable subscriptions for a customer.

Declaration
[JsonProperty("transferInfo")]
public virtual Subscription.TransferInfoData TransferInfo { get; set; }
Property Value
Type Description
Subscription.TransferInfoData

TrialSettings

The G Suite annual commitment and flexible payment plans can be in a 30-day free trial. For more information, see the API concepts.

Declaration
[JsonProperty("trialSettings")]
public virtual Subscription.TrialSettingsData TrialSettings { get; set; }
Property Value
Type Description
Subscription.TrialSettingsData

Implements