REST Resource: subscriptions

Resource: Subscription

JSON template for a subscription.

JSON representation
{
  "customerId": string,
  "subscriptionId": string,
  "skuId": string,
  "creationTime": string,
  "kind": string,
  "seats": {
    object (Seats)
  },
  "renewalSettings": {
    object (RenewalSettings)
  },
  "purchaseOrderId": string,
  "status": string,
  "resourceUiUrl": string,
  "billingMethod": string,
  "suspensionReasons": [
    string
  ],
  "customerDomain": string,
  "dealCode": string,
  "skuName": string,
  "plan": {
    "planName": string,
    "isCommitmentPlan": boolean,
    "commitmentInterval": {
      "startTime": string,
      "endTime": string
    }
  },
  "trialSettings": {
    "isInTrial": boolean,
    "trialEndTime": string
  },
  "transferInfo": {
    "transferabilityExpirationTime": string,
    "minimumTransferableSeats": integer
  }
}
Fields
customerId

string

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.

subscriptionId

string

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.

skuId

string

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.

creationTime

string (int64 format)

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

kind

string

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

seats

object (Seats)

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

renewalSettings

object (RenewalSettings)

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

purchaseOrderId

string

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.

status

string

This is an optional property.

resourceUiUrl

string

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.

billingMethod

string

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

suspensionReasons[]

string

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

customerDomain

string

Primary domain name of the customer

dealCode

string

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.

skuName

string

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.

plan

object

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.

plan.planName

string

The planName property is required. This is the name of the subscription's plan. For more information about the Google payment plans, see the API concepts.

Possible values are:

  • ANNUAL_MONTHLY_PAY — The annual commitment plan with monthly payments.
  • ANNUAL_YEARLY_PAY — The annual commitment plan with yearly payments
  • FLEXIBLE — The flexible plan
  • TRIAL — The 30-day free trial plan. A subscription in trial will be suspended after the 30th free day if no payment plan is assigned. Calling changePlan will assign a payment plan to a trial but will not activate the plan. A trial will automatically begin its assigned payment plan after its 30th free day or immediately after calling startPaidService.
  • FREE — The free plan is exclusive to the Cloud Identity SKU and does not incur any billing.

plan.isCommitmentPlan

boolean

The isCommitmentPlan property's boolean value identifies the plan as an annual commitment plan:

  • true — The subscription's plan is an annual commitment plan.
  • false — The plan is not an annual commitment plan.

plan.commitmentInterval

object

In this version of the API, annual commitment plan's interval is one year.

plan.commitmentInterval.startTime

string (int64 format)

An annual commitment plan's interval's startTime in milliseconds using UNIX Epoch format. See an example Epoch converter.

plan.commitmentInterval.endTime

string (int64 format)

An annual commitment plan's interval's endTime in milliseconds using the UNIX Epoch format. See an example Epoch converter.

trialSettings

object

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

trialSettings.isInTrial

boolean

Determines if a subscription's plan is in a 30-day free trial or not:

  • true — The plan is in trial.
  • false — The plan is not in trial.

trialSettings.trialEndTime

string (int64 format)

Date when the trial ends. The value is in milliseconds using the UNIX Epoch format. See an example Epoch converter.

transferInfo

object

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

transferInfo.transferabilityExpirationTime

string (int64 format)

The time when transfer token or intent to transfer will expire. The time is in milliseconds using UNIX Epoch format.

transferInfo.minimumTransferableSeats

integer

When inserting a subscription, this is the minimum number of seats listed in the transfer order for this product. For example, if the customer has 20 users, the reseller cannot place a transfer order of 15 seats. The minimum is 20 seats.

Seats

JSON template for subscription seats.

JSON representation
{
  "numberOfSeats": integer,
  "maximumNumberOfSeats": integer,
  "licensedNumberOfSeats": integer,
  "kind": string
}
Fields
numberOfSeats

integer

This is a required property and is exclusive to subscriptions with ANNUAL_MONTHLY_PAY and ANNUAL_YEARLY_PAY plans. This property sets the maximum number of licenses assignable to users on a subscription. The reseller can add more licenses, but once set, the numberOfSeats cannot be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are assigned.

maximumNumberOfSeats

integer

This is a required property and is exclusive to subscriptions with FLEXIBLE or TRIAL plans. This property sets the maximum number of licensed users allowed on a subscription. This quantity can be increased up to the maximum limit defined in the reseller's contract. The minimum quantity is the current number of users in the customer account.

licensedNumberOfSeats

integer

Read-only field containing the current number of users that are assigned a license for the product defined in skuId. This field's value is equivalent to the numerical count of users returned by the Enterprise License Manager API method: listForProductAndSku.

kind

string

Identifies the resource as a subscription seat setting. Value: subscriptions#seats

RenewalSettings

JSON template for a subscription renewal settings.

JSON representation
{
  "renewalType": string,
  "kind": string
}
Fields
renewalType

string

Renewal settings for the annual commitment plan. For more detailed information, see renewal options in the administrator help center. When renewing a subscription, the renewalType is a required property.

kind

string

Identifies the resource as a subscription renewal setting. Value: subscriptions#renewalSettings

Methods

activate

Activates a subscription previously suspended by the reseller.

changePlan

Update a subscription plan.

changeRenewalSettings

Update a user license's renewal settings.

changeSeats

Update a subscription's user license settings.

delete

Cancel, suspend, or transfer a subscription to direct.

get

Get a specific subscription.

insert

Create or transfer a subscription.

list

List of subscriptions managed by the reseller.

startPaidService

Immediately move a 30-day free trial subscription to a paid service subscription.

suspend

Suspends an active subscription.