discovery/googleapis/reseller__v1.json - Issue 2734843002: Api-roll 46: 2017-03-06

Unified Diff: discovery/googleapis/reseller__v1.json

Issue 2734843002: Api-roll 46: 2017-03-06 (Closed)

Patch Set: Created 3 years, 9 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View side-by-side diff with in-line comments

Index: discovery/googleapis/reseller__v1.json

diff --git a/discovery/googleapis/reseller__v1.json b/discovery/googleapis/reseller__v1.json

index 1a4cd07a65504a8b3b8cc05b496b04431afaa0e6..46e56f1b2d352b6f51b4878e02eba305feaa54a0 100644

--- a/discovery/googleapis/reseller__v1.json

+++ b/discovery/googleapis/reseller__v1.json

@@ -17,7 +17,7 @@

"description": "Creates and manages your customers and their subscriptions.",

"discoveryVersion": "v1",

"documentationLink": "https://developers.google.com/google-apps/reseller/",

- "etag": "\"tbys6C40o18GZwyMen5GMkdK-3s/n63v3jbq0NMxEV0nJ3he6mTRpog\"",

+ "etag": "\"tbys6C40o18GZwyMen5GMkdK-3s/zGPGa-LIIu53_wHsQE6CSF1P9Iw\"",

"icons": {

"x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",

"x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"

@@ -80,7 +80,7 @@

"customers": {

"methods": {

"get": {

- "description": "Gets a customer resource if one exists and is owned by the reseller.",

+ "description": "Get a customer account.",

"httpMethod": "GET",

"id": "reseller.customers.get",

"parameterOrder": [

@@ -88,7 +88,7 @@

"parameters": {

"customerId": {

- "description": "Id of the Customer",

+ "description": "Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.",

"location": "path",

"required": true,

"type": "string"

@@ -104,12 +104,12 @@

]

"insert": {

- "description": "Creates a customer resource if one does not already exist.",

+ "description": "Order a new customer's account.",

"httpMethod": "POST",

"id": "reseller.customers.insert",

"parameters": {

"customerAuthToken": {

- "description": "An auth token needed for inserting a customer for which domain already exists. Can be generated at https://admin.google.com/TransferToken. Optional.",

+ "description": "The customerAuthToken query string is required when creating a resold account that transfers a direct customer's subscription or transfers another reseller customer's subscription to your reseller management. This is a hexadecimal authentication token needed to complete the subscription transfer. For more information, see the administrator help center.",

"location": "query",

"type": "string"

}

@@ -126,7 +126,7 @@

]

"patch": {

- "description": "Update a customer resource if one it exists and is owned by the reseller. This method supports patch semantics.",

+ "description": "Update a customer account's settings. This method supports patch semantics.",

"httpMethod": "PATCH",

"id": "reseller.customers.patch",

"parameterOrder": [

@@ -134,7 +134,7 @@

"parameters": {

"customerId": {

- "description": "Id of the Customer",

"location": "path",

"required": true,

"type": "string"

@@ -152,7 +152,7 @@

]

"update": {

- "description": "Update a customer resource if one it exists and is owned by the reseller.",

+ "description": "Update a customer account's settings.",

"httpMethod": "PUT",

"id": "reseller.customers.update",

"parameterOrder": [

@@ -160,7 +160,7 @@

"parameters": {

"customerId": {

- "description": "Id of the Customer",

"location": "path",

"required": true,

"type": "string"

@@ -179,6 +179,61 @@

}

+ "resellernotify": {

+ "methods": {

+ "getwatchdetails": {

+ "description": "Returns all the details of the watch corresponding to the reseller.",

+ "httpMethod": "GET",

+ "id": "reseller.resellernotify.getwatchdetails",

+ "path": "resellernotify/getwatchdetails",

+ "response": {

+ "$ref": "ResellernotifyGetwatchdetailsResponse"

+ },

+ "scopes": [

+ "https://www.googleapis.com/auth/apps.order",

+ "https://www.googleapis.com/auth/apps.order.readonly"

+ ]

+ },

+ "register": {

+ "description": "Registers a Reseller for receiving notifications.",

+ "httpMethod": "POST",

+ "id": "reseller.resellernotify.register",

+ "parameters": {

+ "serviceAccountEmailAddress": {

+ "description": "The service account which will own the created Cloud-PubSub topic.",

+ "location": "query",

+ "type": "string"

+ }

+ },

+ "path": "resellernotify/register",

+ "response": {

+ "$ref": "ResellernotifyResource"

+ },

+ "scopes": [

+ "https://www.googleapis.com/auth/apps.order"

+ ]

+ },

+ "unregister": {

+ "description": "Unregisters a Reseller for receiving notifications.",

+ "httpMethod": "POST",

+ "id": "reseller.resellernotify.unregister",

+ "parameters": {

+ "serviceAccountEmailAddress": {

+ "description": "The service account which owns the Cloud-PubSub topic.",

+ "location": "query",

+ "type": "string"

+ }

+ },

+ "path": "resellernotify/unregister",

+ "response": {

+ "$ref": "ResellernotifyResource"

+ },

+ "scopes": [

+ "https://www.googleapis.com/auth/apps.order"

+ ]

+ }

+ },

"subscriptions": {

"methods": {

"activate": {

@@ -191,13 +246,13 @@

"parameters": {

"customerId": {

- "description": "Id of the Customer",

"location": "path",

"required": true,

"type": "string"

"subscriptionId": {

- "description": "Id of the subscription, which is unique for a customer",

+ "description": "This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method.",

"location": "path",

"required": true,

"type": "string"

@@ -212,7 +267,7 @@

]

"changePlan": {

- "description": "Changes the plan of a subscription",

+ "description": "Update a subscription plan. Use this method to update a plan for a 30-day trial or a flexible plan subscription to an annual commitment plan with monthly or yearly payments.",

"httpMethod": "POST",

"id": "reseller.subscriptions.changePlan",

"parameterOrder": [

@@ -221,13 +276,13 @@

"parameters": {

"customerId": {

- "description": "Id of the Customer",

"location": "path",

"required": true,

"type": "string"

"subscriptionId": {

- "description": "Id of the subscription, which is unique for a customer",

"location": "path",

"required": true,

"type": "string"

@@ -245,7 +300,7 @@

]

"changeRenewalSettings": {

- "description": "Changes the renewal settings of a subscription",

+ "description": "Update a user license's renewal settings. This is applicable for accounts with annual commitment plans only.",

"httpMethod": "POST",

"id": "reseller.subscriptions.changeRenewalSettings",

"parameterOrder": [

@@ -254,13 +309,13 @@

"parameters": {

"customerId": {

- "description": "Id of the Customer",

"location": "path",

"required": true,

"type": "string"

"subscriptionId": {

- "description": "Id of the subscription, which is unique for a customer",

"location": "path",

"required": true,

"type": "string"

@@ -278,7 +333,7 @@

]

"changeSeats": {

- "description": "Changes the seats configuration of a subscription",

+ "description": "Update a subscription's user license settings.",

"httpMethod": "POST",

"id": "reseller.subscriptions.changeSeats",

"parameterOrder": [

@@ -287,13 +342,13 @@

"parameters": {

"customerId": {

- "description": "Id of the Customer",

"location": "path",

"required": true,

"type": "string"

"subscriptionId": {

- "description": "Id of the subscription, which is unique for a customer",

"location": "path",

"required": true,

"type": "string"

@@ -311,7 +366,7 @@

]

"delete": {

- "description": "Cancels/Downgrades a subscription.",

+ "description": "Cancel, suspend or transfer a subscription to direct.",

"httpMethod": "DELETE",

"id": "reseller.subscriptions.delete",

"parameterOrder": [

@@ -321,13 +376,13 @@

"parameters": {

"customerId": {

- "description": "Id of the Customer",

"location": "path",

"required": true,

"type": "string"

"deletionType": {

- "description": "Whether the subscription is to be fully cancelled or downgraded",

+ "description": "The deletionType query string enables the cancellation, downgrade, or suspension of a subscription.",

"enum": [

"cancel",

"downgrade",

@@ -335,17 +390,17 @@

"transfer_to_direct"

"enumDescriptions": [

- "Cancels the subscription immediately",

- "Downgrades a Google Apps for Business subscription to Google Apps",

- "Suspends the subscriptions for 4 days before cancelling it",

- "Transfers a subscription directly to Google"

+ "Cancels the subscription immediately. This does not apply to a G Suite subscription.",

+ "Downgrades a G Suite subscription to a Google Apps Free edition subscription only if the customer was initially subscribed to a Google Apps Free edition (also known as the Standard edition). Once downgraded, the customer no longer has access to the previous G Suite subscription and is no longer managed by the reseller.\n\nA G Suite subscription's downgrade cannot be invoked if an active or suspended Google Drive or Google Vault subscription is present. The Google Drive or Google Vault subscription must be cancelled before the G Suite subscription's downgrade is invoked.\n\nThe downgrade deletionType does not apply to other products or G Suite SKUs.",

+ "(DEPRECATED) The G Suite account is suspended for four days and then cancelled. Once suspended, an administrator has access to the suspended account, but the account users can not access their services. A suspension can be lifted, using the reseller tools.\n\nA G Suite subscription's suspension can not be invoked if an active or suspended Google Drive or Google Vault subscription is present. The Google Drive or Google Vault subscription must be cancelled before the G Suite subscription's suspension is invoked.",

+ "Transfers a subscription directly to Google. The customer is immediately transferred to a direct billing relationship with Google and is given a short amount of time with no service interruption. The customer can then choose to set up billing directly with Google by using a credit card, or they can transfer to another reseller."

"location": "query",

"required": true,

"type": "string"

"subscriptionId": {

- "description": "Id of the subscription, which is unique for a customer",

"location": "path",

"required": true,

"type": "string"

@@ -357,7 +412,7 @@

]

"get": {

- "description": "Gets a subscription of the customer.",

+ "description": "Get a specific subscription.",

"httpMethod": "GET",

"id": "reseller.subscriptions.get",

"parameterOrder": [

@@ -366,13 +421,13 @@

"parameters": {

"customerId": {

- "description": "Id of the Customer",

"location": "path",

"required": true,

"type": "string"

"subscriptionId": {

- "description": "Id of the subscription, which is unique for a customer",

"location": "path",

"required": true,

"type": "string"

@@ -388,7 +443,7 @@

]

"insert": {

- "description": "Creates/Transfers a subscription for the customer.",

+ "description": "Create or transfer a subscription.",

"httpMethod": "POST",

"id": "reseller.subscriptions.insert",

"parameterOrder": [

@@ -396,12 +451,12 @@

"parameters": {

"customerAuthToken": {

- "description": "An auth token needed for transferring a subscription. Can be generated at https://www.google.com/a/cpanel/customer-domain/TransferToken. Optional.",

"location": "query",

"type": "string"

"customerId": {

- "description": "Id of the Customer",

"location": "path",

"required": true,

"type": "string"

@@ -419,27 +474,27 @@

]

"list": {

- "description": "Lists subscriptions of a reseller, optionally filtered by a customer name prefix.",

+ "description": "List of subscriptions managed by the reseller. The list can be all subscriptions, all of a customer's subscriptions, or all of a customer's transferable subscriptions.",

"httpMethod": "GET",

"id": "reseller.subscriptions.list",

"parameters": {

"customerAuthToken": {

- "description": "An auth token needed if the customer is not a resold customer of this reseller. Can be generated at https://www.google.com/a/cpanel/customer-domain/TransferToken.Optional.",

"location": "query",

"type": "string"

"customerId": {

- "description": "Id of the Customer",

"location": "query",

"type": "string"

"customerNamePrefix": {

- "description": "Prefix of the customer's domain name by which the subscriptions should be filtered. Optional",

+ "description": "When retrieving all of your subscriptions and filtering for specific customers, you can enter a prefix for a customer name. Using an example customer group that includes exam.com, example20.com and example.com: \n- exa -- Returns all customer names that start with 'exa' which could include exam.com, example20.com, and example.com. A name prefix is similar to using a regular expression's asterisk, exa*. \n- example -- Returns example20.com and example.com.",

"location": "query",

"type": "string"

"maxResults": {

- "description": "Maximum number of results to return",

+ "description": "When retrieving a large list, the maxResults is the maximum number of results per page. The nextPageToken value takes you to the next page. The default is 20.",

"format": "uint32",

"location": "query",

"maximum": "100",

@@ -462,7 +517,7 @@

]

"startPaidService": {

- "description": "Starts paid service of a trial subscription",

+ "description": "Immediately move a 30-day free trial subscription to a paid service subscription.",

"httpMethod": "POST",

"id": "reseller.subscriptions.startPaidService",

"parameterOrder": [

@@ -471,13 +526,13 @@

"parameters": {

"customerId": {

- "description": "Id of the Customer",

"location": "path",

"required": true,

"type": "string"

"subscriptionId": {

- "description": "Id of the subscription, which is unique for a customer",

"location": "path",

"required": true,

"type": "string"

@@ -492,7 +547,7 @@

]

"suspend": {

- "description": "Suspends an active subscription",

+ "description": "Suspends an active subscription.",

"httpMethod": "POST",

"id": "reseller.subscriptions.suspend",

"parameterOrder": [

@@ -501,13 +556,13 @@

"parameters": {

"customerId": {

- "description": "Id of the Customer",

"location": "path",

"required": true,

"type": "string"

"subscriptionId": {

- "description": "Id of the subscription, which is unique for a customer",

"location": "path",

"required": true,

"type": "string"

@@ -524,7 +579,7 @@

}

- "revision": "20160329",

+ "revision": "20170216",

"rootUrl": "https://www.googleapis.com/",

"schemas": {

"Address": {

@@ -532,44 +587,44 @@

"id": "Address",

"properties": {

"addressLine1": {

- "description": "Address line 1 of the address.",

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

"type": "string"

"addressLine2": {

- "description": "Address line 2 of the address.",

+ "description": "Line 2 of the address.",

"type": "string"

"addressLine3": {

- "description": "Address line 3 of the address.",

+ "description": "Line 3 of the address.",

"type": "string"

"contactName": {

- "description": "Name of the contact person.",

+ "description": "The customer contact's name. This is required.",

"type": "string"

"countryCode": {

- "description": "ISO 3166 country code.",

+ "description": "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.",

"type": "string"

"kind": {

"default": "customers#address",

- "description": "Identifies the resource as a customer address.",

+ "description": "Identifies the resource as a customer address. Value: customers#address",

"type": "string"

"locality": {

- "description": "Name of the locality. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.",

+ "description": "An example of a locality value is the city of San Francisco.",

"type": "string"

"organizationName": {

- "description": "Name of the organization.",

+ "description": "The company or company division name. This is required.",

"type": "string"

"postalCode": {

- "description": "The postal code. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.",

+ "description": "A postalCode example is a postal zip code such as 94043. This property is required when creating a new customer.",

"type": "string"

"region": {

- "description": "Name of the region. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.",

+ "description": "An example of a region value is CA for the state of California.",

"type": "string"

}

@@ -580,25 +635,25 @@

"id": "ChangePlanRequest",

"properties": {

"dealCode": {

- "description": "External name of the deal code applicable for the subscription. This field is optional. If missing, the deal price plan won't be used.",

+ "description": "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.",

"type": "string"

"kind": {

"default": "subscriptions#changePlanRequest",

- "description": "Identifies the resource as a subscription change plan request.",

+ "description": "Identifies the resource as a subscription change plan request. Value: subscriptions#changePlanRequest",

"type": "string"

"planName": {

- "description": "Name of the plan to change to.",

+ "description": "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.\n\nPossible values are: \n- ANNUAL_MONTHLY_PAY - The annual commitment plan with monthly payments \n- ANNUAL_YEARLY_PAY - The annual commitment plan with yearly payments \n- FLEXIBLE - The flexible plan \n- TRIAL - The 30-day free trial plan",

"type": "string"

"purchaseOrderId": {

- "description": "Purchase order id for your order tracking purposes.",

+ "description": "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.",

"type": "string"

"seats": {

"$ref": "Seats",

- "description": "Number/Limit of seats in the new plan."

+ "description": "This is a required property. The seats property is the number of user seat licenses."

}

"type": "object"

@@ -608,11 +663,11 @@

"id": "Customer",

"properties": {

"alternateEmail": {

- "description": "The alternate email of the customer.",

+ "description": "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.",

"type": "string"

"customerDomain": {

- "description": "The domain name of the customer.",

+ "description": "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.",

"type": "string"

"customerDomainVerified": {

@@ -620,24 +675,24 @@

"type": "boolean"

"customerId": {

- "description": "The id of the customer.",

+ "description": "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.",

"type": "string"

"kind": {

"default": "reseller#customer",

- "description": "Identifies the resource as a customer.",

+ "description": "Identifies the resource as a customer. Value: reseller#customer",

"type": "string"

"phoneNumber": {

- "description": "The phone number of the customer.",

+ "description": "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.",

"type": "string"

"postalAddress": {

"$ref": "Address",

- "description": "The postal address of the customer."

+ "description": "A customer's address information. Each field has a limit of 255 charcters."

"resourceUiUrl": {

- "description": "Ui url for customer resource.",

+ "description": "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.",

"type": "string"

}

@@ -649,11 +704,40 @@

"properties": {

"kind": {

"default": "subscriptions#renewalSettings",

- "description": "Identifies the resource as a subscription renewal setting.",

+ "description": "Identifies the resource as a subscription renewal setting. Value: subscriptions#renewalSettings",

"type": "string"

"renewalType": {

- "description": "Subscription renewal type.",

+ "description": "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.",

+ "type": "string"

+ }

+ },

+ "type": "object"

+ },

+ "ResellernotifyGetwatchdetailsResponse": {

+ "description": "JSON template for resellernotify getwatchdetails response.",

+ "id": "ResellernotifyGetwatchdetailsResponse",

+ "properties": {

+ "serviceAccountEmailAddresses": {

+ "description": "List of registered service accounts.",

+ "items": {

+ "type": "string"

+ },

+ "type": "array"

+ },

+ "topicName": {

+ "description": "Topic name of the PubSub",

+ "type": "string"

+ }

+ },

+ "type": "object"

+ },

+ "ResellernotifyResource": {

+ "description": "JSON template for resellernotify response.",

+ "id": "ResellernotifyResource",

+ "properties": {

+ "topicName": {

+ "description": "Topic name of the PubSub",

"type": "string"

}

@@ -665,7 +749,7 @@

"properties": {

"kind": {

"default": "subscriptions#seats",

- "description": "Identifies the resource as a subscription change plan request.",

+ "description": "Identifies the resource as a subscription change plan request. Value: subscriptions#seats",

"type": "string"

"licensedNumberOfSeats": {

@@ -674,12 +758,12 @@

"type": "integer"

"maximumNumberOfSeats": {

- "description": "Maximum number of seats that can be purchased. This needs to be provided only for a non-commitment plan. For a commitment plan it is decided by the contract.",

+ "description": "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: \n- 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. \n- 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. \n- 30-day free trial plan — A subscription in a 30-day free trial is restricted to maximum 10 seats.",

"format": "int32",

"type": "integer"

"numberOfSeats": {

- "description": "Number of seats to purchase. This is applicable only for a commitment plan.",

+ "description": "The numberOfSeats property holds the customer's number of user licenses. How a user's licenses are managed depends on the subscription's plan: \n- 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. \n- 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. \n- 30-day free trial plan — The numberOfSeats property is not used in the request or response for an account in a 30-day trial.",

"format": "int32",

"type": "integer"

}

@@ -691,11 +775,11 @@

"id": "Subscription",

"properties": {

"billingMethod": {

- "description": "Billing method of this subscription.",

+ "description": "Read-only field that returns the current billing method for a subscription.",

"type": "string"

"creationTime": {

- "description": "Creation time of this subscription in milliseconds since Unix epoch.",

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

"format": "int64",

"type": "string"

@@ -704,31 +788,31 @@

"type": "string"

"customerId": {

- "description": "The id of the customer to whom the subscription belongs.",

"type": "string"

"dealCode": {

- "description": "External name of the deal, if this subscription was provisioned under one. Otherwise this field will be empty.",

+ "description": "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.",

"type": "string"

"kind": {

"default": "reseller#subscription",

- "description": "Identifies the resource as a Subscription.",

+ "description": "Identifies the resource as a Subscription. Value: reseller#subscription",

"type": "string"

"plan": {

- "description": "Plan details of the subscription",

+ "description": "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.",

"properties": {

"commitmentInterval": {

- "description": "Interval of the commitment if it is a commitment plan.",

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

"properties": {

"endTime": {

- "description": "End time of the commitment interval in milliseconds since Unix epoch.",

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

"format": "int64",

"type": "string"

"startTime": {

- "description": "Start time of the commitment interval in milliseconds since Unix epoch.",

+ "description": "An annual commitment plan's interval's startTime in milliseconds using UNIX Epoch format. See an example Epoch converter.",

"format": "int64",

"type": "string"

}

@@ -736,60 +820,61 @@

"type": "object"

"isCommitmentPlan": {

- "description": "Whether the plan is a commitment plan or not.",

+ "description": "The isCommitmentPlan property's boolean value identifies the plan as an annual commitment plan:\n- true — The subscription's plan is an annual commitment plan.\n- false — The plan is not an annual commitment plan.",

"type": "boolean"

"planName": {

- "description": "The plan name of this subscription's plan.",

+ "description": "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.\n\nPossible values are: \n- ANNUAL_MONTHLY_PAY — The annual commitment plan with monthly payments \n- ANNUAL_YEARLY_PAY — The annual commitment plan with yearly payments \n- FLEXIBLE — The flexible plan \n- 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.",

"type": "string"

}

"type": "object"

"purchaseOrderId": {

- "description": "Purchase order id for your order tracking purposes.",

"type": "string"

"renewalSettings": {

"$ref": "RenewalSettings",

- "description": "Renewal settings of the subscription."

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

"resourceUiUrl": {

- "description": "Ui url for subscription resource.",

+ "description": "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.",

"type": "string"

"seats": {

"$ref": "Seats",

- "description": "Number/Limit of seats in the new plan."

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

"skuId": {

- "description": "Name of the sku for which this subscription is purchased.",

+ "description": "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.",

"type": "string"

"status": {

- "description": "Status of the subscription.",

+ "description": "This is an optional property.",

"type": "string"

"subscriptionId": {

- "description": "The id of the subscription.",

+ "description": "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.",

"type": "string"

"suspensionReasons": {

- "description": "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: \n- PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the Google Apps Resold Terms of Services. \n- RENEWAL_WITH_TYPE_CANCEL - The customer's commitment ended and their service was cancelled at the end of their term. \n- RESELLER_INITIATED - A manual suspension invoked by a Reseller. \n- TRIAL_ENDED - The customer's trial expired without a plan selected. \n- OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise).",

+ "description": "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.\n\nPossible options include: \n- PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the G Suite Resold Terms of Services. \n- RENEWAL_WITH_TYPE_CANCEL - The customer's commitment ended and their service was cancelled at the end of their term. \n- RESELLER_INITIATED - A manual suspension invoked by a Reseller. \n- TRIAL_ENDED - The customer's trial expired without a plan selected. \n- OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise).",

"items": {

"type": "string"

"type": "array"

"transferInfo": {

- "description": "Transfer related information for the subscription.",

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

"properties": {

"minimumTransferableSeats": {

+ "description": "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.",

"format": "int32",

"type": "integer"

"transferabilityExpirationTime": {

- "description": "Time when transfer token or intent to transfer will expire.",

+ "description": "The time when transfer token or intent to transfer will expire. The time is in milliseconds using UNIX Epoch format.",

"format": "int64",

"type": "string"

}

@@ -797,14 +882,14 @@

"type": "object"

"trialSettings": {

- "description": "Trial Settings of the subscription.",

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

"properties": {

"isInTrial": {

- "description": "Whether the subscription is in trial.",

+ "description": "Determines if a subscription's plan is in a 30-day free trial or not:\n- true — The plan is in trial.\n- false — The plan is not in trial.",

"type": "boolean"

"trialEndTime": {

- "description": "End time of the trial in milliseconds since Unix epoch.",

+ "description": "Date when the trial ends. The value is in milliseconds using the UNIX Epoch format. See an example Epoch converter.",

"format": "int64",

"type": "string"

}

@@ -820,7 +905,7 @@

"properties": {

"kind": {

"default": "reseller#subscriptions",

- "description": "Identifies the resource as a collection of subscriptions.",

+ "description": "Identifies the resource as a collection of subscriptions. Value: reseller#subscriptions",

"type": "string"

"nextPageToken": {

« no previous file with comments | « discovery/googleapis/pubsub__v1.json ('k') | discovery/googleapis/runtimeconfig__v1.json » ('j') | no next file with comments »