OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
5 "https://www.googleapis.com/auth/apps.order": { | 5 "https://www.googleapis.com/auth/apps.order": { |
6 "description": "Manage users on your domain" | 6 "description": "Manage users on your domain" |
7 }, | 7 }, |
8 "https://www.googleapis.com/auth/apps.order.readonly": { | 8 "https://www.googleapis.com/auth/apps.order.readonly": { |
9 "description": "Manage users on your domain" | 9 "description": "Manage users on your domain" |
10 } | 10 } |
11 } | 11 } |
12 } | 12 } |
13 }, | 13 }, |
14 "basePath": "/apps/reseller/v1/", | 14 "basePath": "/apps/reseller/v1/", |
15 "baseUrl": "https://www.googleapis.com/apps/reseller/v1/", | 15 "baseUrl": "https://www.googleapis.com/apps/reseller/v1/", |
16 "batchPath": "batch", | 16 "batchPath": "batch", |
17 "description": "Creates and manages your customers and their subscriptions."
, | 17 "description": "Creates and manages your customers and their subscriptions."
, |
18 "discoveryVersion": "v1", | 18 "discoveryVersion": "v1", |
19 "documentationLink": "https://developers.google.com/google-apps/reseller/", | 19 "documentationLink": "https://developers.google.com/google-apps/reseller/", |
20 "etag": "\"tbys6C40o18GZwyMen5GMkdK-3s/n63v3jbq0NMxEV0nJ3he6mTRpog\"", | 20 "etag": "\"tbys6C40o18GZwyMen5GMkdK-3s/zGPGa-LIIu53_wHsQE6CSF1P9Iw\"", |
21 "icons": { | 21 "icons": { |
22 "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.
png", | 22 "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.
png", |
23 "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.
png" | 23 "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.
png" |
24 }, | 24 }, |
25 "id": "reseller:v1", | 25 "id": "reseller:v1", |
26 "kind": "discovery#restDescription", | 26 "kind": "discovery#restDescription", |
27 "labels": [ | 27 "labels": [ |
28 "limited_availability" | 28 "limited_availability" |
29 ], | 29 ], |
30 "name": "reseller", | 30 "name": "reseller", |
(...skipping 42 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
73 "description": "IP address of the site where the request originates.
Use this if you want to enforce per-user limits.", | 73 "description": "IP address of the site where the request originates.
Use this if you want to enforce per-user limits.", |
74 "location": "query", | 74 "location": "query", |
75 "type": "string" | 75 "type": "string" |
76 } | 76 } |
77 }, | 77 }, |
78 "protocol": "rest", | 78 "protocol": "rest", |
79 "resources": { | 79 "resources": { |
80 "customers": { | 80 "customers": { |
81 "methods": { | 81 "methods": { |
82 "get": { | 82 "get": { |
83 "description": "Gets a customer resource if one exists and i
s owned by the reseller.", | 83 "description": "Get a customer account.", |
84 "httpMethod": "GET", | 84 "httpMethod": "GET", |
85 "id": "reseller.customers.get", | 85 "id": "reseller.customers.get", |
86 "parameterOrder": [ | 86 "parameterOrder": [ |
87 "customerId" | 87 "customerId" |
88 ], | 88 ], |
89 "parameters": { | 89 "parameters": { |
90 "customerId": { | 90 "customerId": { |
91 "description": "Id of the Customer", | 91 "description": "Either the customer's primary domain
name or the customer's unique identifier. If using the domain name, we do not r
ecommend using a customerId as a key for persistent data. If the domain name for
a customerId is changed, the Google system automatically updates.", |
92 "location": "path", | 92 "location": "path", |
93 "required": true, | 93 "required": true, |
94 "type": "string" | 94 "type": "string" |
95 } | 95 } |
96 }, | 96 }, |
97 "path": "customers/{customerId}", | 97 "path": "customers/{customerId}", |
98 "response": { | 98 "response": { |
99 "$ref": "Customer" | 99 "$ref": "Customer" |
100 }, | 100 }, |
101 "scopes": [ | 101 "scopes": [ |
102 "https://www.googleapis.com/auth/apps.order", | 102 "https://www.googleapis.com/auth/apps.order", |
103 "https://www.googleapis.com/auth/apps.order.readonly" | 103 "https://www.googleapis.com/auth/apps.order.readonly" |
104 ] | 104 ] |
105 }, | 105 }, |
106 "insert": { | 106 "insert": { |
107 "description": "Creates a customer resource if one does not
already exist.", | 107 "description": "Order a new customer's account.", |
108 "httpMethod": "POST", | 108 "httpMethod": "POST", |
109 "id": "reseller.customers.insert", | 109 "id": "reseller.customers.insert", |
110 "parameters": { | 110 "parameters": { |
111 "customerAuthToken": { | 111 "customerAuthToken": { |
112 "description": "An auth token needed for inserting a
customer for which domain already exists. Can be generated at https://admin.goo
gle.com/TransferToken. Optional.", | 112 "description": "The customerAuthToken query string i
s required when creating a resold account that transfers a direct customer's sub
scription or transfers another reseller customer's subscription to your reseller
management. This is a hexadecimal authentication token needed to complete the s
ubscription transfer. For more information, see the administrator help center.", |
113 "location": "query", | 113 "location": "query", |
114 "type": "string" | 114 "type": "string" |
115 } | 115 } |
116 }, | 116 }, |
117 "path": "customers", | 117 "path": "customers", |
118 "request": { | 118 "request": { |
119 "$ref": "Customer" | 119 "$ref": "Customer" |
120 }, | 120 }, |
121 "response": { | 121 "response": { |
122 "$ref": "Customer" | 122 "$ref": "Customer" |
123 }, | 123 }, |
124 "scopes": [ | 124 "scopes": [ |
125 "https://www.googleapis.com/auth/apps.order" | 125 "https://www.googleapis.com/auth/apps.order" |
126 ] | 126 ] |
127 }, | 127 }, |
128 "patch": { | 128 "patch": { |
129 "description": "Update a customer resource if one it exists
and is owned by the reseller. This method supports patch semantics.", | 129 "description": "Update a customer account's settings. This m
ethod supports patch semantics.", |
130 "httpMethod": "PATCH", | 130 "httpMethod": "PATCH", |
131 "id": "reseller.customers.patch", | 131 "id": "reseller.customers.patch", |
132 "parameterOrder": [ | 132 "parameterOrder": [ |
133 "customerId" | 133 "customerId" |
134 ], | 134 ], |
135 "parameters": { | 135 "parameters": { |
136 "customerId": { | 136 "customerId": { |
137 "description": "Id of the Customer", | 137 "description": "Either the customer's primary domain
name or the customer's unique identifier. If using the domain name, we do not r
ecommend using a customerId as a key for persistent data. If the domain name for
a customerId is changed, the Google system automatically updates.", |
138 "location": "path", | 138 "location": "path", |
139 "required": true, | 139 "required": true, |
140 "type": "string" | 140 "type": "string" |
141 } | 141 } |
142 }, | 142 }, |
143 "path": "customers/{customerId}", | 143 "path": "customers/{customerId}", |
144 "request": { | 144 "request": { |
145 "$ref": "Customer" | 145 "$ref": "Customer" |
146 }, | 146 }, |
147 "response": { | 147 "response": { |
148 "$ref": "Customer" | 148 "$ref": "Customer" |
149 }, | 149 }, |
150 "scopes": [ | 150 "scopes": [ |
151 "https://www.googleapis.com/auth/apps.order" | 151 "https://www.googleapis.com/auth/apps.order" |
152 ] | 152 ] |
153 }, | 153 }, |
154 "update": { | 154 "update": { |
155 "description": "Update a customer resource if one it exists
and is owned by the reseller.", | 155 "description": "Update a customer account's settings.", |
156 "httpMethod": "PUT", | 156 "httpMethod": "PUT", |
157 "id": "reseller.customers.update", | 157 "id": "reseller.customers.update", |
158 "parameterOrder": [ | 158 "parameterOrder": [ |
159 "customerId" | 159 "customerId" |
160 ], | 160 ], |
161 "parameters": { | 161 "parameters": { |
162 "customerId": { | 162 "customerId": { |
163 "description": "Id of the Customer", | 163 "description": "Either the customer's primary domain
name or the customer's unique identifier. If using the domain name, we do not r
ecommend using a customerId as a key for persistent data. If the domain name for
a customerId is changed, the Google system automatically updates.", |
164 "location": "path", | 164 "location": "path", |
165 "required": true, | 165 "required": true, |
166 "type": "string" | 166 "type": "string" |
167 } | 167 } |
168 }, | 168 }, |
169 "path": "customers/{customerId}", | 169 "path": "customers/{customerId}", |
170 "request": { | 170 "request": { |
171 "$ref": "Customer" | 171 "$ref": "Customer" |
172 }, | 172 }, |
173 "response": { | 173 "response": { |
174 "$ref": "Customer" | 174 "$ref": "Customer" |
175 }, | 175 }, |
176 "scopes": [ | 176 "scopes": [ |
177 "https://www.googleapis.com/auth/apps.order" | 177 "https://www.googleapis.com/auth/apps.order" |
178 ] | 178 ] |
179 } | 179 } |
180 } | 180 } |
181 }, | 181 }, |
| 182 "resellernotify": { |
| 183 "methods": { |
| 184 "getwatchdetails": { |
| 185 "description": "Returns all the details of the watch corresp
onding to the reseller.", |
| 186 "httpMethod": "GET", |
| 187 "id": "reseller.resellernotify.getwatchdetails", |
| 188 "path": "resellernotify/getwatchdetails", |
| 189 "response": { |
| 190 "$ref": "ResellernotifyGetwatchdetailsResponse" |
| 191 }, |
| 192 "scopes": [ |
| 193 "https://www.googleapis.com/auth/apps.order", |
| 194 "https://www.googleapis.com/auth/apps.order.readonly" |
| 195 ] |
| 196 }, |
| 197 "register": { |
| 198 "description": "Registers a Reseller for receiving notificat
ions.", |
| 199 "httpMethod": "POST", |
| 200 "id": "reseller.resellernotify.register", |
| 201 "parameters": { |
| 202 "serviceAccountEmailAddress": { |
| 203 "description": "The service account which will own t
he created Cloud-PubSub topic.", |
| 204 "location": "query", |
| 205 "type": "string" |
| 206 } |
| 207 }, |
| 208 "path": "resellernotify/register", |
| 209 "response": { |
| 210 "$ref": "ResellernotifyResource" |
| 211 }, |
| 212 "scopes": [ |
| 213 "https://www.googleapis.com/auth/apps.order" |
| 214 ] |
| 215 }, |
| 216 "unregister": { |
| 217 "description": "Unregisters a Reseller for receiving notific
ations.", |
| 218 "httpMethod": "POST", |
| 219 "id": "reseller.resellernotify.unregister", |
| 220 "parameters": { |
| 221 "serviceAccountEmailAddress": { |
| 222 "description": "The service account which owns the C
loud-PubSub topic.", |
| 223 "location": "query", |
| 224 "type": "string" |
| 225 } |
| 226 }, |
| 227 "path": "resellernotify/unregister", |
| 228 "response": { |
| 229 "$ref": "ResellernotifyResource" |
| 230 }, |
| 231 "scopes": [ |
| 232 "https://www.googleapis.com/auth/apps.order" |
| 233 ] |
| 234 } |
| 235 } |
| 236 }, |
182 "subscriptions": { | 237 "subscriptions": { |
183 "methods": { | 238 "methods": { |
184 "activate": { | 239 "activate": { |
185 "description": "Activates a subscription previously suspende
d by the reseller", | 240 "description": "Activates a subscription previously suspende
d by the reseller", |
186 "httpMethod": "POST", | 241 "httpMethod": "POST", |
187 "id": "reseller.subscriptions.activate", | 242 "id": "reseller.subscriptions.activate", |
188 "parameterOrder": [ | 243 "parameterOrder": [ |
189 "customerId", | 244 "customerId", |
190 "subscriptionId" | 245 "subscriptionId" |
191 ], | 246 ], |
192 "parameters": { | 247 "parameters": { |
193 "customerId": { | 248 "customerId": { |
194 "description": "Id of the Customer", | 249 "description": "Either the customer's primary domain
name or the customer's unique identifier. If using the domain name, we do not r
ecommend using a customerId as a key for persistent data. If the domain name for
a customerId is changed, the Google system automatically updates.", |
195 "location": "path", | 250 "location": "path", |
196 "required": true, | 251 "required": true, |
197 "type": "string" | 252 "type": "string" |
198 }, | 253 }, |
199 "subscriptionId": { | 254 "subscriptionId": { |
200 "description": "Id of the subscription, which is uni
que for a customer", | 255 "description": "This is a required property. The sub
scriptionId is the subscription identifier and is unique for each customer. Sinc
e a subscriptionId changes when a subscription is updated, we recommend to not u
se this ID as a key for persistent data. And the subscriptionId can be found usi
ng the retrieve all reseller subscriptions method.", |
201 "location": "path", | 256 "location": "path", |
202 "required": true, | 257 "required": true, |
203 "type": "string" | 258 "type": "string" |
204 } | 259 } |
205 }, | 260 }, |
206 "path": "customers/{customerId}/subscriptions/{subscriptionI
d}/activate", | 261 "path": "customers/{customerId}/subscriptions/{subscriptionI
d}/activate", |
207 "response": { | 262 "response": { |
208 "$ref": "Subscription" | 263 "$ref": "Subscription" |
209 }, | 264 }, |
210 "scopes": [ | 265 "scopes": [ |
211 "https://www.googleapis.com/auth/apps.order" | 266 "https://www.googleapis.com/auth/apps.order" |
212 ] | 267 ] |
213 }, | 268 }, |
214 "changePlan": { | 269 "changePlan": { |
215 "description": "Changes the plan of a subscription", | 270 "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.", |
216 "httpMethod": "POST", | 271 "httpMethod": "POST", |
217 "id": "reseller.subscriptions.changePlan", | 272 "id": "reseller.subscriptions.changePlan", |
218 "parameterOrder": [ | 273 "parameterOrder": [ |
219 "customerId", | 274 "customerId", |
220 "subscriptionId" | 275 "subscriptionId" |
221 ], | 276 ], |
222 "parameters": { | 277 "parameters": { |
223 "customerId": { | 278 "customerId": { |
224 "description": "Id of the Customer", | 279 "description": "Either the customer's primary domain
name or the customer's unique identifier. If using the domain name, we do not r
ecommend using a customerId as a key for persistent data. If the domain name for
a customerId is changed, the Google system automatically updates.", |
225 "location": "path", | 280 "location": "path", |
226 "required": true, | 281 "required": true, |
227 "type": "string" | 282 "type": "string" |
228 }, | 283 }, |
229 "subscriptionId": { | 284 "subscriptionId": { |
230 "description": "Id of the subscription, which is uni
que for a customer", | 285 "description": "This is a required property. The sub
scriptionId is the subscription identifier and is unique for each customer. Sinc
e a subscriptionId changes when a subscription is updated, we recommend to not u
se this ID as a key for persistent data. And the subscriptionId can be found usi
ng the retrieve all reseller subscriptions method.", |
231 "location": "path", | 286 "location": "path", |
232 "required": true, | 287 "required": true, |
233 "type": "string" | 288 "type": "string" |
234 } | 289 } |
235 }, | 290 }, |
236 "path": "customers/{customerId}/subscriptions/{subscriptionI
d}/changePlan", | 291 "path": "customers/{customerId}/subscriptions/{subscriptionI
d}/changePlan", |
237 "request": { | 292 "request": { |
238 "$ref": "ChangePlanRequest" | 293 "$ref": "ChangePlanRequest" |
239 }, | 294 }, |
240 "response": { | 295 "response": { |
241 "$ref": "Subscription" | 296 "$ref": "Subscription" |
242 }, | 297 }, |
243 "scopes": [ | 298 "scopes": [ |
244 "https://www.googleapis.com/auth/apps.order" | 299 "https://www.googleapis.com/auth/apps.order" |
245 ] | 300 ] |
246 }, | 301 }, |
247 "changeRenewalSettings": { | 302 "changeRenewalSettings": { |
248 "description": "Changes the renewal settings of a subscripti
on", | 303 "description": "Update a user license's renewal settings. Th
is is applicable for accounts with annual commitment plans only.", |
249 "httpMethod": "POST", | 304 "httpMethod": "POST", |
250 "id": "reseller.subscriptions.changeRenewalSettings", | 305 "id": "reseller.subscriptions.changeRenewalSettings", |
251 "parameterOrder": [ | 306 "parameterOrder": [ |
252 "customerId", | 307 "customerId", |
253 "subscriptionId" | 308 "subscriptionId" |
254 ], | 309 ], |
255 "parameters": { | 310 "parameters": { |
256 "customerId": { | 311 "customerId": { |
257 "description": "Id of the Customer", | 312 "description": "Either the customer's primary domain
name or the customer's unique identifier. If using the domain name, we do not r
ecommend using a customerId as a key for persistent data. If the domain name for
a customerId is changed, the Google system automatically updates.", |
258 "location": "path", | 313 "location": "path", |
259 "required": true, | 314 "required": true, |
260 "type": "string" | 315 "type": "string" |
261 }, | 316 }, |
262 "subscriptionId": { | 317 "subscriptionId": { |
263 "description": "Id of the subscription, which is uni
que for a customer", | 318 "description": "This is a required property. The sub
scriptionId is the subscription identifier and is unique for each customer. Sinc
e a subscriptionId changes when a subscription is updated, we recommend to not u
se this ID as a key for persistent data. And the subscriptionId can be found usi
ng the retrieve all reseller subscriptions method.", |
264 "location": "path", | 319 "location": "path", |
265 "required": true, | 320 "required": true, |
266 "type": "string" | 321 "type": "string" |
267 } | 322 } |
268 }, | 323 }, |
269 "path": "customers/{customerId}/subscriptions/{subscriptionI
d}/changeRenewalSettings", | 324 "path": "customers/{customerId}/subscriptions/{subscriptionI
d}/changeRenewalSettings", |
270 "request": { | 325 "request": { |
271 "$ref": "RenewalSettings" | 326 "$ref": "RenewalSettings" |
272 }, | 327 }, |
273 "response": { | 328 "response": { |
274 "$ref": "Subscription" | 329 "$ref": "Subscription" |
275 }, | 330 }, |
276 "scopes": [ | 331 "scopes": [ |
277 "https://www.googleapis.com/auth/apps.order" | 332 "https://www.googleapis.com/auth/apps.order" |
278 ] | 333 ] |
279 }, | 334 }, |
280 "changeSeats": { | 335 "changeSeats": { |
281 "description": "Changes the seats configuration of a subscri
ption", | 336 "description": "Update a subscription's user license setting
s.", |
282 "httpMethod": "POST", | 337 "httpMethod": "POST", |
283 "id": "reseller.subscriptions.changeSeats", | 338 "id": "reseller.subscriptions.changeSeats", |
284 "parameterOrder": [ | 339 "parameterOrder": [ |
285 "customerId", | 340 "customerId", |
286 "subscriptionId" | 341 "subscriptionId" |
287 ], | 342 ], |
288 "parameters": { | 343 "parameters": { |
289 "customerId": { | 344 "customerId": { |
290 "description": "Id of the Customer", | 345 "description": "Either the customer's primary domain
name or the customer's unique identifier. If using the domain name, we do not r
ecommend using a customerId as a key for persistent data. If the domain name for
a customerId is changed, the Google system automatically updates.", |
291 "location": "path", | 346 "location": "path", |
292 "required": true, | 347 "required": true, |
293 "type": "string" | 348 "type": "string" |
294 }, | 349 }, |
295 "subscriptionId": { | 350 "subscriptionId": { |
296 "description": "Id of the subscription, which is uni
que for a customer", | 351 "description": "This is a required property. The sub
scriptionId is the subscription identifier and is unique for each customer. Sinc
e a subscriptionId changes when a subscription is updated, we recommend to not u
se this ID as a key for persistent data. And the subscriptionId can be found usi
ng the retrieve all reseller subscriptions method.", |
297 "location": "path", | 352 "location": "path", |
298 "required": true, | 353 "required": true, |
299 "type": "string" | 354 "type": "string" |
300 } | 355 } |
301 }, | 356 }, |
302 "path": "customers/{customerId}/subscriptions/{subscriptionI
d}/changeSeats", | 357 "path": "customers/{customerId}/subscriptions/{subscriptionI
d}/changeSeats", |
303 "request": { | 358 "request": { |
304 "$ref": "Seats" | 359 "$ref": "Seats" |
305 }, | 360 }, |
306 "response": { | 361 "response": { |
307 "$ref": "Subscription" | 362 "$ref": "Subscription" |
308 }, | 363 }, |
309 "scopes": [ | 364 "scopes": [ |
310 "https://www.googleapis.com/auth/apps.order" | 365 "https://www.googleapis.com/auth/apps.order" |
311 ] | 366 ] |
312 }, | 367 }, |
313 "delete": { | 368 "delete": { |
314 "description": "Cancels/Downgrades a subscription.", | 369 "description": "Cancel, suspend or transfer a subscription t
o direct.", |
315 "httpMethod": "DELETE", | 370 "httpMethod": "DELETE", |
316 "id": "reseller.subscriptions.delete", | 371 "id": "reseller.subscriptions.delete", |
317 "parameterOrder": [ | 372 "parameterOrder": [ |
318 "customerId", | 373 "customerId", |
319 "subscriptionId", | 374 "subscriptionId", |
320 "deletionType" | 375 "deletionType" |
321 ], | 376 ], |
322 "parameters": { | 377 "parameters": { |
323 "customerId": { | 378 "customerId": { |
324 "description": "Id of the Customer", | 379 "description": "Either the customer's primary domain
name or the customer's unique identifier. If using the domain name, we do not r
ecommend using a customerId as a key for persistent data. If the domain name for
a customerId is changed, the Google system automatically updates.", |
325 "location": "path", | 380 "location": "path", |
326 "required": true, | 381 "required": true, |
327 "type": "string" | 382 "type": "string" |
328 }, | 383 }, |
329 "deletionType": { | 384 "deletionType": { |
330 "description": "Whether the subscription is to be fu
lly cancelled or downgraded", | 385 "description": "The deletionType query string enable
s the cancellation, downgrade, or suspension of a subscription.", |
331 "enum": [ | 386 "enum": [ |
332 "cancel", | 387 "cancel", |
333 "downgrade", | 388 "downgrade", |
334 "suspend", | 389 "suspend", |
335 "transfer_to_direct" | 390 "transfer_to_direct" |
336 ], | 391 ], |
337 "enumDescriptions": [ | 392 "enumDescriptions": [ |
338 "Cancels the subscription immediately", | 393 "Cancels the subscription immediately. This does
not apply to a G Suite subscription.", |
339 "Downgrades a Google Apps for Business subscript
ion to Google Apps", | 394 "Downgrades a G Suite subscription to a Google A
pps 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 n
o longer managed by the reseller.\n\nA G Suite subscription's downgrade cannot b
e 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.", |
340 "Suspends the subscriptions for 4 days before ca
ncelling it", | 395 "(DEPRECATED) The G Suite account is suspended f
or 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 su
spension can be lifted, using the reseller tools.\n\nA G Suite subscription's su
spension can not be invoked if an active or suspended Google Drive or Google Vau
lt subscription is present. The Google Drive or Google Vault subscription must b
e cancelled before the G Suite subscription's suspension is invoked.", |
341 "Transfers a subscription directly to Google" | 396 "Transfers a subscription directly to Google. T
he customer is immediately transferred to a direct billing relationship with Goo
gle and is given a short amount of time with no service interruption. The custom
er can then choose to set up billing directly with Google by using a credit card
, or they can transfer to another reseller." |
342 ], | 397 ], |
343 "location": "query", | 398 "location": "query", |
344 "required": true, | 399 "required": true, |
345 "type": "string" | 400 "type": "string" |
346 }, | 401 }, |
347 "subscriptionId": { | 402 "subscriptionId": { |
348 "description": "Id of the subscription, which is uni
que for a customer", | 403 "description": "This is a required property. The sub
scriptionId is the subscription identifier and is unique for each customer. Sinc
e a subscriptionId changes when a subscription is updated, we recommend to not u
se this ID as a key for persistent data. And the subscriptionId can be found usi
ng the retrieve all reseller subscriptions method.", |
349 "location": "path", | 404 "location": "path", |
350 "required": true, | 405 "required": true, |
351 "type": "string" | 406 "type": "string" |
352 } | 407 } |
353 }, | 408 }, |
354 "path": "customers/{customerId}/subscriptions/{subscriptionI
d}", | 409 "path": "customers/{customerId}/subscriptions/{subscriptionI
d}", |
355 "scopes": [ | 410 "scopes": [ |
356 "https://www.googleapis.com/auth/apps.order" | 411 "https://www.googleapis.com/auth/apps.order" |
357 ] | 412 ] |
358 }, | 413 }, |
359 "get": { | 414 "get": { |
360 "description": "Gets a subscription of the customer.", | 415 "description": "Get a specific subscription.", |
361 "httpMethod": "GET", | 416 "httpMethod": "GET", |
362 "id": "reseller.subscriptions.get", | 417 "id": "reseller.subscriptions.get", |
363 "parameterOrder": [ | 418 "parameterOrder": [ |
364 "customerId", | 419 "customerId", |
365 "subscriptionId" | 420 "subscriptionId" |
366 ], | 421 ], |
367 "parameters": { | 422 "parameters": { |
368 "customerId": { | 423 "customerId": { |
369 "description": "Id of the Customer", | 424 "description": "Either the customer's primary domain
name or the customer's unique identifier. If using the domain name, we do not r
ecommend using a customerId as a key for persistent data. If the domain name for
a customerId is changed, the Google system automatically updates.", |
370 "location": "path", | 425 "location": "path", |
371 "required": true, | 426 "required": true, |
372 "type": "string" | 427 "type": "string" |
373 }, | 428 }, |
374 "subscriptionId": { | 429 "subscriptionId": { |
375 "description": "Id of the subscription, which is uni
que for a customer", | 430 "description": "This is a required property. The sub
scriptionId is the subscription identifier and is unique for each customer. Sinc
e a subscriptionId changes when a subscription is updated, we recommend to not u
se this ID as a key for persistent data. And the subscriptionId can be found usi
ng the retrieve all reseller subscriptions method.", |
376 "location": "path", | 431 "location": "path", |
377 "required": true, | 432 "required": true, |
378 "type": "string" | 433 "type": "string" |
379 } | 434 } |
380 }, | 435 }, |
381 "path": "customers/{customerId}/subscriptions/{subscriptionI
d}", | 436 "path": "customers/{customerId}/subscriptions/{subscriptionI
d}", |
382 "response": { | 437 "response": { |
383 "$ref": "Subscription" | 438 "$ref": "Subscription" |
384 }, | 439 }, |
385 "scopes": [ | 440 "scopes": [ |
386 "https://www.googleapis.com/auth/apps.order", | 441 "https://www.googleapis.com/auth/apps.order", |
387 "https://www.googleapis.com/auth/apps.order.readonly" | 442 "https://www.googleapis.com/auth/apps.order.readonly" |
388 ] | 443 ] |
389 }, | 444 }, |
390 "insert": { | 445 "insert": { |
391 "description": "Creates/Transfers a subscription for the cus
tomer.", | 446 "description": "Create or transfer a subscription.", |
392 "httpMethod": "POST", | 447 "httpMethod": "POST", |
393 "id": "reseller.subscriptions.insert", | 448 "id": "reseller.subscriptions.insert", |
394 "parameterOrder": [ | 449 "parameterOrder": [ |
395 "customerId" | 450 "customerId" |
396 ], | 451 ], |
397 "parameters": { | 452 "parameters": { |
398 "customerAuthToken": { | 453 "customerAuthToken": { |
399 "description": "An auth token needed for transferrin
g a subscription. Can be generated at https://www.google.com/a/cpanel/customer-d
omain/TransferToken. Optional.", | 454 "description": "The customerAuthToken query string i
s required when creating a resold account that transfers a direct customer's sub
scription or transfers another reseller customer's subscription to your reseller
management. This is a hexadecimal authentication token needed to complete the s
ubscription transfer. For more information, see the administrator help center.", |
400 "location": "query", | 455 "location": "query", |
401 "type": "string" | 456 "type": "string" |
402 }, | 457 }, |
403 "customerId": { | 458 "customerId": { |
404 "description": "Id of the Customer", | 459 "description": "Either the customer's primary domain
name or the customer's unique identifier. If using the domain name, we do not r
ecommend using a customerId as a key for persistent data. If the domain name for
a customerId is changed, the Google system automatically updates.", |
405 "location": "path", | 460 "location": "path", |
406 "required": true, | 461 "required": true, |
407 "type": "string" | 462 "type": "string" |
408 } | 463 } |
409 }, | 464 }, |
410 "path": "customers/{customerId}/subscriptions", | 465 "path": "customers/{customerId}/subscriptions", |
411 "request": { | 466 "request": { |
412 "$ref": "Subscription" | 467 "$ref": "Subscription" |
413 }, | 468 }, |
414 "response": { | 469 "response": { |
415 "$ref": "Subscription" | 470 "$ref": "Subscription" |
416 }, | 471 }, |
417 "scopes": [ | 472 "scopes": [ |
418 "https://www.googleapis.com/auth/apps.order" | 473 "https://www.googleapis.com/auth/apps.order" |
419 ] | 474 ] |
420 }, | 475 }, |
421 "list": { | 476 "list": { |
422 "description": "Lists subscriptions of a reseller, optionall
y filtered by a customer name prefix.", | 477 "description": "List of subscriptions managed by the reselle
r. The list can be all subscriptions, all of a customer's subscriptions, or all
of a customer's transferable subscriptions.", |
423 "httpMethod": "GET", | 478 "httpMethod": "GET", |
424 "id": "reseller.subscriptions.list", | 479 "id": "reseller.subscriptions.list", |
425 "parameters": { | 480 "parameters": { |
426 "customerAuthToken": { | 481 "customerAuthToken": { |
427 "description": "An auth token needed if the customer
is not a resold customer of this reseller. Can be generated at https://www.goog
le.com/a/cpanel/customer-domain/TransferToken.Optional.", | 482 "description": "The customerAuthToken query string i
s required when creating a resold account that transfers a direct customer's sub
scription or transfers another reseller customer's subscription to your reseller
management. This is a hexadecimal authentication token needed to complete the s
ubscription transfer. For more information, see the administrator help center.", |
428 "location": "query", | 483 "location": "query", |
429 "type": "string" | 484 "type": "string" |
430 }, | 485 }, |
431 "customerId": { | 486 "customerId": { |
432 "description": "Id of the Customer", | 487 "description": "Either the customer's primary domain
name or the customer's unique identifier. If using the domain name, we do not r
ecommend using a customerId as a key for persistent data. If the domain name for
a customerId is changed, the Google system automatically updates.", |
433 "location": "query", | 488 "location": "query", |
434 "type": "string" | 489 "type": "string" |
435 }, | 490 }, |
436 "customerNamePrefix": { | 491 "customerNamePrefix": { |
437 "description": "Prefix of the customer's domain name
by which the subscriptions should be filtered. Optional", | 492 "description": "When retrieving all of your subscrip
tions and filtering for specific customers, you can enter a prefix for a custome
r name. Using an example customer group that includes exam.com, example20.com an
d example.com: \n- exa -- Returns all customer names that start with 'exa' whic
h could include exam.com, example20.com, and example.com. A name prefix is simil
ar to using a regular expression's asterisk, exa*. \n- example -- Returns exampl
e20.com and example.com.", |
438 "location": "query", | 493 "location": "query", |
439 "type": "string" | 494 "type": "string" |
440 }, | 495 }, |
441 "maxResults": { | 496 "maxResults": { |
442 "description": "Maximum number of results to return"
, | 497 "description": "When retrieving a large list, the ma
xResults is the maximum number of results per page. The nextPageToken value take
s you to the next page. The default is 20.", |
443 "format": "uint32", | 498 "format": "uint32", |
444 "location": "query", | 499 "location": "query", |
445 "maximum": "100", | 500 "maximum": "100", |
446 "minimum": "1", | 501 "minimum": "1", |
447 "type": "integer" | 502 "type": "integer" |
448 }, | 503 }, |
449 "pageToken": { | 504 "pageToken": { |
450 "description": "Token to specify next page in the li
st", | 505 "description": "Token to specify next page in the li
st", |
451 "location": "query", | 506 "location": "query", |
452 "type": "string" | 507 "type": "string" |
453 } | 508 } |
454 }, | 509 }, |
455 "path": "subscriptions", | 510 "path": "subscriptions", |
456 "response": { | 511 "response": { |
457 "$ref": "Subscriptions" | 512 "$ref": "Subscriptions" |
458 }, | 513 }, |
459 "scopes": [ | 514 "scopes": [ |
460 "https://www.googleapis.com/auth/apps.order", | 515 "https://www.googleapis.com/auth/apps.order", |
461 "https://www.googleapis.com/auth/apps.order.readonly" | 516 "https://www.googleapis.com/auth/apps.order.readonly" |
462 ] | 517 ] |
463 }, | 518 }, |
464 "startPaidService": { | 519 "startPaidService": { |
465 "description": "Starts paid service of a trial subscription"
, | 520 "description": "Immediately move a 30-day free trial subscri
ption to a paid service subscription.", |
466 "httpMethod": "POST", | 521 "httpMethod": "POST", |
467 "id": "reseller.subscriptions.startPaidService", | 522 "id": "reseller.subscriptions.startPaidService", |
468 "parameterOrder": [ | 523 "parameterOrder": [ |
469 "customerId", | 524 "customerId", |
470 "subscriptionId" | 525 "subscriptionId" |
471 ], | 526 ], |
472 "parameters": { | 527 "parameters": { |
473 "customerId": { | 528 "customerId": { |
474 "description": "Id of the Customer", | 529 "description": "Either the customer's primary domain
name or the customer's unique identifier. If using the domain name, we do not r
ecommend using a customerId as a key for persistent data. If the domain name for
a customerId is changed, the Google system automatically updates.", |
475 "location": "path", | 530 "location": "path", |
476 "required": true, | 531 "required": true, |
477 "type": "string" | 532 "type": "string" |
478 }, | 533 }, |
479 "subscriptionId": { | 534 "subscriptionId": { |
480 "description": "Id of the subscription, which is uni
que for a customer", | 535 "description": "This is a required property. The sub
scriptionId is the subscription identifier and is unique for each customer. Sinc
e a subscriptionId changes when a subscription is updated, we recommend to not u
se this ID as a key for persistent data. And the subscriptionId can be found usi
ng the retrieve all reseller subscriptions method.", |
481 "location": "path", | 536 "location": "path", |
482 "required": true, | 537 "required": true, |
483 "type": "string" | 538 "type": "string" |
484 } | 539 } |
485 }, | 540 }, |
486 "path": "customers/{customerId}/subscriptions/{subscriptionI
d}/startPaidService", | 541 "path": "customers/{customerId}/subscriptions/{subscriptionI
d}/startPaidService", |
487 "response": { | 542 "response": { |
488 "$ref": "Subscription" | 543 "$ref": "Subscription" |
489 }, | 544 }, |
490 "scopes": [ | 545 "scopes": [ |
491 "https://www.googleapis.com/auth/apps.order" | 546 "https://www.googleapis.com/auth/apps.order" |
492 ] | 547 ] |
493 }, | 548 }, |
494 "suspend": { | 549 "suspend": { |
495 "description": "Suspends an active subscription", | 550 "description": "Suspends an active subscription.", |
496 "httpMethod": "POST", | 551 "httpMethod": "POST", |
497 "id": "reseller.subscriptions.suspend", | 552 "id": "reseller.subscriptions.suspend", |
498 "parameterOrder": [ | 553 "parameterOrder": [ |
499 "customerId", | 554 "customerId", |
500 "subscriptionId" | 555 "subscriptionId" |
501 ], | 556 ], |
502 "parameters": { | 557 "parameters": { |
503 "customerId": { | 558 "customerId": { |
504 "description": "Id of the Customer", | 559 "description": "Either the customer's primary domain
name or the customer's unique identifier. If using the domain name, we do not r
ecommend using a customerId as a key for persistent data. If the domain name for
a customerId is changed, the Google system automatically updates.", |
505 "location": "path", | 560 "location": "path", |
506 "required": true, | 561 "required": true, |
507 "type": "string" | 562 "type": "string" |
508 }, | 563 }, |
509 "subscriptionId": { | 564 "subscriptionId": { |
510 "description": "Id of the subscription, which is uni
que for a customer", | 565 "description": "This is a required property. The sub
scriptionId is the subscription identifier and is unique for each customer. Sinc
e a subscriptionId changes when a subscription is updated, we recommend to not u
se this ID as a key for persistent data. And the subscriptionId can be found usi
ng the retrieve all reseller subscriptions method.", |
511 "location": "path", | 566 "location": "path", |
512 "required": true, | 567 "required": true, |
513 "type": "string" | 568 "type": "string" |
514 } | 569 } |
515 }, | 570 }, |
516 "path": "customers/{customerId}/subscriptions/{subscriptionI
d}/suspend", | 571 "path": "customers/{customerId}/subscriptions/{subscriptionI
d}/suspend", |
517 "response": { | 572 "response": { |
518 "$ref": "Subscription" | 573 "$ref": "Subscription" |
519 }, | 574 }, |
520 "scopes": [ | 575 "scopes": [ |
521 "https://www.googleapis.com/auth/apps.order" | 576 "https://www.googleapis.com/auth/apps.order" |
522 ] | 577 ] |
523 } | 578 } |
524 } | 579 } |
525 } | 580 } |
526 }, | 581 }, |
527 "revision": "20160329", | 582 "revision": "20170216", |
528 "rootUrl": "https://www.googleapis.com/", | 583 "rootUrl": "https://www.googleapis.com/", |
529 "schemas": { | 584 "schemas": { |
530 "Address": { | 585 "Address": { |
531 "description": "JSON template for address of a customer.", | 586 "description": "JSON template for address of a customer.", |
532 "id": "Address", | 587 "id": "Address", |
533 "properties": { | 588 "properties": { |
534 "addressLine1": { | 589 "addressLine1": { |
535 "description": "Address line 1 of the address.", | 590 "description": "A customer's physical address. An address ca
n be composed of one to three lines. The addressline2 and addressLine3 are optio
nal.", |
536 "type": "string" | 591 "type": "string" |
537 }, | 592 }, |
538 "addressLine2": { | 593 "addressLine2": { |
539 "description": "Address line 2 of the address.", | 594 "description": "Line 2 of the address.", |
540 "type": "string" | 595 "type": "string" |
541 }, | 596 }, |
542 "addressLine3": { | 597 "addressLine3": { |
543 "description": "Address line 3 of the address.", | 598 "description": "Line 3 of the address.", |
544 "type": "string" | 599 "type": "string" |
545 }, | 600 }, |
546 "contactName": { | 601 "contactName": { |
547 "description": "Name of the contact person.", | 602 "description": "The customer contact's name. This is require
d.", |
548 "type": "string" | 603 "type": "string" |
549 }, | 604 }, |
550 "countryCode": { | 605 "countryCode": { |
551 "description": "ISO 3166 country code.", | 606 "description": "For countryCode information, see the ISO 316
6 country code elements. Verify that country is approved for resale of Google pr
oducts. This property is required when creating a new customer.", |
552 "type": "string" | 607 "type": "string" |
553 }, | 608 }, |
554 "kind": { | 609 "kind": { |
555 "default": "customers#address", | 610 "default": "customers#address", |
556 "description": "Identifies the resource as a customer addres
s.", | 611 "description": "Identifies the resource as a customer addres
s. Value: customers#address", |
557 "type": "string" | 612 "type": "string" |
558 }, | 613 }, |
559 "locality": { | 614 "locality": { |
560 "description": "Name of the locality. This is in accordance
with - http://portablecontacts.net/draft-spec.html#address_element.", | 615 "description": "An example of a locality value is the city o
f San Francisco.", |
561 "type": "string" | 616 "type": "string" |
562 }, | 617 }, |
563 "organizationName": { | 618 "organizationName": { |
564 "description": "Name of the organization.", | 619 "description": "The company or company division name. This i
s required.", |
565 "type": "string" | 620 "type": "string" |
566 }, | 621 }, |
567 "postalCode": { | 622 "postalCode": { |
568 "description": "The postal code. This is in accordance with
- http://portablecontacts.net/draft-spec.html#address_element.", | 623 "description": "A postalCode example is a postal zip code su
ch as 94043. This property is required when creating a new customer.", |
569 "type": "string" | 624 "type": "string" |
570 }, | 625 }, |
571 "region": { | 626 "region": { |
572 "description": "Name of the region. This is in accordance wi
th - http://portablecontacts.net/draft-spec.html#address_element.", | 627 "description": "An example of a region value is CA for the s
tate of California.", |
573 "type": "string" | 628 "type": "string" |
574 } | 629 } |
575 }, | 630 }, |
576 "type": "object" | 631 "type": "object" |
577 }, | 632 }, |
578 "ChangePlanRequest": { | 633 "ChangePlanRequest": { |
579 "description": "JSON template for the ChangePlan rpc request.", | 634 "description": "JSON template for the ChangePlan rpc request.", |
580 "id": "ChangePlanRequest", | 635 "id": "ChangePlanRequest", |
581 "properties": { | 636 "properties": { |
582 "dealCode": { | 637 "dealCode": { |
583 "description": "External name of the deal code applicable fo
r the subscription. This field is optional. If missing, the deal price plan won'
t be used.", | 638 "description": "Google-issued code (100 char max) for discou
nted pricing on subscription plans. Deal code must be included in changePlan req
uest in order to receive discounted rate. This property is optional. If a deal c
ode has already been added to a subscription, this property may be left empty an
d 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 w
ill apply.", |
584 "type": "string" | 639 "type": "string" |
585 }, | 640 }, |
586 "kind": { | 641 "kind": { |
587 "default": "subscriptions#changePlanRequest", | 642 "default": "subscriptions#changePlanRequest", |
588 "description": "Identifies the resource as a subscription ch
ange plan request.", | 643 "description": "Identifies the resource as a subscription ch
ange plan request. Value: subscriptions#changePlanRequest", |
589 "type": "string" | 644 "type": "string" |
590 }, | 645 }, |
591 "planName": { | 646 "planName": { |
592 "description": "Name of the plan to change to.", | 647 "description": "The planName property is required. This is t
he name of the subscription's payment plan. For more information about the Googl
e payment plans, see API concepts.\n\nPossible values are: \n- ANNUAL_MONTHLY_P
AY - The annual commitment plan with monthly payments \n- ANNUAL_YEARLY_PAY - T
he annual commitment plan with yearly payments \n- FLEXIBLE - The flexible plan
\n- TRIAL - The 30-day free trial plan", |
593 "type": "string" | 648 "type": "string" |
594 }, | 649 }, |
595 "purchaseOrderId": { | 650 "purchaseOrderId": { |
596 "description": "Purchase order id for your order tracking pu
rposes.", | 651 "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 u
p in the invoice. The property accepts up to 80 plain text characters.", |
597 "type": "string" | 652 "type": "string" |
598 }, | 653 }, |
599 "seats": { | 654 "seats": { |
600 "$ref": "Seats", | 655 "$ref": "Seats", |
601 "description": "Number/Limit of seats in the new plan." | 656 "description": "This is a required property. The seats prope
rty is the number of user seat licenses." |
602 } | 657 } |
603 }, | 658 }, |
604 "type": "object" | 659 "type": "object" |
605 }, | 660 }, |
606 "Customer": { | 661 "Customer": { |
607 "description": "JSON template for a customer.", | 662 "description": "JSON template for a customer.", |
608 "id": "Customer", | 663 "id": "Customer", |
609 "properties": { | 664 "properties": { |
610 "alternateEmail": { | 665 "alternateEmail": { |
611 "description": "The alternate email of the customer.", | 666 "description": "Like the \"Customer email\" in the reseller
tools, this email is the secondary contact used if something happens to the cust
omer's service such as service outage or a security issue. This property is requ
ired when creating a new customer and should not use the same domain as customer
Domain.", |
612 "type": "string" | 667 "type": "string" |
613 }, | 668 }, |
614 "customerDomain": { | 669 "customerDomain": { |
615 "description": "The domain name of the customer.", | 670 "description": "The customer's primary domain name string. c
ustomerDomain is required when creating a new customer. Do not include the www p
refix in the domain when adding a customer.", |
616 "type": "string" | 671 "type": "string" |
617 }, | 672 }, |
618 "customerDomainVerified": { | 673 "customerDomainVerified": { |
619 "description": "Whether the customer's primary domain has be
en verified.", | 674 "description": "Whether the customer's primary domain has be
en verified.", |
620 "type": "boolean" | 675 "type": "boolean" |
621 }, | 676 }, |
622 "customerId": { | 677 "customerId": { |
623 "description": "The id of the customer.", | 678 "description": "This property will always be returned in a r
esponse as the unique identifier generated by Google. In a request, this propert
y can be either the primary domain or the unique identifier generated by Google.
", |
624 "type": "string" | 679 "type": "string" |
625 }, | 680 }, |
626 "kind": { | 681 "kind": { |
627 "default": "reseller#customer", | 682 "default": "reseller#customer", |
628 "description": "Identifies the resource as a customer.", | 683 "description": "Identifies the resource as a customer. Value
: reseller#customer", |
629 "type": "string" | 684 "type": "string" |
630 }, | 685 }, |
631 "phoneNumber": { | 686 "phoneNumber": { |
632 "description": "The phone number of the customer.", | 687 "description": "Customer contact phone number. This can be c
ontinuous numbers, with spaces, etc. But it must be a real phone number and not,
for example, \"123\". See phone local format conventions.", |
633 "type": "string" | 688 "type": "string" |
634 }, | 689 }, |
635 "postalAddress": { | 690 "postalAddress": { |
636 "$ref": "Address", | 691 "$ref": "Address", |
637 "description": "The postal address of the customer." | 692 "description": "A customer's address information. Each field
has a limit of 255 charcters." |
638 }, | 693 }, |
639 "resourceUiUrl": { | 694 "resourceUiUrl": { |
640 "description": "Ui url for customer resource.", | 695 "description": "URL to customer's Admin console dashboard. T
he read-only URL is generated by the API service. This is used if your client ap
plication requires the customer to complete a task in the Admin console.", |
641 "type": "string" | 696 "type": "string" |
642 } | 697 } |
643 }, | 698 }, |
644 "type": "object" | 699 "type": "object" |
645 }, | 700 }, |
646 "RenewalSettings": { | 701 "RenewalSettings": { |
647 "description": "JSON template for a subscription renewal settings.", | 702 "description": "JSON template for a subscription renewal settings.", |
648 "id": "RenewalSettings", | 703 "id": "RenewalSettings", |
649 "properties": { | 704 "properties": { |
650 "kind": { | 705 "kind": { |
651 "default": "subscriptions#renewalSettings", | 706 "default": "subscriptions#renewalSettings", |
652 "description": "Identifies the resource as a subscription re
newal setting.", | 707 "description": "Identifies the resource as a subscription re
newal setting. Value: subscriptions#renewalSettings", |
653 "type": "string" | 708 "type": "string" |
654 }, | 709 }, |
655 "renewalType": { | 710 "renewalType": { |
656 "description": "Subscription renewal type.", | 711 "description": "Renewal settings for the annual commitment p
lan. For more detailed information, see renewal options in the administrator hel
p center. When renewing a subscription, the renewalType is a required property."
, |
657 "type": "string" | 712 "type": "string" |
658 } | 713 } |
659 }, | 714 }, |
| 715 "type": "object" |
| 716 }, |
| 717 "ResellernotifyGetwatchdetailsResponse": { |
| 718 "description": "JSON template for resellernotify getwatchdetails res
ponse.", |
| 719 "id": "ResellernotifyGetwatchdetailsResponse", |
| 720 "properties": { |
| 721 "serviceAccountEmailAddresses": { |
| 722 "description": "List of registered service accounts.", |
| 723 "items": { |
| 724 "type": "string" |
| 725 }, |
| 726 "type": "array" |
| 727 }, |
| 728 "topicName": { |
| 729 "description": "Topic name of the PubSub", |
| 730 "type": "string" |
| 731 } |
| 732 }, |
| 733 "type": "object" |
| 734 }, |
| 735 "ResellernotifyResource": { |
| 736 "description": "JSON template for resellernotify response.", |
| 737 "id": "ResellernotifyResource", |
| 738 "properties": { |
| 739 "topicName": { |
| 740 "description": "Topic name of the PubSub", |
| 741 "type": "string" |
| 742 } |
| 743 }, |
660 "type": "object" | 744 "type": "object" |
661 }, | 745 }, |
662 "Seats": { | 746 "Seats": { |
663 "description": "JSON template for subscription seats.", | 747 "description": "JSON template for subscription seats.", |
664 "id": "Seats", | 748 "id": "Seats", |
665 "properties": { | 749 "properties": { |
666 "kind": { | 750 "kind": { |
667 "default": "subscriptions#seats", | 751 "default": "subscriptions#seats", |
668 "description": "Identifies the resource as a subscription ch
ange plan request.", | 752 "description": "Identifies the resource as a subscription ch
ange plan request. Value: subscriptions#seats", |
669 "type": "string" | 753 "type": "string" |
670 }, | 754 }, |
671 "licensedNumberOfSeats": { | 755 "licensedNumberOfSeats": { |
672 "description": "Read-only field containing the current numbe
r of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscri
ptions such as Google-Vault and Drive-storage.", | 756 "description": "Read-only field containing the current numbe
r of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscri
ptions such as Google-Vault and Drive-storage.", |
673 "format": "int32", | 757 "format": "int32", |
674 "type": "integer" | 758 "type": "integer" |
675 }, | 759 }, |
676 "maximumNumberOfSeats": { | 760 "maximumNumberOfSeats": { |
677 "description": "Maximum number of seats that can be purchase
d. This needs to be provided only for a non-commitment plan. For a commitment pl
an it is decided by the contract.", | 761 "description": "The maximumNumberOfSeats property is the max
imum 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 mo
nthly or yearly payments) — For this plan, a reseller is invoiced on the number
of user licenses in the numberOfSeats property. The maximumNumberOfSeats propert
y is a read-only property in the API's response. \n- flexible plan — For this p
lan, 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 ha
s for user license provisioning. This quantity can be increased up to the maximu
m limit defined in the reseller's contract. And the minimum quantity is the curr
ent number of users in the customer account. \n- 30-day free trial plan — A sub
scription in a 30-day free trial is restricted to maximum 10 seats.", |
678 "format": "int32", | 762 "format": "int32", |
679 "type": "integer" | 763 "type": "integer" |
680 }, | 764 }, |
681 "numberOfSeats": { | 765 "numberOfSeats": { |
682 "description": "Number of seats to purchase. This is applica
ble only for a commitment plan.", | 766 "description": "The numberOfSeats property holds the custome
r's number of user licenses. How a user's licenses are managed depends on the su
bscription's plan: \n- annual commitment plan (with monthly or yearly pay) — Fo
r this plan, a reseller is invoiced on the number of user licenses in the number
OfSeats 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 numbe
rOfSeats can not be reduced until renewal. The reseller is invoiced based on the
numberOfSeats value regardless of how many of these user licenses are provision
ed users. \n- flexible plan — For this plan, a reseller is invoiced on the actu
al number of users which is capped by the maximumNumberOfSeats. The numberOfSeat
s 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 reque
st or response for an account in a 30-day trial.", |
683 "format": "int32", | 767 "format": "int32", |
684 "type": "integer" | 768 "type": "integer" |
685 } | 769 } |
686 }, | 770 }, |
687 "type": "object" | 771 "type": "object" |
688 }, | 772 }, |
689 "Subscription": { | 773 "Subscription": { |
690 "description": "JSON template for a subscription.", | 774 "description": "JSON template for a subscription.", |
691 "id": "Subscription", | 775 "id": "Subscription", |
692 "properties": { | 776 "properties": { |
693 "billingMethod": { | 777 "billingMethod": { |
694 "description": "Billing method of this subscription.", | 778 "description": "Read-only field that returns the current bil
ling method for a subscription.", |
695 "type": "string" | 779 "type": "string" |
696 }, | 780 }, |
697 "creationTime": { | 781 "creationTime": { |
698 "description": "Creation time of this subscription in millis
econds since Unix epoch.", | 782 "description": "The creationTime property is the date when s
ubscription was created. It is in milliseconds using the Epoch format. See an ex
ample Epoch converter.", |
699 "format": "int64", | 783 "format": "int64", |
700 "type": "string" | 784 "type": "string" |
701 }, | 785 }, |
702 "customerDomain": { | 786 "customerDomain": { |
703 "description": "Primary domain name of the customer", | 787 "description": "Primary domain name of the customer", |
704 "type": "string" | 788 "type": "string" |
705 }, | 789 }, |
706 "customerId": { | 790 "customerId": { |
707 "description": "The id of the customer to whom the subscript
ion belongs.", | 791 "description": "This property will always be returned in a r
esponse as the unique identifier generated by Google. In a request, this propert
y can be either the primary domain or the unique identifier generated by Google.
", |
708 "type": "string" | 792 "type": "string" |
709 }, | 793 }, |
710 "dealCode": { | 794 "dealCode": { |
711 "description": "External name of the deal, if this subscript
ion was provisioned under one. Otherwise this field will be empty.", | 795 "description": "Google-issued code (100 char max) for discou
nted pricing on subscription plans. Deal code must be included in insert request
s in order to receive discounted rate. This property is optional, regular pricin
g applies if left empty.", |
712 "type": "string" | 796 "type": "string" |
713 }, | 797 }, |
714 "kind": { | 798 "kind": { |
715 "default": "reseller#subscription", | 799 "default": "reseller#subscription", |
716 "description": "Identifies the resource as a Subscription.", | 800 "description": "Identifies the resource as a Subscription. V
alue: reseller#subscription", |
717 "type": "string" | 801 "type": "string" |
718 }, | 802 }, |
719 "plan": { | 803 "plan": { |
720 "description": "Plan details of the subscription", | 804 "description": "The plan property is required. In this versi
on 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 pl
ans, see the API concepts.", |
721 "properties": { | 805 "properties": { |
722 "commitmentInterval": { | 806 "commitmentInterval": { |
723 "description": "Interval of the commitment if it is
a commitment plan.", | 807 "description": "In this version of the API, annual c
ommitment plan's interval is one year.", |
724 "properties": { | 808 "properties": { |
725 "endTime": { | 809 "endTime": { |
726 "description": "End time of the commitment i
nterval in milliseconds since Unix epoch.", | 810 "description": "An annual commitment plan's
interval's endTime in milliseconds using the UNIX Epoch format. See an example E
poch converter.", |
727 "format": "int64", | 811 "format": "int64", |
728 "type": "string" | 812 "type": "string" |
729 }, | 813 }, |
730 "startTime": { | 814 "startTime": { |
731 "description": "Start time of the commitment
interval in milliseconds since Unix epoch.", | 815 "description": "An annual commitment plan's
interval's startTime in milliseconds using UNIX Epoch format. See an example Epo
ch converter.", |
732 "format": "int64", | 816 "format": "int64", |
733 "type": "string" | 817 "type": "string" |
734 } | 818 } |
735 }, | 819 }, |
736 "type": "object" | 820 "type": "object" |
737 }, | 821 }, |
738 "isCommitmentPlan": { | 822 "isCommitmentPlan": { |
739 "description": "Whether the plan is a commitment pla
n or not.", | 823 "description": "The isCommitmentPlan property's bool
ean value identifies the plan as an annual commitment plan:\n- true — The subscr
iption's plan is an annual commitment plan.\n- false — The plan is not an annual
commitment plan.", |
740 "type": "boolean" | 824 "type": "boolean" |
741 }, | 825 }, |
742 "planName": { | 826 "planName": { |
743 "description": "The plan name of this subscription's
plan.", | 827 "description": "The planName property is required. T
his is the name of the subscription's plan. For more information about the Googl
e payment plans, see the API concepts.\n\nPossible values are: \n- ANNUAL_MONTH
LY_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 su
spended after the 30th free day if no payment plan is assigned. Calling changePl
an 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 i
mmediately after calling startPaidService.", |
744 "type": "string" | 828 "type": "string" |
745 } | 829 } |
746 }, | 830 }, |
747 "type": "object" | 831 "type": "object" |
748 }, | 832 }, |
749 "purchaseOrderId": { | 833 "purchaseOrderId": { |
750 "description": "Purchase order id for your order tracking pu
rposes.", | 834 "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 u
p in the invoice. The property accepts up to 80 plain text characters.", |
751 "type": "string" | 835 "type": "string" |
752 }, | 836 }, |
753 "renewalSettings": { | 837 "renewalSettings": { |
754 "$ref": "RenewalSettings", | 838 "$ref": "RenewalSettings", |
755 "description": "Renewal settings of the subscription." | 839 "description": "Renewal settings for the annual commitment p
lan. For more detailed information, see renewal options in the administrator hel
p center." |
756 }, | 840 }, |
757 "resourceUiUrl": { | 841 "resourceUiUrl": { |
758 "description": "Ui url for subscription resource.", | 842 "description": "URL to customer's Subscriptions page in the
Admin console. The read-only URL is generated by the API service. This is used i
f your client application requires the customer to complete a task using the Sub
scriptions page in the Admin console.", |
759 "type": "string" | 843 "type": "string" |
760 }, | 844 }, |
761 "seats": { | 845 "seats": { |
762 "$ref": "Seats", | 846 "$ref": "Seats", |
763 "description": "Number/Limit of seats in the new plan." | 847 "description": "This is a required property. The number and
limit of user seat licenses in the plan." |
764 }, | 848 }, |
765 "skuId": { | 849 "skuId": { |
766 "description": "Name of the sku for which this subscription
is purchased.", | 850 "description": "A required property. The skuId is a unique s
ystem 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 SK
U IDs.", |
767 "type": "string" | 851 "type": "string" |
768 }, | 852 }, |
769 "status": { | 853 "status": { |
770 "description": "Status of the subscription.", | 854 "description": "This is an optional property.", |
771 "type": "string" | 855 "type": "string" |
772 }, | 856 }, |
773 "subscriptionId": { | 857 "subscriptionId": { |
774 "description": "The id of the subscription.", | 858 "description": "The subscriptionId is the subscription ident
ifier and is unique for each customer. This is a required property. Since a subs
criptionId changes when a subscription is updated, we recommend not using this I
D as a key for persistent data. Use the subscriptionId as described in retrieve
all reseller subscriptions.", |
775 "type": "string" | 859 "type": "string" |
776 }, | 860 }, |
777 "suspensionReasons": { | 861 "suspensionReasons": { |
778 "description": "Read-only field containing an enumerable of
all the current suspension reasons for a subscription. It is possible for a subs
cription to have many concurrent, overlapping suspension reasons. A subscription
's STATUS is SUSPENDED until all pending suspensions are removed. Possible optio
ns include: \n- PENDING_TOS_ACCEPTANCE - The customer has not logged in and acc
epted 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 th
eir term. \n- RESELLER_INITIATED - A manual suspension invoked by a Reseller.
\n- TRIAL_ENDED - The customer's trial expired without a plan selected. \n- OTH
ER - The customer is suspended for an internal Google reason (e.g. abuse or othe
rwise).", | 862 "description": "Read-only field containing an enumerable of
all the current suspension reasons for a subscription. It is possible for a subs
cription to have many concurrent, overlapping suspension reasons. A subscription
's STATUS is SUSPENDED until all pending suspensions are removed.\n\nPossible op
tions 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 - T
he customer's commitment ended and their service was cancelled at the end of the
ir term. \n- RESELLER_INITIATED - A manual suspension invoked by a Reseller. \
n- TRIAL_ENDED - The customer's trial expired without a plan selected. \n- OTHE
R - The customer is suspended for an internal Google reason (e.g. abuse or other
wise).", |
779 "items": { | 863 "items": { |
780 "type": "string" | 864 "type": "string" |
781 }, | 865 }, |
782 "type": "array" | 866 "type": "array" |
783 }, | 867 }, |
784 "transferInfo": { | 868 "transferInfo": { |
785 "description": "Transfer related information for the subscri
ption.", | 869 "description": "Read-only transfer related information for t
he subscription. For more information, see retrieve transferable subscriptions f
or a customer.", |
786 "properties": { | 870 "properties": { |
787 "minimumTransferableSeats": { | 871 "minimumTransferableSeats": { |
| 872 "description": "When inserting a subscription, this
is the minimum number of seats listed in the transfer order for this product. Fo
r example, if the customer has 20 users, the reseller cannot place a transfer or
der of 15 seats. The minimum is 20 seats.", |
788 "format": "int32", | 873 "format": "int32", |
789 "type": "integer" | 874 "type": "integer" |
790 }, | 875 }, |
791 "transferabilityExpirationTime": { | 876 "transferabilityExpirationTime": { |
792 "description": "Time when transfer token or intent t
o transfer will expire.", | 877 "description": "The time when transfer token or inte
nt to transfer will expire. The time is in milliseconds using UNIX Epoch format.
", |
793 "format": "int64", | 878 "format": "int64", |
794 "type": "string" | 879 "type": "string" |
795 } | 880 } |
796 }, | 881 }, |
797 "type": "object" | 882 "type": "object" |
798 }, | 883 }, |
799 "trialSettings": { | 884 "trialSettings": { |
800 "description": "Trial Settings of the subscription.", | 885 "description": "The G Suite annual commitment and flexible p
ayment plans can be in a 30-day free trial. For more information, see the API co
ncepts.", |
801 "properties": { | 886 "properties": { |
802 "isInTrial": { | 887 "isInTrial": { |
803 "description": "Whether the subscription is in trial
.", | 888 "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.", |
804 "type": "boolean" | 889 "type": "boolean" |
805 }, | 890 }, |
806 "trialEndTime": { | 891 "trialEndTime": { |
807 "description": "End time of the trial in millisecond
s since Unix epoch.", | 892 "description": "Date when the trial ends. The value
is in milliseconds using the UNIX Epoch format. See an example Epoch converter."
, |
808 "format": "int64", | 893 "format": "int64", |
809 "type": "string" | 894 "type": "string" |
810 } | 895 } |
811 }, | 896 }, |
812 "type": "object" | 897 "type": "object" |
813 } | 898 } |
814 }, | 899 }, |
815 "type": "object" | 900 "type": "object" |
816 }, | 901 }, |
817 "Subscriptions": { | 902 "Subscriptions": { |
818 "description": "JSON template for a subscription list.", | 903 "description": "JSON template for a subscription list.", |
819 "id": "Subscriptions", | 904 "id": "Subscriptions", |
820 "properties": { | 905 "properties": { |
821 "kind": { | 906 "kind": { |
822 "default": "reseller#subscriptions", | 907 "default": "reseller#subscriptions", |
823 "description": "Identifies the resource as a collection of s
ubscriptions.", | 908 "description": "Identifies the resource as a collection of s
ubscriptions. Value: reseller#subscriptions", |
824 "type": "string" | 909 "type": "string" |
825 }, | 910 }, |
826 "nextPageToken": { | 911 "nextPageToken": { |
827 "description": "The continuation token, used to page through
large result sets. Provide this value in a subsequent request to return the nex
t page of results.", | 912 "description": "The continuation token, used to page through
large result sets. Provide this value in a subsequent request to return the nex
t page of results.", |
828 "type": "string" | 913 "type": "string" |
829 }, | 914 }, |
830 "subscriptions": { | 915 "subscriptions": { |
831 "description": "The subscriptions in this page of results.", | 916 "description": "The subscriptions in this page of results.", |
832 "items": { | 917 "items": { |
833 "$ref": "Subscription" | 918 "$ref": "Subscription" |
834 }, | 919 }, |
835 "type": "array" | 920 "type": "array" |
836 } | 921 } |
837 }, | 922 }, |
838 "type": "object" | 923 "type": "object" |
839 } | 924 } |
840 }, | 925 }, |
841 "servicePath": "apps/reseller/v1/", | 926 "servicePath": "apps/reseller/v1/", |
842 "title": "Enterprise Apps Reseller API", | 927 "title": "Enterprise Apps Reseller API", |
843 "version": "v1" | 928 "version": "v1" |
844 } | 929 } |
OLD | NEW |