Default request referring to version v1 of the Enterprise Apps Reseller API. This contains the host and root path used as a starting point for constructing service requests.

Manage users on your domain

Manage users on your domain

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

See: subscriptionTrialSettings smart constructor.

Creates a value of SubscriptionTrialSettings with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• stsIsInTrial
• stsTrialEndTime

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.

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

JSON template for resellernotify response.

See: resellernotifyResource smart constructor.

Creates a value of ResellernotifyResource with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rrTopicName

Topic name of the PubSub

JSON template for resellernotify getwatchdetails response.

See: resellernotifyGetwatchdetailsResponse smart constructor.

Creates a value of ResellernotifyGetwatchdetailsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rgrTopicName
• rgrServiceAccountEmailAddresses

Topic name of the PubSub

List of registered service accounts.

JSON template for address of a customer.

See: address smart constructor.

Creates a value of Address with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• aOrganizationName
• aKind
• aPostalCode
• aAddressLine1
• aLocality
• aContactName
• aAddressLine2
• aCountryCode
• aRegion
• aAddressLine3

The company or company division name. This is required.

Identifies the resource as a customer address. Value: customers#address

A postalCode example is a postal zip code such as 94043. This property is required when creating a new customer.

A customer's physical address. An address can be composed of one to three lines. The addressline2 and addressLine3 are optional.

An example of a locality value is the city of San Francisco.

The customer contact's name. This is required.

Line 2 of the address.

For countryCode information, see the ISO 3166 country code elements. Verify that country is approved for resale of Google products. This property is required when creating a new customer.

An example of a region value is CA for the state of California.

Line 3 of the address.

JSON template for a customer.

See: customer smart constructor.

Creates a value of Customer with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cCustomerDomainVerified
• cResourceUiURL
• cKind
• cCustomerId
• cAlternateEmail
• cCustomerDomain
• cPhoneNumber
• cPostalAddress

Whether the customer's primary domain has been verified.

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

Identifies the resource as a customer. Value: reseller#customer

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.

Like the "Customer email" in the reseller tools, this email is the secondary contact used if something happens to the customer's service such as service outage or a security issue. This property is required when creating a new customer and should not use the same domain as customerDomain.

The customer's primary domain name string. customerDomain is required when creating a new customer. Do not include the www prefix in the domain when adding a customer.

Customer contact phone number. This can be continuous numbers, with spaces, etc. But it must be a real phone number and not, for example, "123". See phone local format conventions.

A customer's address information. Each field has a limit of 255 charcters.

JSON template for the ChangePlan rpc request.

See: changePlanRequest smart constructor.

Creates a value of ChangePlanRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cprKind
• cprDealCode
• cprPlanName
• cprPurchaseOrderId
• cprSeats

Identifies the resource as a subscription change plan request. Value: subscriptions#changePlanRequest

Google-issued code (100 char max) for discounted pricing on subscription plans. Deal code must be included in changePlan request in order to receive discounted rate. This property is optional. If a deal code has already been added to a subscription, this property may be left empty and the existing discounted rate will still apply (if not empty, only provide the deal code that is already present on the subscription). If a deal code has never been added to a subscription and this property is left blank, regular pricing will apply.

The planName property is required. This is the name of the subscription's payment plan. For more information about the Google payment plans, see 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

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.

This is a required property. The seats property is the number of user seat licenses.

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

See: subscriptionPlanCommitmentInterval smart constructor.

Creates a value of SubscriptionPlanCommitmentInterval with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• spciStartTime
• spciEndTime

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

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

The deletionType query string enables the cancellation, downgrade, or suspension of a subscription.

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.

See: subscriptionPlan smart constructor.

Creates a value of SubscriptionPlan with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• spCommitmentInterval
• spIsCommitmentPlan
• spPlanName

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

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.

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.

JSON template for a subscription list.

See: subscriptions smart constructor.

Creates a value of Subscriptions with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sNextPageToken
• sKind
• sSubscriptions

The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.

Identifies the resource as a collection of subscriptions. Value: reseller#subscriptions

The subscriptions in this page of results.

JSON template for subscription seats.

See: seats smart constructor.

Creates a value of Seats with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• seaNumberOfSeats
• seaMaximumNumberOfSeats
• seaLicensedNumberOfSeats
• seaKind

The numberOfSeats property holds the customer's number of user licenses. How a user's licenses are managed depends on the subscription's plan: - annual commitment plan (with monthly or yearly pay) — For this plan, a reseller is invoiced on the number of user licenses in the numberOfSeats property. This is the maximum number of user licenses that a reseller's customer can create. The reseller can add more licenses, but once set, the numberOfSeats can not be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are provisioned users. - flexible plan — For this plan, a reseller is invoiced on the actual number of users which is capped by the maximumNumberOfSeats. The numberOfSeats property is not used in the request or response for flexible plan customers. - 30-day free trial plan — The numberOfSeats property is not used in the request or response for an account in a 30-day trial.

The maximumNumberOfSeats property is the maximum number of licenses that the customer can purchase. This property applies to plans other than the annual commitment plan. How a user's licenses are managed depends on the subscription's payment plan: - annual commitment plan (with monthly or yearly payments) — For this plan, a reseller is invoiced on the number of user licenses in the numberOfSeats property. The maximumNumberOfSeats property is a read-only property in the API's response. - flexible plan — For this plan, a reseller is invoiced on the actual number of users which is capped by the maximumNumberOfSeats. This is the maximum number of user licenses a customer has for user license provisioning. This quantity can be increased up to the maximum limit defined in the reseller's contract. And the minimum quantity is the current number of users in the customer account. - 30-day free trial plan — A subscription in a 30-day free trial is restricted to maximum 10 seats.

Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.

Identifies the resource as a subscription change plan request. Value: subscriptions#seats

JSON template for a subscription renewal settings.

See: renewalSettings smart constructor.

Creates a value of RenewalSettings with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rsKind
• rsRenewalType

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

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.

JSON template for a subscription.

See: subscription smart constructor.

Creates a value of Subscription with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• subCreationTime
• subBillingMethod
• subStatus
• subTrialSettings
• subSKUName
• subResourceUiURL
• subKind
• subSKUId
• subPlan
• subDealCode
• subCustomerId
• subCustomerDomain
• subSuspensionReasons
• subTransferInfo
• subPurchaseOrderId
• subSeats
• subRenewalSettings
• subSubscriptionId

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

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

This is an optional property.

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

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.

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.

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

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.

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.

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.

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.

Primary domain name of the customer

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

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

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.

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

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

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.

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

See: subscriptionTransferInfo smart constructor.

Creates a value of SubscriptionTransferInfo with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• stiTransferabilityExpirationTime
• stiMinimumTransferableSeats

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

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.