Subscription (Enterprise Apps Reseller API v1 (Rev. 81) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.reseller.model.Subscription

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class Subscription
extends com.google.api.client.json.GenericJson
```
JSON template for a subscription.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Enterprise Apps Reseller API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Subscription.Plan` The plan property is required.
`static class`	`Subscription.TransferInfo` Read-only transfer related information for the subscription.
`static class`	`Subscription.TrialSettings` The G Suite annual commitment and flexible payment plans can be in a 30-day free trial.

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap
java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map
java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Subscription()

Constructors
Constructor and Description
`Subscription()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Subscription`	`clone()`
`java.lang.String`	`getBillingMethod()` Read-only field that returns the current billing method for a subscription.
`java.lang.Long`	`getCreationTime()` The creationTime property is the date when subscription was created.
`java.lang.String`	`getCustomerDomain()` Primary domain name of the customer
`java.lang.String`	`getCustomerId()` This property will always be returned in a response as the unique identifier generated by Google.
`java.lang.String`	`getDealCode()` Google-issued code (100 char max) for discounted pricing on subscription plans.
`java.lang.String`	`getKind()` Identifies the resource as a Subscription.
`Subscription.Plan`	`getPlan()` The plan property is required.
`java.lang.String`	`getPurchaseOrderId()` This is an optional property.
`RenewalSettings`	`getRenewalSettings()` Renewal settings for the annual commitment plan.
`java.lang.String`	`getResourceUiUrl()` URL to customer's Subscriptions page in the Admin console.
`Seats`	`getSeats()` This is a required property.
`java.lang.String`	`getSkuId()` A required property.
`java.lang.String`	`getSkuName()` Read-only external display name for a product's SKU assigned to a customer in the subscription.
`java.lang.String`	`getStatus()` This is an optional property.
`java.lang.String`	`getSubscriptionId()` The subscriptionId is the subscription identifier and is unique for each customer.
`java.util.List<java.lang.String>`	`getSuspensionReasons()` Read-only field containing an enumerable of all the current suspension reasons for a subscription.
`Subscription.TransferInfo`	`getTransferInfo()` Read-only transfer related information for the subscription.
`Subscription.TrialSettings`	`getTrialSettings()` The G Suite annual commitment and flexible payment plans can be in a 30-day free trial.
`Subscription`	`set(java.lang.String fieldName, java.lang.Object value)`
`Subscription`	`setBillingMethod(java.lang.String billingMethod)` Read-only field that returns the current billing method for a subscription.
`Subscription`	`setCreationTime(java.lang.Long creationTime)` The creationTime property is the date when subscription was created.
`Subscription`	`setCustomerDomain(java.lang.String customerDomain)` Primary domain name of the customer
`Subscription`	`setCustomerId(java.lang.String customerId)` This property will always be returned in a response as the unique identifier generated by Google.
`Subscription`	`setDealCode(java.lang.String dealCode)` Google-issued code (100 char max) for discounted pricing on subscription plans.
`Subscription`	`setKind(java.lang.String kind)` Identifies the resource as a Subscription.
`Subscription`	`setPlan(Subscription.Plan plan)` The plan property is required.
`Subscription`	`setPurchaseOrderId(java.lang.String purchaseOrderId)` This is an optional property.
`Subscription`	`setRenewalSettings(RenewalSettings renewalSettings)` Renewal settings for the annual commitment plan.
`Subscription`	`setResourceUiUrl(java.lang.String resourceUiUrl)` URL to customer's Subscriptions page in the Admin console.
`Subscription`	`setSeats(Seats seats)` This is a required property.
`Subscription`	`setSkuId(java.lang.String skuId)` A required property.
`Subscription`	`setSkuName(java.lang.String skuName)` Read-only external display name for a product's SKU assigned to a customer in the subscription.
`Subscription`	`setStatus(java.lang.String status)` This is an optional property.
`Subscription`	`setSubscriptionId(java.lang.String subscriptionId)` The subscriptionId is the subscription identifier and is unique for each customer.
`Subscription`	`setSuspensionReasons(java.util.List<java.lang.String> suspensionReasons)` Read-only field containing an enumerable of all the current suspension reasons for a subscription.
`Subscription`	`setTransferInfo(Subscription.TransferInfo transferInfo)` Read-only transfer related information for the subscription.
`Subscription`	`setTrialSettings(Subscription.TrialSettings trialSettings)` The G Suite annual commitment and flexible payment plans can be in a 30-day free trial.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Subscription
```
public Subscription()
```
- Method Detail
  - getBillingMethod
```
public java.lang.String getBillingMethod()
```
    Read-only field that returns the current billing method for a subscription.
    
    Returns:
    
    value or null for none
  - setBillingMethod
```
public Subscription setBillingMethod(java.lang.String billingMethod)
```
    Read-only field that returns the current billing method for a subscription.
    
    Parameters:
    
    billingMethod - billingMethod or null for none
  - getCreationTime
```
public java.lang.Long getCreationTime()
```
    The creationTime property is the date when subscription was created. It is in milliseconds using the Epoch format. See an example Epoch converter.
    
    Returns:
    
    value or null for none
  - setCreationTime
```
public Subscription setCreationTime(java.lang.Long creationTime)
```
    The creationTime property is the date when subscription was created. It is in milliseconds using the Epoch format. See an example Epoch converter.
    
    Parameters:
    
    creationTime - creationTime or null for none
  - getCustomerDomain
```
public java.lang.String getCustomerDomain()
```
    Primary domain name of the customer
    
    Returns:
    
    value or null for none
  - setCustomerDomain
```
public Subscription setCustomerDomain(java.lang.String customerDomain)
```
    Primary domain name of the customer
    
    Parameters:
    
    customerDomain - customerDomain or null for none
  - getCustomerId
```
public java.lang.String getCustomerId()
```
    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.
    
    Returns:
    
    value or null for none
  - setCustomerId
```
public Subscription setCustomerId(java.lang.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.
    
    Parameters:
    
    customerId - customerId or null for none
  - getDealCode
```
public java.lang.String getDealCode()
```
    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.
    
    Returns:
    
    value or null for none
  - setDealCode
```
public Subscription setDealCode(java.lang.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.
    
    Parameters:
    
    dealCode - dealCode or null for none
  - getKind
```
public java.lang.String getKind()
```
    Identifies the resource as a Subscription. Value: reseller#subscription
    
    Returns:
    
    value or null for none
  - setKind
```
public Subscription setKind(java.lang.String kind)
```
    Identifies the resource as a Subscription. Value: reseller#subscription
    
    Parameters:
    
    kind - kind or null for none
  - getPlan
```
public Subscription.Plan getPlan()
```
    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.
    
    Returns:
    
    value or null for none
  - setPlan
```
public Subscription setPlan(Subscription.Plan 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.
    
    Parameters:
    
    plan - plan or null for none
  - getPurchaseOrderId
```
public java.lang.String getPurchaseOrderId()
```
    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.
    
    Returns:
    
    value or null for none
  - setPurchaseOrderId
```
public Subscription setPurchaseOrderId(java.lang.String 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.
    
    Parameters:
    
    purchaseOrderId - purchaseOrderId or null for none
  - getRenewalSettings
```
public RenewalSettings getRenewalSettings()
```
    Renewal settings for the annual commitment plan. For more detailed information, see renewal options in the administrator help center.
    
    Returns:
    
    value or null for none
  - setRenewalSettings
```
public Subscription setRenewalSettings(RenewalSettings renewalSettings)
```
    Renewal settings for the annual commitment plan. For more detailed information, see renewal options in the administrator help center.
    
    Parameters:
    
    renewalSettings - renewalSettings or null for none
  - getResourceUiUrl
```
public java.lang.String getResourceUiUrl()
```
    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.
    
    Returns:
    
    value or null for none
  - setResourceUiUrl
```
public Subscription setResourceUiUrl(java.lang.String 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.
    
    Parameters:
    
    resourceUiUrl - resourceUiUrl or null for none
  - getSeats
```
public Seats getSeats()
```
    This is a required property. The number and limit of user seat licenses in the plan.
    
    Returns:
    
    value or null for none
  - setSeats
```
public Subscription setSeats(Seats seats)
```
    This is a required property. The number and limit of user seat licenses in the plan.
    
    Parameters:
    
    seats - seats or null for none
  - getSkuId
```
public java.lang.String getSkuId()
```
    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.
    
    Returns:
    
    value or null for none
  - setSkuId
```
public Subscription setSkuId(java.lang.String 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.
    
    Parameters:
    
    skuId - skuId or null for none
  - getSkuName
```
public java.lang.String getSkuName()
```
    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.
    
    Returns:
    
    value or null for none
  - setSkuName
```
public Subscription setSkuName(java.lang.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.
    
    Parameters:
    
    skuName - skuName or null for none
  - getStatus
```
public java.lang.String getStatus()
```
    This is an optional property.
    
    Returns:
    
    value or null for none
  - setStatus
```
public Subscription setStatus(java.lang.String status)
```
    This is an optional property.
    
    Parameters:
    
    status - status or null for none
  - getSubscriptionId
```
public java.lang.String getSubscriptionId()
```
    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.
    
    Returns:
    
    value or null for none
  - setSubscriptionId
```
public Subscription setSubscriptionId(java.lang.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.
    
    Parameters:
    
    subscriptionId - subscriptionId or null for none
  - getSuspensionReasons
```
public java.util.List<java.lang.String> getSuspensionReasons()
```
    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).
    
    Returns:
    
    value or null for none
  - setSuspensionReasons
```
public Subscription setSuspensionReasons(java.util.List<java.lang.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).
    
    Parameters:
    
    suspensionReasons - suspensionReasons or null for none
  - getTransferInfo
```
public Subscription.TransferInfo getTransferInfo()
```
    Read-only transfer related information for the subscription. For more information, see retrieve transferable subscriptions for a customer.
    
    Returns:
    
    value or null for none
  - setTransferInfo
```
public Subscription setTransferInfo(Subscription.TransferInfo transferInfo)
```
    Read-only transfer related information for the subscription. For more information, see retrieve transferable subscriptions for a customer.
    
    Parameters:
    
    transferInfo - transferInfo or null for none
  - getTrialSettings
```
public Subscription.TrialSettings getTrialSettings()
```
    The G Suite annual commitment and flexible payment plans can be in a 30-day free trial. For more information, see the API concepts.
    
    Returns:
    
    value or null for none
  - setTrialSettings
```
public Subscription setTrialSettings(Subscription.TrialSettings 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.
    
    Parameters:
    
    trialSettings - trialSettings or null for none
  - set
```
public Subscription set(java.lang.String fieldName,
                        java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Subscription clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Enterprise Apps Reseller API v1 (revision 81)

Class Subscription

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Subscription

Method Detail

getBillingMethod

setBillingMethod

getCreationTime

setCreationTime

getCustomerDomain

setCustomerDomain

getCustomerId

setCustomerId

getDealCode

setDealCode

getKind

setKind

getPlan

setPlan

getPurchaseOrderId

setPurchaseOrderId

getRenewalSettings

setRenewalSettings

getResourceUiUrl

setResourceUiUrl

getSeats

setSeats

getSkuId

setSkuId

getSkuName

setSkuName

getStatus

setStatus

getSubscriptionId

setSubscriptionId

getSuspensionReasons

setSuspensionReasons

getTransferInfo

setTransferInfo

getTrialSettings

setTrialSettings

set

clone