Reference

Vercel REST API Interfaces

Shared interfaces referenced across multiple endpoints.
Table of Contents

ACLAction

1
{
2
"type": "string",
3
"enum": ["create", "delete", "read", "update", "list"],
4
"description": "Enum containing the actions that can be performed against a resource. Group operations are included."
5
}

AccessGroup

1
{
2
"properties": {
3
"name": {
4
"type": "string",
5
"description": "The name of this access group.",
6
"example": "my-access-group"
7
},
8
"createdAt": {
9
"type": "string",
10
"description": "Timestamp in milliseconds when the access group was created.",
11
"example": 1588720733602
12
},
13
"teamId": {
14
"type": "string",
15
"description": "ID of the team that this access group belongs to.",
16
"example": "team_123a6c5209bc3778245d011443644c8d27dc2c50"
17
},
18
"updatedAt": {
19
"type": "string",
20
"description": "Timestamp in milliseconds when the access group was last updated.",
21
"example": 1588720733602
22
},
23
"accessGroupId": {
24
"type": "string",
25
"description": "ID of the access group.",
26
"example": "ag_123a6c5209bc3778245d011443644c8d27dc2c50"
27
},
28
"membersCount": {
29
"type": "number",
30
"description": "Number of members in the access group.",
31
"example": 5
32
},
33
"projectsCount": {
34
"type": "number",
35
"description": "Number of projects in the access group.",
36
"example": 2
37
}
38
},
39
"required": [
40
"name",
41
"createdAt",
42
"teamId",
43
"updatedAt",
44
"accessGroupId",
45
"membersCount",
46
"projectsCount"
47
],
48
"type": "object",
49
"description": "Represents an Access Group."
50
}

AuthToken

1
{
2
"properties": {
3
"id": {
4
"type": "string",
5
"description": "The unique identifier of the token.",
6
"example": "5d9f2ebd38ddca62e5d51e9c1704c72530bdc8bfdd41e782a6687c48399e8391"
7
},
8
"name": {
9
"type": "string",
10
"description": "The human-readable name of the token."
11
},
12
"type": {
13
"type": "string",
14
"description": "The type of the token.",
15
"example": "oauth2-token"
16
},
17
"origin": {
18
"type": "string",
19
"description": "The origin of how the token was created.",
20
"example": "github"
21
},
22
"scopes": {
23
"items": {
24
"oneOf": [
25
{
26
"properties": {
27
"type": { "type": "string", "enum": ["user"] },
28
"origin": {
29
"type": "string",
30
"enum": [
31
"saml",
32
"github",
33
"gitlab",
34
"bitbucket",
35
"email",
36
"manual",
37
"passkey"
38
]
39
},
40
"createdAt": { "type": "number" },
41
"expiresAt": { "type": "number" }
42
},
43
"required": ["type", "origin", "createdAt"],
44
"type": "object",
45
"description": "The access scopes granted to the token."
46
},
47
{
48
"properties": {
49
"type": { "type": "string", "enum": ["team"] },
50
"teamId": { "type": "string" },
51
"origin": {
52
"type": "string",
53
"enum": [
54
"saml",
55
"github",
56
"gitlab",
57
"bitbucket",
58
"email",
59
"manual",
60
"passkey"
61
]
62
},
63
"createdAt": { "type": "number" },
64
"expiresAt": { "type": "number" }
65
},
66
"required": ["type", "teamId", "origin", "createdAt"],
67
"type": "object",
68
"description": "The access scopes granted to the token."
69
}
70
]
71
},
72
"type": "array",
73
"description": "The access scopes granted to the token."
74
},
75
"expiresAt": {
76
"type": "number",
77
"description": "Timestamp (in milliseconds) of when the token expires.",
78
"example": 1632816536002
79
},
80
"activeAt": {
81
"type": "number",
82
"description": "Timestamp (in milliseconds) of when the token was most recently used.",
83
"example": 1632816536002
84
},
85
"createdAt": {
86
"type": "number",
87
"description": "Timestamp (in milliseconds) of when the token was created.",
88
"example": 1632816536002
89
}
90
},
91
"required": ["id", "name", "type", "activeAt", "createdAt"],
92
"type": "object",
93
"description": "Authentication token metadata."
94
}

AuthUser

1
{
2
"properties": {
3
"createdAt": {
4
"type": "number",
5
"description": "UNIX timestamp (in milliseconds) when the User account was created.",
6
"example": 1630748523395
7
},
8
"softBlock": {
9
"nullable": true,
10
"properties": {
11
"blockedAt": { "type": "number" },
12
"reason": {
13
"type": "string",
14
"enum": [
15
"SUBSCRIPTION_CANCELED",
16
"SUBSCRIPTION_EXPIRED",
17
"UNPAID_INVOICE",
18
"ENTERPRISE_TRIAL_ENDED",
19
"FAIR_USE_LIMITS_EXCEEDED",
20
"BLOCKED_FOR_PLATFORM_ABUSE"
21
]
22
},
23
"blockedDueToOverageType": {
24
"type": "string",
25
"enum": [
26
"analyticsUsage",
27
"artifacts",
28
"bandwidth",
29
"blobStores",
30
"blobTotalAdvancedRequests",
31
"blobTotalAvgSizeInBytes",
32
"blobTotalGetResponseObjectSizeInBytes",
33
"blobTotalSimpleRequests",
34
"buildMinute",
35
"dataCacheRead",
36
"dataCacheRevalidation",
37
"dataCacheWrite",
38
"edgeConfigRead",
39
"edgeConfigWrite",
40
"edgeFunctionExecutionUnits",
41
"edgeMiddlewareInvocations",
42
"edgeRequest",
43
"edgeRequestAdditionalCpuDuration",
44
"fastDataTransfer",
45
"fastOriginTransfer",
46
"functionDuration",
47
"functionInvocation",
48
"logDrainsVolume",
49
"monitoringMetric",
50
"postgresComputeTime",
51
"postgresDataStorage",
52
"postgresDataTransfer",
53
"postgresDatabase",
54
"postgresWrittenData",
55
"serverlessFunctionExecution",
56
"sourceImages",
57
"storageRedisTotalBandwidthInBytes",
58
"storageRedisTotalCommands",
59
"storageRedisTotalDailyAvgStorageInBytes",
60
"storageRedisTotalDatabases",
61
"wafOwaspExcessBytes",
62
"wafOwaspRequests",
63
"wafRateLimitRequest",
64
"webAnalyticsEvent"
65
]
66
}
67
},
68
"required": ["blockedAt", "reason"],
69
"type": "object",
70
"description": "When the User account has been \"soft blocked\", this property will contain the date when the restriction was enacted, and the identifier for why."
71
},
72
"billing": {
73
"nullable": true,
74
"properties": {
75
"currency": { "type": "string", "enum": ["usd", "eur"] },
76
"cancelation": { "nullable": true, "type": "number" },
77
"period": {
78
"nullable": true,
79
"properties": {
80
"start": { "type": "number" },
81
"end": { "type": "number" }
82
},
83
"required": ["start", "end"],
84
"type": "object"
85
},
86
"contract": {
87
"nullable": true,
88
"properties": {
89
"start": { "type": "number" },
90
"end": { "type": "number" }
91
},
92
"required": ["start", "end"],
93
"type": "object"
94
},
95
"plan": { "type": "string", "enum": ["pro", "enterprise", "hobby"] },
96
"planIteration": { "type": "string" },
97
"platform": { "type": "string", "enum": ["stripe", "stripeTestMode"] },
98
"orbCustomerId": { "type": "string" },
99
"syncedAt": { "type": "number" },
100
"programType": { "type": "string", "enum": ["startup", "agency"] },
101
"trial": {
102
"nullable": true,
103
"properties": {
104
"start": { "type": "number" },
105
"end": { "type": "number" }
106
},
107
"required": ["start", "end"],
108
"type": "object"
109
},
110
"email": { "nullable": true, "type": "string" },
111
"tax": {
112
"nullable": true,
113
"properties": {
114
"type": { "type": "string" },
115
"id": { "type": "string" }
116
},
117
"required": ["type", "id"],
118
"type": "object"
119
},
120
"language": { "nullable": true, "type": "string" },
121
"address": {
122
"nullable": true,
123
"properties": {
124
"line1": { "type": "string" },
125
"line2": { "type": "string" },
126
"postalCode": { "type": "string" },
127
"city": { "type": "string" },
128
"country": { "type": "string" },
129
"state": { "type": "string" }
130
},
131
"type": "object"
132
},
133
"name": { "nullable": true, "type": "string" },
134
"invoiceItems": {
135
"nullable": true,
136
"properties": {
137
"concurrentBuilds": {
138
"properties": {
139
"tier": { "type": "number" },
140
"price": { "type": "number" },
141
"quantity": { "type": "number" },
142
"highestQuantity": {
143
"type": "number",
144
"description": "The highest quantity in the current period. Used to render the correct enable/disable UI for add-ons."
145
},
146
"name": { "type": "string" },
147
"hidden": { "type": "boolean" },
148
"createdAt": { "type": "number" },
149
"disabledAt": { "nullable": true, "type": "number" },
150
"frequency": {
151
"properties": {
152
"interval": { "type": "string", "enum": ["month"] },
153
"intervalCount": {
154
"type": "number",
155
"enum": [1, 3, 2, 6, 12]
156
}
157
},
158
"required": ["interval", "intervalCount"],
159
"type": "object"
160
},
161
"maxQuantity": { "type": "number" }
162
},
163
"required": ["price", "quantity", "hidden"],
164
"type": "object",
165
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
166
},
167
"webAnalytics": {
168
"properties": {
169
"tier": { "type": "number" },
170
"price": { "type": "number" },
171
"quantity": { "type": "number" },
172
"highestQuantity": {
173
"type": "number",
174
"description": "The highest quantity in the current period. Used to render the correct enable/disable UI for add-ons."
175
},
176
"name": { "type": "string" },
177
"hidden": { "type": "boolean" },
178
"createdAt": { "type": "number" },
179
"disabledAt": { "nullable": true, "type": "number" },
180
"frequency": {
181
"properties": {
182
"interval": { "type": "string", "enum": ["month"] },
183
"intervalCount": {
184
"type": "number",
185
"enum": [1, 3, 2, 6, 12]
186
}
187
},
188
"required": ["interval", "intervalCount"],
189
"type": "object"
190
},
191
"maxQuantity": { "type": "number" }
192
},
193
"required": ["price", "quantity", "hidden"],
194
"type": "object",
195
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
196
},
197
"pro": {
198
"properties": {
199
"tier": { "type": "number" },
200
"price": { "type": "number" },
201
"quantity": { "type": "number" },
202
"highestQuantity": {
203
"type": "number",
204
"description": "The highest quantity in the current period. Used to render the correct enable/disable UI for add-ons."
205
},
206
"name": { "type": "string" },
207
"hidden": { "type": "boolean" },
208
"createdAt": { "type": "number" },
209
"disabledAt": { "nullable": true, "type": "number" },
210
"frequency": {
211
"properties": {
212
"interval": { "type": "string", "enum": ["month"] },
213
"intervalCount": {
214
"type": "number",
215
"enum": [1, 3, 2, 6, 12]
216
}
217
},
218
"required": ["interval", "intervalCount"],
219
"type": "object"
220
},
221
"maxQuantity": { "type": "number" }
222
},
223
"required": ["price", "quantity", "hidden"],
224
"type": "object",
225
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
226
},
227
"enterprise": {
228
"properties": {
229
"tier": { "type": "number" },
230
"price": { "type": "number" },
231
"quantity": { "type": "number" },
232
"highestQuantity": {
233
"type": "number",
234
"description": "The highest quantity in the current period. Used to render the correct enable/disable UI for add-ons."
235
},
236
"name": { "type": "string" },
237
"hidden": { "type": "boolean" },
238
"createdAt": { "type": "number" },
239
"disabledAt": { "nullable": true, "type": "number" },
240
"frequency": {
241
"properties": {
242
"interval": { "type": "string", "enum": ["month"] },
243
"intervalCount": {
244
"type": "number",
245
"enum": [1, 3, 2, 6, 12]
246
}
247
},
248
"required": ["interval", "intervalCount"],
249
"type": "object"
250
},
251
"maxQuantity": { "type": "number" }
252
},
253
"required": ["price", "quantity", "hidden"],
254
"type": "object",
255
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
256
},
257
"hobby": {
258
"properties": {
259
"tier": { "type": "number" },
260
"price": { "type": "number" },
261
"quantity": { "type": "number" },
262
"highestQuantity": {
263
"type": "number",
264
"description": "The highest quantity in the current period. Used to render the correct enable/disable UI for add-ons."
265
},
266
"name": { "type": "string" },
267
"hidden": { "type": "boolean" },
268
"createdAt": { "type": "number" },
269
"disabledAt": { "nullable": true, "type": "number" },
270
"frequency": {
271
"properties": {
272
"interval": { "type": "string", "enum": ["month"] },
273
"intervalCount": {
274
"type": "number",
275
"enum": [1, 3, 2, 6, 12]
276
}
277
},
278
"required": ["interval", "intervalCount"],
279
"type": "object"
280
},
281
"maxQuantity": { "type": "number" }
282
},
283
"required": ["price", "quantity", "hidden"],
284
"type": "object",
285
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
286
},
287
"analytics": {
288
"properties": {
289
"tier": { "type": "number" },
290
"price": { "type": "number" },
291
"quantity": { "type": "number" },
292
"highestQuantity": {
293
"type": "number",
294
"description": "The highest quantity in the current period. Used to render the correct enable/disable UI for add-ons."
295
},
296
"name": { "type": "string" },
297
"hidden": { "type": "boolean" },
298
"createdAt": { "type": "number" },
299
"disabledAt": { "nullable": true, "type": "number" },
300
"frequency": {
301
"properties": {
302
"interval": { "type": "string", "enum": ["month"] },
303
"intervalCount": {
304
"type": "number",
305
"enum": [1, 3, 2, 6, 12]
306
}
307
},
308
"required": ["interval", "intervalCount"],
309
"type": "object"
310
},
311
"maxQuantity": { "type": "number" }
312
},
313
"required": ["price", "quantity", "hidden"],
314
"type": "object",
315
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
316
},
317
"developerExperiencePlatform": {
318
"properties": {
319
"tier": { "type": "number" },
320
"price": { "type": "number" },
321
"quantity": { "type": "number" },
322
"highestQuantity": {
323
"type": "number",
324
"description": "The highest quantity in the current period. Used to render the correct enable/disable UI for add-ons."
325
},
326
"name": { "type": "string" },
327
"hidden": { "type": "boolean" },
328
"createdAt": { "type": "number" },
329
"disabledAt": { "nullable": true, "type": "number" },
330
"frequency": {
331
"properties": {
332
"interval": { "type": "string", "enum": ["month"] },
333
"intervalCount": {
334
"type": "number",
335
"enum": [1, 3, 2, 6, 12]
336
}
337
},
338
"required": ["interval", "intervalCount"],
339
"type": "object"
340
},
341
"maxQuantity": { "type": "number" }
342
},
343
"required": ["price", "quantity", "hidden"],
344
"type": "object",
345
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
346
},
347
"enhancedConcurrentBuilds": {
348
"properties": {
349
"tier": { "type": "number" },
350
"price": { "type": "number" },
351
"quantity": { "type": "number" },
352
"highestQuantity": {
353
"type": "number",
354
"description": "The highest quantity in the current period. Used to render the correct enable/disable UI for add-ons."
355
},
356
"name": { "type": "string" },
357
"hidden": { "type": "boolean" },
358
"createdAt": { "type": "number" },
359
"disabledAt": { "nullable": true, "type": "number" },
360
"frequency": {
361
"properties": {
362
"interval": { "type": "string", "enum": ["month"] },
363
"intervalCount": {
364
"type": "number",
365
"enum": [1, 3, 2, 6, 12]
366
}
367
},
368
"required": ["interval", "intervalCount"],
369
"type": "object"
370
},
371
"maxQuantity": { "type": "number" }
372
},
373
"required": ["price", "quantity", "hidden"],
374
"type": "object",
375
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
376
},
377
"includedAllocationMiu": {
378
"properties": {
379
"tier": { "type": "number" },
380
"price": { "type": "number" },
381
"quantity": { "type": "number" },
382
"highestQuantity": {
383
"type": "number",
384
"description": "The highest quantity in the current period. Used to render the correct enable/disable UI for add-ons."
385
},
386
"name": { "type": "string" },
387
"hidden": { "type": "boolean" },
388
"createdAt": { "type": "number" },
389
"disabledAt": { "nullable": true, "type": "number" },
390
"frequency": {
391
"properties": {
392
"interval": { "type": "string", "enum": ["month"] },
393
"intervalCount": {
394
"type": "number",
395
"enum": [1, 3, 2, 6, 12]
396
}
397
},
398
"required": ["interval", "intervalCount"],
399
"type": "object"
400
},
401
"maxQuantity": { "type": "number" }
402
},
403
"required": ["price", "quantity", "hidden"],
404
"type": "object",
405
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
406
},
407
"managedInfrastructureCommitment": {
408
"properties": {
409
"tier": { "type": "number" },
410
"price": { "type": "number" },
411
"quantity": { "type": "number" },
412
"highestQuantity": {
413
"type": "number",
414
"description": "The highest quantity in the current period. Used to render the correct enable/disable UI for add-ons."
415
},
416
"name": { "type": "string" },
417
"hidden": { "type": "boolean" },
418
"createdAt": { "type": "number" },
419
"disabledAt": { "nullable": true, "type": "number" },
420
"frequency": {
421
"properties": {
422
"interval": { "type": "string", "enum": ["month"] },
423
"intervalCount": {
424
"type": "number",
425
"enum": [1, 3, 2, 6, 12]
426
}
427
},
428
"required": ["interval", "intervalCount"],
429
"type": "object"
430
},
431
"maxQuantity": { "type": "number" }
432
},
433
"required": ["price", "quantity", "hidden"],
434
"type": "object",
435
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
436
},
437
"monitoring": {
438
"properties": {
439
"tier": { "type": "number" },
440
"price": { "type": "number" },
441
"quantity": { "type": "number" },
442
"highestQuantity": {
443
"type": "number",
444
"description": "The highest quantity in the current period. Used to render the correct enable/disable UI for add-ons."
445
},
446
"name": { "type": "string" },
447
"hidden": { "type": "boolean" },
448
"createdAt": { "type": "number" },
449
"disabledAt": { "nullable": true, "type": "number" },
450
"frequency": {
451
"properties": {
452
"interval": { "type": "string", "enum": ["month"] },
453
"intervalCount": {
454
"type": "number",
455
"enum": [1, 3, 2, 6, 12]
456
}
457
},
458
"required": ["interval", "intervalCount"],
459
"type": "object"
460
},
461
"maxQuantity": { "type": "number" }
462
},
463
"required": ["price", "quantity", "hidden"],
464
"type": "object",
465
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
466
},
467
"passwordProtection": {
468
"properties": {
469
"tier": { "type": "number" },
470
"price": { "type": "number" },
471
"quantity": { "type": "number" },
472
"highestQuantity": {
473
"type": "number",
474
"description": "The highest quantity in the current period. Used to render the correct enable/disable UI for add-ons."
475
},
476
"name": { "type": "string" },
477
"hidden": { "type": "boolean" },
478
"createdAt": { "type": "number" },
479
"disabledAt": { "nullable": true, "type": "number" },
480
"frequency": {
481
"properties": {
482
"interval": { "type": "string", "enum": ["month"] },
483
"intervalCount": {
484
"type": "number",
485
"enum": [1, 3, 2, 6, 12]
486
}
487
},
488
"required": ["interval", "intervalCount"],
489
"type": "object"
490
},
491
"maxQuantity": { "type": "number" }
492
},
493
"required": ["price", "quantity", "hidden"],
494
"type": "object",
495
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
496
},
497
"previewDeploymentSuffix": {
498
"properties": {
499
"tier": { "type": "number" },
500
"price": { "type": "number" },
501
"quantity": { "type": "number" },
502
"highestQuantity": {
503
"type": "number",
504
"description": "The highest quantity in the current period. Used to render the correct enable/disable UI for add-ons."
505
},
506
"name": { "type": "string" },
507
"hidden": { "type": "boolean" },
508
"createdAt": { "type": "number" },
509
"disabledAt": { "nullable": true, "type": "number" },
510
"frequency": {
511
"properties": {
512
"interval": { "type": "string", "enum": ["month"] },
513
"intervalCount": {
514
"type": "number",
515
"enum": [1, 3, 2, 6, 12]
516
}
517
},
518
"required": ["interval", "intervalCount"],
519
"type": "object"
520
},
521
"maxQuantity": { "type": "number" }
522
},
523
"required": ["price", "quantity", "hidden"],
524
"type": "object",
525
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
526
},
527
"saml": {
528
"properties": {
529
"tier": { "type": "number" },
530
"price": { "type": "number" },
531
"quantity": { "type": "number" },
532
"highestQuantity": {
533
"type": "number",
534
"description": "The highest quantity in the current period. Used to render the correct enable/disable UI for add-ons."
535
},
536
"name": { "type": "string" },
537
"hidden": { "type": "boolean" },
538
"createdAt": { "type": "number" },
539
"disabledAt": { "nullable": true, "type": "number" },
540
"frequency": {
541
"properties": {
542
"interval": { "type": "string", "enum": ["month"] },
543
"intervalCount": {
544
"type": "number",
545
"enum": [1, 3, 2, 6, 12]
546
}
547
},
548
"required": ["interval", "intervalCount"],
549
"type": "object"
550
},
551
"maxQuantity": { "type": "number" }
552
},
553
"required": ["price", "quantity", "hidden"],
554
"type": "object",
555
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
556
},
557
"teamSeats": {
558
"properties": {
559
"tier": { "type": "number" },
560
"price": { "type": "number" },
561
"quantity": { "type": "number" },
562
"highestQuantity": {
563
"type": "number",
564
"description": "The highest quantity in the current period. Used to render the correct enable/disable UI for add-ons."
565
},
566
"name": { "type": "string" },
567
"hidden": { "type": "boolean" },
568
"createdAt": { "type": "number" },
569
"disabledAt": { "nullable": true, "type": "number" },
570
"frequency": {
571
"properties": {
572
"interval": { "type": "string", "enum": ["month"] },
573
"intervalCount": {
574
"type": "number",
575
"enum": [1, 3, 2, 6, 12]
576
}
577
},
578
"required": ["interval", "intervalCount"],
579
"type": "object"
580
},
581
"maxQuantity": { "type": "number" }
582
},
583
"required": ["price", "quantity", "hidden"],
584
"type": "object",
585
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
586
},
587
"v0TeamSeats": {
588
"properties": {
589
"tier": { "type": "number" },
590
"price": { "type": "number" },
591
"quantity": { "type": "number" },
592
"highestQuantity": {
593
"type": "number",
594
"description": "The highest quantity in the current period. Used to render the correct enable/disable UI for add-ons."
595
},
596
"name": { "type": "string" },
597
"hidden": { "type": "boolean" },
598
"createdAt": { "type": "number" },
599
"disabledAt": { "nullable": true, "type": "number" },
600
"frequency": {
601
"properties": {
602
"interval": { "type": "string", "enum": ["month"] },
603
"intervalCount": {
604
"type": "number",
605
"enum": [1, 3, 2, 6, 12]
606
}
607
},
608
"required": ["interval", "intervalCount"],
609
"type": "object"
610
},
611
"maxQuantity": { "type": "number" }
612
},
613
"required": ["price", "quantity", "hidden"],
614
"type": "object",
615
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
616
},
617
"vercelMarketplace": {
618
"properties": {
619
"tier": { "type": "number" },
620
"price": { "type": "number" },
621
"quantity": { "type": "number" },
622
"highestQuantity": {
623
"type": "number",
624
"description": "The highest quantity in the current period. Used to render the correct enable/disable UI for add-ons."
625
},
626
"name": { "type": "string" },
627
"hidden": { "type": "boolean" },
628
"createdAt": { "type": "number" },
629
"disabledAt": { "nullable": true, "type": "number" },
630
"frequency": {
631
"properties": {
632
"interval": { "type": "string", "enum": ["month"] },
633
"intervalCount": {
634
"type": "number",
635
"enum": [1, 3, 2, 6, 12]
636
}
637
},
638
"required": ["interval", "intervalCount"],
639
"type": "object"
640
},
641
"maxQuantity": { "type": "number" }
642
},
643
"required": ["price", "quantity", "hidden"],
644
"type": "object",
645
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
646
},
647
"analyticsUsage": {
648
"properties": {
649
"matrix": {
650
"properties": {
651
"defaultUnitPrice": { "type": "string" },
652
"dimensionPrices": {
653
"additionalProperties": { "type": "string" },
654
"type": "object"
655
}
656
},
657
"required": ["defaultUnitPrice", "dimensionPrices"],
658
"type": "object"
659
},
660
"tier": { "type": "number" },
661
"price": { "type": "number" },
662
"batch": { "type": "number" },
663
"threshold": { "type": "number" },
664
"name": { "type": "string" },
665
"hidden": { "type": "boolean" },
666
"disabledAt": { "nullable": true, "type": "number" },
667
"enabledAt": { "nullable": true, "type": "number" }
668
},
669
"required": ["price", "batch", "threshold", "hidden"],
670
"type": "object"
671
},
672
"artifacts": {
673
"properties": {
674
"matrix": {
675
"properties": {
676
"defaultUnitPrice": { "type": "string" },
677
"dimensionPrices": {
678
"additionalProperties": { "type": "string" },
679
"type": "object"
680
}
681
},
682
"required": ["defaultUnitPrice", "dimensionPrices"],
683
"type": "object"
684
},
685
"tier": { "type": "number" },
686
"price": { "type": "number" },
687
"batch": { "type": "number" },
688
"threshold": { "type": "number" },
689
"name": { "type": "string" },
690
"hidden": { "type": "boolean" },
691
"disabledAt": { "nullable": true, "type": "number" },
692
"enabledAt": { "nullable": true, "type": "number" }
693
},
694
"required": ["price", "batch", "threshold", "hidden"],
695
"type": "object"
696
},
697
"bandwidth": {
698
"properties": {
699
"matrix": {
700
"properties": {
701
"defaultUnitPrice": { "type": "string" },
702
"dimensionPrices": {
703
"additionalProperties": { "type": "string" },
704
"type": "object"
705
}
706
},
707
"required": ["defaultUnitPrice", "dimensionPrices"],
708
"type": "object"
709
},
710
"tier": { "type": "number" },
711
"price": { "type": "number" },
712
"batch": { "type": "number" },
713
"threshold": { "type": "number" },
714
"name": { "type": "string" },
715
"hidden": { "type": "boolean" },
716
"disabledAt": { "nullable": true, "type": "number" },
717
"enabledAt": { "nullable": true, "type": "number" }
718
},
719
"required": ["price", "batch", "threshold", "hidden"],
720
"type": "object"
721
},
722
"blobStores": {
723
"properties": {
724
"matrix": {
725
"properties": {
726
"defaultUnitPrice": { "type": "string" },
727
"dimensionPrices": {
728
"additionalProperties": { "type": "string" },
729
"type": "object"
730
}
731
},
732
"required": ["defaultUnitPrice", "dimensionPrices"],
733
"type": "object"
734
},
735
"tier": { "type": "number" },
736
"price": { "type": "number" },
737
"batch": { "type": "number" },
738
"threshold": { "type": "number" },
739
"name": { "type": "string" },
740
"hidden": { "type": "boolean" },
741
"disabledAt": { "nullable": true, "type": "number" },
742
"enabledAt": { "nullable": true, "type": "number" }
743
},
744
"required": ["price", "batch", "threshold", "hidden"],
745
"type": "object"
746
},
747
"blobTotalAdvancedRequests": {
748
"properties": {
749
"matrix": {
750
"properties": {
751
"defaultUnitPrice": { "type": "string" },
752
"dimensionPrices": {
753
"additionalProperties": { "type": "string" },
754
"type": "object"
755
}
756
},
757
"required": ["defaultUnitPrice", "dimensionPrices"],
758
"type": "object"
759
},
760
"tier": { "type": "number" },
761
"price": { "type": "number" },
762
"batch": { "type": "number" },
763
"threshold": { "type": "number" },
764
"name": { "type": "string" },
765
"hidden": { "type": "boolean" },
766
"disabledAt": { "nullable": true, "type": "number" },
767
"enabledAt": { "nullable": true, "type": "number" }
768
},
769
"required": ["price", "batch", "threshold", "hidden"],
770
"type": "object"
771
},
772
"blobTotalAvgSizeInBytes": {
773
"properties": {
774
"matrix": {
775
"properties": {
776
"defaultUnitPrice": { "type": "string" },
777
"dimensionPrices": {
778
"additionalProperties": { "type": "string" },
779
"type": "object"
780
}
781
},
782
"required": ["defaultUnitPrice", "dimensionPrices"],
783
"type": "object"
784
},
785
"tier": { "type": "number" },
786
"price": { "type": "number" },
787
"batch": { "type": "number" },
788
"threshold": { "type": "number" },
789
"name": { "type": "string" },
790
"hidden": { "type": "boolean" },
791
"disabledAt": { "nullable": true, "type": "number" },
792
"enabledAt": { "nullable": true, "type": "number" }
793
},
794
"required": ["price", "batch", "threshold", "hidden"],
795
"type": "object"
796
},
797
"blobTotalGetResponseObjectSizeInBytes": {
798
"properties": {
799
"matrix": {
800
"properties": {
801
"defaultUnitPrice": { "type": "string" },
802
"dimensionPrices": {
803
"additionalProperties": { "type": "string" },
804
"type": "object"
805
}
806
},
807
"required": ["defaultUnitPrice", "dimensionPrices"],
808
"type": "object"
809
},
810
"tier": { "type": "number" },
811
"price": { "type": "number" },
812
"batch": { "type": "number" },
813
"threshold": { "type": "number" },
814
"name": { "type": "string" },
815
"hidden": { "type": "boolean" },
816
"disabledAt": { "nullable": true, "type": "number" },
817
"enabledAt": { "nullable": true, "type": "number" }
818
},
819
"required": ["price", "batch", "threshold", "hidden"],
820
"type": "object"
821
},
822
"blobTotalSimpleRequests": {
823
"properties": {
824
"matrix": {
825
"properties": {
826
"defaultUnitPrice": { "type": "string" },
827
"dimensionPrices": {
828
"additionalProperties": { "type": "string" },
829
"type": "object"
830
}
831
},
832
"required": ["defaultUnitPrice", "dimensionPrices"],
833
"type": "object"
834
},
835
"tier": { "type": "number" },
836
"price": { "type": "number" },
837
"batch": { "type": "number" },
838
"threshold": { "type": "number" },
839
"name": { "type": "string" },
840
"hidden": { "type": "boolean" },
841
"disabledAt": { "nullable": true, "type": "number" },
842
"enabledAt": { "nullable": true, "type": "number" }
843
},
844
"required": ["price", "batch", "threshold", "hidden"],
845
"type": "object"
846
},
847
"buildMinute": {
848
"properties": {
849
"matrix": {
850
"properties": {
851
"defaultUnitPrice": { "type": "string" },
852
"dimensionPrices": {
853
"additionalProperties": { "type": "string" },
854
"type": "object"
855
}
856
},
857
"required": ["defaultUnitPrice", "dimensionPrices"],
858
"type": "object"
859
},
860
"tier": { "type": "number" },
861
"price": { "type": "number" },
862
"batch": { "type": "number" },
863
"threshold": { "type": "number" },
864
"name": { "type": "string" },
865
"hidden": { "type": "boolean" },
866
"disabledAt": { "nullable": true, "type": "number" },
867
"enabledAt": { "nullable": true, "type": "number" }
868
},
869
"required": ["price", "batch", "threshold", "hidden"],
870
"type": "object"
871
},
872
"dataCacheRead": {
873
"properties": {
874
"matrix": {
875
"properties": {
876
"defaultUnitPrice": { "type": "string" },
877
"dimensionPrices": {
878
"additionalProperties": { "type": "string" },
879
"type": "object"
880
}
881
},
882
"required": ["defaultUnitPrice", "dimensionPrices"],
883
"type": "object"
884
},
885
"tier": { "type": "number" },
886
"price": { "type": "number" },
887
"batch": { "type": "number" },
888
"threshold": { "type": "number" },
889
"name": { "type": "string" },
890
"hidden": { "type": "boolean" },
891
"disabledAt": { "nullable": true, "type": "number" },
892
"enabledAt": { "nullable": true, "type": "number" }
893
},
894
"required": ["price", "batch", "threshold", "hidden"],
895
"type": "object"
896
},
897
"dataCacheRevalidation": {
898
"properties": {
899
"matrix": {
900
"properties": {
901
"defaultUnitPrice": { "type": "string" },
902
"dimensionPrices": {
903
"additionalProperties": { "type": "string" },
904
"type": "object"
905
}
906
},
907
"required": ["defaultUnitPrice", "dimensionPrices"],
908
"type": "object"
909
},
910
"tier": { "type": "number" },
911
"price": { "type": "number" },
912
"batch": { "type": "number" },
913
"threshold": { "type": "number" },
914
"name": { "type": "string" },
915
"hidden": { "type": "boolean" },
916
"disabledAt": { "nullable": true, "type": "number" },
917
"enabledAt": { "nullable": true, "type": "number" }
918
},
919
"required": ["price", "batch", "threshold", "hidden"],
920
"type": "object"
921
},
922
"dataCacheWrite": {
923
"properties": {
924
"matrix": {
925
"properties": {
926
"defaultUnitPrice": { "type": "string" },
927
"dimensionPrices": {
928
"additionalProperties": { "type": "string" },
929
"type": "object"
930
}
931
},
932
"required": ["defaultUnitPrice", "dimensionPrices"],
933
"type": "object"
934
},
935
"tier": { "type": "number" },
936
"price": { "type": "number" },
937
"batch": { "type": "number" },
938
"threshold": { "type": "number" },
939
"name": { "type": "string" },
940
"hidden": { "type": "boolean" },
941
"disabledAt": { "nullable": true, "type": "number" },
942
"enabledAt": { "nullable": true, "type": "number" }
943
},
944
"required": ["price", "batch", "threshold", "hidden"],
945
"type": "object"
946
},
947
"edgeConfigRead": {
948
"properties": {
949
"matrix": {
950
"properties": {
951
"defaultUnitPrice": { "type": "string" },
952
"dimensionPrices": {
953
"additionalProperties": { "type": "string" },
954
"type": "object"
955
}
956
},
957
"required": ["defaultUnitPrice", "dimensionPrices"],
958
"type": "object"
959
},
960
"tier": { "type": "number" },
961
"price": { "type": "number" },
962
"batch": { "type": "number" },
963
"threshold": { "type": "number" },
964
"name": { "type": "string" },
965
"hidden": { "type": "boolean" },
966
"disabledAt": { "nullable": true, "type": "number" },
967
"enabledAt": { "nullable": true, "type": "number" }
968
},
969
"required": ["price", "batch", "threshold", "hidden"],
970
"type": "object"
971
},
972
"edgeConfigWrite": {
973
"properties": {
974
"matrix": {
975
"properties": {
976
"defaultUnitPrice": { "type": "string" },
977
"dimensionPrices": {
978
"additionalProperties": { "type": "string" },
979
"type": "object"
980
}
981
},
982
"required": ["defaultUnitPrice", "dimensionPrices"],
983
"type": "object"
984
},
985
"tier": { "type": "number" },
986
"price": { "type": "number" },
987
"batch": { "type": "number" },
988
"threshold": { "type": "number" },
989
"name": { "type": "string" },
990
"hidden": { "type": "boolean" },
991
"disabledAt": { "nullable": true, "type": "number" },
992
"enabledAt": { "nullable": true, "type": "number" }
993
},
994
"required": ["price", "batch", "threshold", "hidden"],
995
"type": "object"
996
},
997
"edgeFunctionExecutionUnits": {
998
"properties": {
999
"matrix": {
1000
"properties": {
1001
"defaultUnitPrice": { "type": "string" },
1002
"dimensionPrices": {
1003
"additionalProperties": { "type": "string" },
1004
"type": "object"
1005
}
1006
},
1007
"required": ["defaultUnitPrice", "dimensionPrices"],
1008
"type": "object"
1009
},
1010
"tier": { "type": "number" },
1011
"price": { "type": "number" },
1012
"batch": { "type": "number" },
1013
"threshold": { "type": "number" },
1014
"name": { "type": "string" },
1015
"hidden": { "type": "boolean" },
1016
"disabledAt": { "nullable": true, "type": "number" },
1017
"enabledAt": { "nullable": true, "type": "number" }
1018
},
1019
"required": ["price", "batch", "threshold", "hidden"],
1020
"type": "object"
1021
},
1022
"edgeMiddlewareInvocations": {
1023
"properties": {
1024
"matrix": {
1025
"properties": {
1026
"defaultUnitPrice": { "type": "string" },
1027
"dimensionPrices": {
1028
"additionalProperties": { "type": "string" },
1029
"type": "object"
1030
}
1031
},
1032
"required": ["defaultUnitPrice", "dimensionPrices"],
1033
"type": "object"
1034
},
1035
"tier": { "type": "number" },
1036
"price": { "type": "number" },
1037
"batch": { "type": "number" },
1038
"threshold": { "type": "number" },
1039
"name": { "type": "string" },
1040
"hidden": { "type": "boolean" },
1041
"disabledAt": { "nullable": true, "type": "number" },
1042
"enabledAt": { "nullable": true, "type": "number" }
1043
},
1044
"required": ["price", "batch", "threshold", "hidden"],
1045
"type": "object"
1046
},
1047
"edgeRequest": {
1048
"properties": {
1049
"matrix": {
1050
"properties": {
1051
"defaultUnitPrice": { "type": "string" },
1052
"dimensionPrices": {
1053
"additionalProperties": { "type": "string" },
1054
"type": "object"
1055
}
1056
},
1057
"required": ["defaultUnitPrice", "dimensionPrices"],
1058
"type": "object"
1059
},
1060
"tier": { "type": "number" },
1061
"price": { "type": "number" },
1062
"batch": { "type": "number" },
1063
"threshold": { "type": "number" },
1064
"name": { "type": "string" },
1065
"hidden": { "type": "boolean" },
1066
"disabledAt": { "nullable": true, "type": "number" },
1067
"enabledAt": { "nullable": true, "type": "number" }
1068
},
1069
"required": ["price", "batch", "threshold", "hidden"],
1070
"type": "object"
1071
},
1072
"edgeRequestAdditionalCpuDuration": {
1073
"properties": {
1074
"matrix": {
1075
"properties": {
1076
"defaultUnitPrice": { "type": "string" },
1077
"dimensionPrices": {
1078
"additionalProperties": { "type": "string" },
1079
"type": "object"
1080
}
1081
},
1082
"required": ["defaultUnitPrice", "dimensionPrices"],
1083
"type": "object"
1084
},
1085
"tier": { "type": "number" },
1086
"price": { "type": "number" },
1087
"batch": { "type": "number" },
1088
"threshold": { "type": "number" },
1089
"name": { "type": "string" },
1090
"hidden": { "type": "boolean" },
1091
"disabledAt": { "nullable": true, "type": "number" },
1092
"enabledAt": { "nullable": true, "type": "number" }
1093
},
1094
"required": ["price", "batch", "threshold", "hidden"],
1095
"type": "object"
1096
},
1097
"fastDataTransfer": {
1098
"properties": {
1099
"matrix": {
1100
"properties": {
1101
"defaultUnitPrice": { "type": "string" },
1102
"dimensionPrices": {
1103
"additionalProperties": { "type": "string" },
1104
"type": "object"
1105
}
1106
},
1107
"required": ["defaultUnitPrice", "dimensionPrices"],
1108
"type": "object"
1109
},
1110
"tier": { "type": "number" },
1111
"price": { "type": "number" },
1112
"batch": { "type": "number" },
1113
"threshold": { "type": "number" },
1114
"name": { "type": "string" },
1115
"hidden": { "type": "boolean" },
1116
"disabledAt": { "nullable": true, "type": "number" },
1117
"enabledAt": { "nullable": true, "type": "number" }
1118
},
1119
"required": ["price", "batch", "threshold", "hidden"],
1120
"type": "object"
1121
},
1122
"fastOriginTransfer": {
1123
"properties": {
1124
"matrix": {
1125
"properties": {
1126
"defaultUnitPrice": { "type": "string" },
1127
"dimensionPrices": {
1128
"additionalProperties": { "type": "string" },
1129
"type": "object"
1130
}
1131
},
1132
"required": ["defaultUnitPrice", "dimensionPrices"],
1133
"type": "object"
1134
},
1135
"tier": { "type": "number" },
1136
"price": { "type": "number" },
1137
"batch": { "type": "number" },
1138
"threshold": { "type": "number" },
1139
"name": { "type": "string" },
1140
"hidden": { "type": "boolean" },
1141
"disabledAt": { "nullable": true, "type": "number" },
1142
"enabledAt": { "nullable": true, "type": "number" }
1143
},
1144
"required": ["price", "batch", "threshold", "hidden"],
1145
"type": "object"
1146
},
1147
"functionDuration": {
1148
"properties": {
1149
"matrix": {
1150
"properties": {
1151
"defaultUnitPrice": { "type": "string" },
1152
"dimensionPrices": {
1153
"additionalProperties": { "type": "string" },
1154
"type": "object"
1155
}
1156
},
1157
"required": ["defaultUnitPrice", "dimensionPrices"],
1158
"type": "object"
1159
},
1160
"tier": { "type": "number" },
1161
"price": { "type": "number" },
1162
"batch": { "type": "number" },
1163
"threshold": { "type": "number" },
1164
"name": { "type": "string" },
1165
"hidden": { "type": "boolean" },
1166
"disabledAt": { "nullable": true, "type": "number" },
1167
"enabledAt": { "nullable": true, "type": "number" }
1168
},
1169
"required": ["price", "batch", "threshold", "hidden"],
1170
"type": "object"
1171
},
1172
"functionInvocation": {
1173
"properties": {
1174
"matrix": {
1175
"properties": {
1176
"defaultUnitPrice": { "type": "string" },
1177
"dimensionPrices": {
1178
"additionalProperties": { "type": "string" },
1179
"type": "object"
1180
}
1181
},
1182
"required": ["defaultUnitPrice", "dimensionPrices"],
1183
"type": "object"
1184
},
1185
"tier": { "type": "number" },
1186
"price": { "type": "number" },
1187
"batch": { "type": "number" },
1188
"threshold": { "type": "number" },
1189
"name": { "type": "string" },
1190
"hidden": { "type": "boolean" },
1191
"disabledAt": { "nullable": true, "type": "number" },
1192
"enabledAt": { "nullable": true, "type": "number" }
1193
},
1194
"required": ["price", "batch", "threshold", "hidden"],
1195
"type": "object"
1196
},
1197
"logDrainsVolume": {
1198
"properties": {
1199
"matrix": {
1200
"properties": {
1201
"defaultUnitPrice": { "type": "string" },
1202
"dimensionPrices": {
1203
"additionalProperties": { "type": "string" },
1204
"type": "object"
1205
}
1206
},
1207
"required": ["defaultUnitPrice", "dimensionPrices"],
1208
"type": "object"
1209
},
1210
"tier": { "type": "number" },
1211
"price": { "type": "number" },
1212
"batch": { "type": "number" },
1213
"threshold": { "type": "number" },
1214
"name": { "type": "string" },
1215
"hidden": { "type": "boolean" },
1216
"disabledAt": { "nullable": true, "type": "number" },
1217
"enabledAt": { "nullable": true, "type": "number" }
1218
},
1219
"required": ["price", "batch", "threshold", "hidden"],
1220
"type": "object"
1221
},
1222
"monitoringMetric": {
1223
"properties": {
1224
"matrix": {
1225
"properties": {
1226
"defaultUnitPrice": { "type": "string" },
1227
"dimensionPrices": {
1228
"additionalProperties": { "type": "string" },
1229
"type": "object"
1230
}
1231
},
1232
"required": ["defaultUnitPrice", "dimensionPrices"],
1233
"type": "object"
1234
},
1235
"tier": { "type": "number" },
1236
"price": { "type": "number" },
1237
"batch": { "type": "number" },
1238
"threshold": { "type": "number" },
1239
"name": { "type": "string" },
1240
"hidden": { "type": "boolean" },
1241
"disabledAt": { "nullable": true, "type": "number" },
1242
"enabledAt": { "nullable": true, "type": "number" }
1243
},
1244
"required": ["price", "batch", "threshold", "hidden"],
1245
"type": "object"
1246
},
1247
"postgresComputeTime": {
1248
"properties": {
1249
"matrix": {
1250
"properties": {
1251
"defaultUnitPrice": { "type": "string" },
1252
"dimensionPrices": {
1253
"additionalProperties": { "type": "string" },
1254
"type": "object"
1255
}
1256
},
1257
"required": ["defaultUnitPrice", "dimensionPrices"],
1258
"type": "object"
1259
},
1260
"tier": { "type": "number" },
1261
"price": { "type": "number" },
1262
"batch": { "type": "number" },
1263
"threshold": { "type": "number" },
1264
"name": { "type": "string" },
1265
"hidden": { "type": "boolean" },
1266
"disabledAt": { "nullable": true, "type": "number" },
1267
"enabledAt": { "nullable": true, "type": "number" }
1268
},
1269
"required": ["price", "batch", "threshold", "hidden"],
1270
"type": "object"
1271
},
1272
"postgresDataStorage": {
1273
"properties": {
1274
"matrix": {
1275
"properties": {
1276
"defaultUnitPrice": { "type": "string" },
1277
"dimensionPrices": {
1278
"additionalProperties": { "type": "string" },
1279
"type": "object"
1280
}
1281
},
1282
"required": ["defaultUnitPrice", "dimensionPrices"],
1283
"type": "object"
1284
},
1285
"tier": { "type": "number" },
1286
"price": { "type": "number" },
1287
"batch": { "type": "number" },
1288
"threshold": { "type": "number" },
1289
"name": { "type": "string" },
1290
"hidden": { "type": "boolean" },
1291
"disabledAt": { "nullable": true, "type": "number" },
1292
"enabledAt": { "nullable": true, "type": "number" }
1293
},
1294
"required": ["price", "batch", "threshold", "hidden"],
1295
"type": "object"
1296
},
1297
"postgresDataTransfer": {
1298
"properties": {
1299
"matrix": {
1300
"properties": {
1301
"defaultUnitPrice": { "type": "string" },
1302
"dimensionPrices": {
1303
"additionalProperties": { "type": "string" },
1304
"type": "object"
1305
}
1306
},
1307
"required": ["defaultUnitPrice", "dimensionPrices"],
1308
"type": "object"
1309
},
1310
"tier": { "type": "number" },
1311
"price": { "type": "number" },
1312
"batch": { "type": "number" },
1313
"threshold": { "type": "number" },
1314
"name": { "type": "string" },
1315
"hidden": { "type": "boolean" },
1316
"disabledAt": { "nullable": true, "type": "number" },
1317
"enabledAt": { "nullable": true, "type": "number" }
1318
},
1319
"required": ["price", "batch", "threshold", "hidden"],
1320
"type": "object"
1321
},
1322
"postgresDatabase": {
1323
"properties": {
1324
"matrix": {
1325
"properties": {
1326
"defaultUnitPrice": { "type": "string" },
1327
"dimensionPrices": {
1328
"additionalProperties": { "type": "string" },
1329
"type": "object"
1330
}
1331
},
1332
"required": ["defaultUnitPrice", "dimensionPrices"],
1333
"type": "object"
1334
},
1335
"tier": { "type": "number" },
1336
"price": { "type": "number" },
1337
"batch": { "type": "number" },
1338
"threshold": { "type": "number" },
1339
"name": { "type": "string" },
1340
"hidden": { "type": "boolean" },
1341
"disabledAt": { "nullable": true, "type": "number" },
1342
"enabledAt": { "nullable": true, "type": "number" }
1343
},
1344
"required": ["price", "batch", "threshold", "hidden"],
1345
"type": "object"
1346
},
1347
"postgresWrittenData": {
1348
"properties": {
1349
"matrix": {
1350
"properties": {
1351
"defaultUnitPrice": { "type": "string" },
1352
"dimensionPrices": {
1353
"additionalProperties": { "type": "string" },
1354
"type": "object"
1355
}
1356
},
1357
"required": ["defaultUnitPrice", "dimensionPrices"],
1358
"type": "object"
1359
},
1360
"tier": { "type": "number" },
1361
"price": { "type": "number" },
1362
"batch": { "type": "number" },
1363
"threshold": { "type": "number" },
1364
"name": { "type": "string" },
1365
"hidden": { "type": "boolean" },
1366
"disabledAt": { "nullable": true, "type": "number" },
1367
"enabledAt": { "nullable": true, "type": "number" }
1368
},
1369
"required": ["price", "batch", "threshold", "hidden"],
1370
"type": "object"
1371
},
1372
"serverlessFunctionExecution": {
1373
"properties": {
1374
"matrix": {
1375
"properties": {
1376
"defaultUnitPrice": { "type": "string" },
1377
"dimensionPrices": {
1378
"additionalProperties": { "type": "string" },
1379
"type": "object"
1380
}
1381
},
1382
"required": ["defaultUnitPrice", "dimensionPrices"],
1383
"type": "object"
1384
},
1385
"tier": { "type": "number" },
1386
"price": { "type": "number" },
1387
"batch": { "type": "number" },
1388
"threshold": { "type": "number" },
1389
"name": { "type": "string" },
1390
"hidden": { "type": "boolean" },
1391
"disabledAt": { "nullable": true, "type": "number" },
1392
"enabledAt": { "nullable": true, "type": "number" }
1393
},
1394
"required": ["price", "batch", "threshold", "hidden"],
1395
"type": "object"
1396
},
1397
"sourceImages": {
1398
"properties": {
1399
"matrix": {
1400
"properties": {
1401
"defaultUnitPrice": { "type": "string" },
1402
"dimensionPrices": {
1403
"additionalProperties": { "type": "string" },
1404
"type": "object"
1405
}
1406
},
1407
"required": ["defaultUnitPrice", "dimensionPrices"],
1408
"type": "object"
1409
},
1410
"tier": { "type": "number" },
1411
"price": { "type": "number" },
1412
"batch": { "type": "number" },
1413
"threshold": { "type": "number" },
1414
"name": { "type": "string" },
1415
"hidden": { "type": "boolean" },
1416
"disabledAt": { "nullable": true, "type": "number" },
1417
"enabledAt": { "nullable": true, "type": "number" }
1418
},
1419
"required": ["price", "batch", "threshold", "hidden"],
1420
"type": "object"
1421
},
1422
"storageRedisTotalBandwidthInBytes": {
1423
"properties": {
1424
"matrix": {
1425
"properties": {
1426
"defaultUnitPrice": { "type": "string" },
1427
"dimensionPrices": {
1428
"additionalProperties": { "type": "string" },
1429
"type": "object"
1430
}
1431
},
1432
"required": ["defaultUnitPrice", "dimensionPrices"],
1433
"type": "object"
1434
},
1435
"tier": { "type": "number" },
1436
"price": { "type": "number" },
1437
"batch": { "type": "number" },
1438
"threshold": { "type": "number" },
1439
"name": { "type": "string" },
1440
"hidden": { "type": "boolean" },
1441
"disabledAt": { "nullable": true, "type": "number" },
1442
"enabledAt": { "nullable": true, "type": "number" }
1443
},
1444
"required": ["price", "batch", "threshold", "hidden"],
1445
"type": "object"
1446
},
1447
"storageRedisTotalCommands": {
1448
"properties": {
1449
"matrix": {
1450
"properties": {
1451
"defaultUnitPrice": { "type": "string" },
1452
"dimensionPrices": {
1453
"additionalProperties": { "type": "string" },
1454
"type": "object"
1455
}
1456
},
1457
"required": ["defaultUnitPrice", "dimensionPrices"],
1458
"type": "object"
1459
},
1460
"tier": { "type": "number" },
1461
"price": { "type": "number" },
1462
"batch": { "type": "number" },
1463
"threshold": { "type": "number" },
1464
"name": { "type": "string" },
1465
"hidden": { "type": "boolean" },
1466
"disabledAt": { "nullable": true, "type": "number" },
1467
"enabledAt": { "nullable": true, "type": "number" }
1468
},
1469
"required": ["price", "batch", "threshold", "hidden"],
1470
"type": "object"
1471
},
1472
"storageRedisTotalDailyAvgStorageInBytes": {
1473
"properties": {
1474
"matrix": {
1475
"properties": {
1476
"defaultUnitPrice": { "type": "string" },
1477
"dimensionPrices": {
1478
"additionalProperties": { "type": "string" },
1479
"type": "object"
1480
}
1481
},
1482
"required": ["defaultUnitPrice", "dimensionPrices"],
1483
"type": "object"
1484
},
1485
"tier": { "type": "number" },
1486
"price": { "type": "number" },
1487
"batch": { "type": "number" },
1488
"threshold": { "type": "number" },
1489
"name": { "type": "string" },
1490
"hidden": { "type": "boolean" },
1491
"disabledAt": { "nullable": true, "type": "number" },
1492
"enabledAt": { "nullable": true, "type": "number" }
1493
},
1494
"required": ["price", "batch", "threshold", "hidden"],
1495
"type": "object"
1496
},
1497
"storageRedisTotalDatabases": {
1498
"properties": {
1499
"matrix": {
1500
"properties": {
1501
"defaultUnitPrice": { "type": "string" },
1502
"dimensionPrices": {
1503
"additionalProperties": { "type": "string" },
1504
"type": "object"
1505
}
1506
},
1507
"required": ["defaultUnitPrice", "dimensionPrices"],
1508
"type": "object"
1509
},
1510
"tier": { "type": "number" },
1511
"price": { "type": "number" },
1512
"batch": { "type": "number" },
1513
"threshold": { "type": "number" },
1514
"name": { "type": "string" },
1515
"hidden": { "type": "boolean" },
1516
"disabledAt": { "nullable": true, "type": "number" },
1517
"enabledAt": { "nullable": true, "type": "number" }
1518
},
1519
"required": ["price", "batch", "threshold", "hidden"],
1520
"type": "object"
1521
},
1522
"wafOwaspExcessBytes": {
1523
"properties": {
1524
"matrix": {
1525
"properties": {
1526
"defaultUnitPrice": { "type": "string" },
1527
"dimensionPrices": {
1528
"additionalProperties": { "type": "string" },
1529
"type": "object"
1530
}
1531
},
1532
"required": ["defaultUnitPrice", "dimensionPrices"],
1533
"type": "object"
1534
},
1535
"tier": { "type": "number" },
1536
"price": { "type": "number" },
1537
"batch": { "type": "number" },
1538
"threshold": { "type": "number" },
1539
"name": { "type": "string" },
1540
"hidden": { "type": "boolean" },
1541
"disabledAt": { "nullable": true, "type": "number" },
1542
"enabledAt": { "nullable": true, "type": "number" }
1543
},
1544
"required": ["price", "batch", "threshold", "hidden"],
1545
"type": "object"
1546
},
1547
"wafOwaspRequests": {
1548
"properties": {
1549
"matrix": {
1550
"properties": {
1551
"defaultUnitPrice": { "type": "string" },
1552
"dimensionPrices": {
1553
"additionalProperties": { "type": "string" },
1554
"type": "object"
1555
}
1556
},
1557
"required": ["defaultUnitPrice", "dimensionPrices"],
1558
"type": "object"
1559
},
1560
"tier": { "type": "number" },
1561
"price": { "type": "number" },
1562
"batch": { "type": "number" },
1563
"threshold": { "type": "number" },
1564
"name": { "type": "string" },
1565
"hidden": { "type": "boolean" },
1566
"disabledAt": { "nullable": true, "type": "number" },
1567
"enabledAt": { "nullable": true, "type": "number" }
1568
},
1569
"required": ["price", "batch", "threshold", "hidden"],
1570
"type": "object"
1571
},
1572
"wafRateLimitRequest": {
1573
"properties": {
1574
"matrix": {
1575
"properties": {
1576
"defaultUnitPrice": { "type": "string" },
1577
"dimensionPrices": {
1578
"additionalProperties": { "type": "string" },
1579
"type": "object"
1580
}
1581
},
1582
"required": ["defaultUnitPrice", "dimensionPrices"],
1583
"type": "object"
1584
},
1585
"tier": { "type": "number" },
1586
"price": { "type": "number" },
1587
"batch": { "type": "number" },
1588
"threshold": { "type": "number" },
1589
"name": { "type": "string" },
1590
"hidden": { "type": "boolean" },
1591
"disabledAt": { "nullable": true, "type": "number" },
1592
"enabledAt": { "nullable": true, "type": "number" }
1593
},
1594
"required": ["price", "batch", "threshold", "hidden"],
1595
"type": "object"
1596
},
1597
"webAnalyticsEvent": {
1598
"properties": {
1599
"matrix": {
1600
"properties": {
1601
"defaultUnitPrice": { "type": "string" },
1602
"dimensionPrices": {
1603
"additionalProperties": { "type": "string" },
1604
"type": "object"
1605
}
1606
},
1607
"required": ["defaultUnitPrice", "dimensionPrices"],
1608
"type": "object"
1609
},
1610
"tier": { "type": "number" },
1611
"price": { "type": "number" },
1612
"batch": { "type": "number" },
1613
"threshold": { "type": "number" },
1614
"name": { "type": "string" },
1615
"hidden": { "type": "boolean" },
1616
"disabledAt": { "nullable": true, "type": "number" },
1617
"enabledAt": { "nullable": true, "type": "number" }
1618
},
1619
"required": ["price", "batch", "threshold", "hidden"],
1620
"type": "object"
1621
}
1622
},
1623
"type": "object"
1624
},
1625
"invoiceSettings": {
1626
"properties": { "footer": { "type": "string" } },
1627
"type": "object"
1628
},
1629
"subscriptions": {
1630
"nullable": true,
1631
"items": {
1632
"properties": {
1633
"id": { "type": "string" },
1634
"trial": {
1635
"nullable": true,
1636
"properties": {
1637
"start": { "type": "number" },
1638
"end": { "type": "number" }
1639
},
1640
"required": ["start", "end"],
1641
"type": "object"
1642
},
1643
"period": {
1644
"properties": {
1645
"start": { "type": "number" },
1646
"end": { "type": "number" }
1647
},
1648
"required": ["start", "end"],
1649
"type": "object"
1650
},
1651
"frequency": {
1652
"properties": {
1653
"interval": {
1654
"type": "string",
1655
"enum": ["month", "day", "week", "year"]
1656
},
1657
"intervalCount": { "type": "number" }
1658
},
1659
"required": ["interval", "intervalCount"],
1660
"type": "object"
1661
},
1662
"discount": {
1663
"nullable": true,
1664
"properties": {
1665
"id": { "type": "string" },
1666
"coupon": {
1667
"properties": {
1668
"id": { "type": "string" },
1669
"name": { "nullable": true, "type": "string" },
1670
"amountOff": { "nullable": true, "type": "number" },
1671
"percentageOff": { "nullable": true, "type": "number" },
1672
"durationInMonths": {
1673
"nullable": true,
1674
"type": "number"
1675
},
1676
"duration": {
1677
"type": "string",
1678
"enum": ["forever", "repeating", "once"]
1679
}
1680
},
1681
"required": [
1682
"id",
1683
"name",
1684
"amountOff",
1685
"percentageOff",
1686
"durationInMonths",
1687
"duration"
1688
],
1689
"type": "object"
1690
}
1691
},
1692
"required": ["id", "coupon"],
1693
"type": "object"
1694
},
1695
"items": {
1696
"items": {
1697
"properties": {
1698
"id": { "type": "string" },
1699
"priceId": { "type": "string" },
1700
"productId": { "type": "string" },
1701
"amount": { "type": "number" },
1702
"quantity": { "type": "number" }
1703
},
1704
"required": [
1705
"id",
1706
"priceId",
1707
"productId",
1708
"amount",
1709
"quantity"
1710
],
1711
"type": "object"
1712
},
1713
"type": "array"
1714
}
1715
},
1716
"required": [
1717
"id",
1718
"trial",
1719
"period",
1720
"frequency",
1721
"discount",
1722
"items"
1723
],
1724
"type": "object"
1725
},
1726
"type": "array"
1727
},
1728
"controls": {
1729
"nullable": true,
1730
"properties": {
1731
"analyticsSampleRateInPercent": {
1732
"nullable": true,
1733
"type": "number"
1734
},
1735
"analyticsSpendLimitInDollars": {
1736
"nullable": true,
1737
"type": "number"
1738
}
1739
},
1740
"type": "object"
1741
},
1742
"purchaseOrder": { "nullable": true, "type": "string" },
1743
"status": {
1744
"type": "string",
1745
"enum": ["active", "trialing", "overdue", "expired", "canceled"]
1746
},
1747
"pricingExperiment": { "type": "string", "enum": ["august-2022"] },
1748
"orbMigrationScheduledAt": { "nullable": true, "type": "number" },
1749
"forceOrbMigration": { "nullable": true, "type": "boolean" },
1750
"awsMarketplace": {
1751
"nullable": true,
1752
"properties": {
1753
"productCode": { "type": "string" },
1754
"offerId": { "type": "string" },
1755
"customerId": { "type": "string" }
1756
},
1757
"required": ["productCode", "customerId"],
1758
"type": "object"
1759
},
1760
"reseller": { "type": "string" },
1761
"hobbyBlockThresholdModifier": {
1762
"items": {
1763
"properties": {
1764
"source": { "type": "string", "enum": ["admin", "self-service"] },
1765
"startsAt": { "type": "number" },
1766
"expiresAt": { "type": "number" },
1767
"multiplier": { "type": "number" }
1768
},
1769
"required": ["source", "startsAt", "expiresAt", "multiplier"],
1770
"type": "object",
1771
"description": "Modifies block thresholds for this entity. A `multiplier` of 1 leads to no change in behavior. A `multiplier` of 1.25 would increase the block threshold by 25%. Only applies until `timestamp`. Do _not_ delete this property, ever. It indicates a user has self-unblocked and cannot do so again. Only the most recent entry applies, regardless of the `startsAt` and `expiresAt` timestamps of prior entries. Prior entries are kept for historical purposes only. This is modeled as a stack, where the most recent is the first (0th) entry."
1772
},
1773
"type": "array",
1774
"description": "Modifies block thresholds for this entity. A `multiplier` of 1 leads to no change in behavior. A `multiplier` of 1.25 would increase the block threshold by 25%. Only applies until `timestamp`. Do _not_ delete this property, ever. It indicates a user has self-unblocked and cannot do so again. Only the most recent entry applies, regardless of the `startsAt` and `expiresAt` timestamps of prior entries. Prior entries are kept for historical purposes only. This is modeled as a stack, where the most recent is the first (0th) entry."
1775
}
1776
},
1777
"required": ["period", "plan"],
1778
"type": "object",
1779
"description": "An object containing billing infomation associated with the User account."
1780
},
1781
"resourceConfig": {
1782
"properties": {
1783
"blobStores": {
1784
"type": "number",
1785
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1786
},
1787
"nodeType": {
1788
"type": "string",
1789
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1790
},
1791
"concurrentBuilds": {
1792
"type": "number",
1793
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1794
},
1795
"awsAccountType": {
1796
"type": "string",
1797
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1798
},
1799
"awsAccountIds": {
1800
"items": { "type": "string" },
1801
"type": "array",
1802
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1803
},
1804
"cfZoneName": {
1805
"type": "string",
1806
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1807
},
1808
"imageOptimizationType": {
1809
"type": "string",
1810
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1811
},
1812
"edgeConfigs": {
1813
"type": "number",
1814
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1815
},
1816
"edgeConfigSize": {
1817
"type": "number",
1818
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1819
},
1820
"edgeFunctionMaxSizeBytes": {
1821
"type": "number",
1822
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1823
},
1824
"edgeFunctionExecutionTimeoutMs": {
1825
"type": "number",
1826
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1827
},
1828
"serverlessFunctionDefaultMaxExecutionTime": {
1829
"type": "number",
1830
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1831
},
1832
"kvDatabases": {
1833
"type": "number",
1834
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1835
},
1836
"postgresDatabases": {
1837
"type": "number",
1838
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1839
},
1840
"integrationStores": {
1841
"type": "number",
1842
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1843
},
1844
"cronJobs": {
1845
"type": "number",
1846
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1847
},
1848
"cronJobsPerProject": {
1849
"type": "number",
1850
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1851
}
1852
},
1853
"type": "object",
1854
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1855
},
1856
"stagingPrefix": {
1857
"type": "string",
1858
"description": "Prefix that will be used in the URL of \"Preview\" deployments created by the User account."
1859
},
1860
"activeDashboardViews": {
1861
"items": {
1862
"properties": {
1863
"scopeId": { "type": "string" },
1864
"viewPreference": { "type": "string", "enum": ["list", "cards"] },
1865
"favoritesViewPreference": {
1866
"type": "string",
1867
"enum": ["open", "closed"]
1868
},
1869
"recentsViewPreference": {
1870
"type": "string",
1871
"enum": ["open", "closed"]
1872
}
1873
},
1874
"required": ["scopeId"],
1875
"type": "object",
1876
"description": "set of dashboard view preferences (cards or list) per scopeId"
1877
},
1878
"type": "array",
1879
"description": "set of dashboard view preferences (cards or list) per scopeId"
1880
},
1881
"importFlowGitNamespace": {
1882
"nullable": true,
1883
"oneOf": [{ "type": "string" }, { "type": "number" }]
1884
},
1885
"importFlowGitNamespaceId": {
1886
"nullable": true,
1887
"oneOf": [{ "type": "string" }, { "type": "number" }]
1888
},
1889
"importFlowGitProvider": {
1890
"type": "string",
1891
"enum": ["github", "gitlab", "bitbucket"]
1892
},
1893
"preferredScopesAndGitNamespaces": {
1894
"items": {
1895
"properties": {
1896
"scopeId": { "type": "string" },
1897
"gitNamespaceId": {
1898
"nullable": true,
1899
"oneOf": [{ "type": "string" }, { "type": "number" }]
1900
}
1901
},
1902
"required": ["scopeId", "gitNamespaceId"],
1903
"type": "object"
1904
},
1905
"type": "array"
1906
},
1907
"dismissedToasts": {
1908
"items": {
1909
"properties": {
1910
"name": { "type": "string" },
1911
"dismissals": {
1912
"items": {
1913
"properties": {
1914
"scopeId": { "type": "string" },
1915
"createdAt": { "type": "number" }
1916
},
1917
"required": ["scopeId", "createdAt"],
1918
"type": "object"
1919
},
1920
"type": "array"
1921
}
1922
},
1923
"required": ["name", "dismissals"],
1924
"type": "object",
1925
"description": "A record of when, under a certain scopeId, a toast was dismissed"
1926
},
1927
"type": "array",
1928
"description": "A record of when, under a certain scopeId, a toast was dismissed"
1929
},
1930
"favoriteProjectsAndSpaces": {
1931
"items": {
1932
"oneOf": [
1933
{
1934
"properties": {
1935
"projectId": { "type": "string" },
1936
"scopeSlug": { "type": "string" },
1937
"scopeId": { "type": "string" }
1938
},
1939
"required": ["projectId", "scopeSlug", "scopeId"],
1940
"type": "object",
1941
"description": "A list of projects and spaces across teams that a user has marked as a favorite."
1942
},
1943
{
1944
"properties": {
1945
"spaceId": { "type": "string" },
1946
"scopeSlug": { "type": "string" },
1947
"scopeId": { "type": "string" }
1948
},
1949
"required": ["spaceId", "scopeSlug", "scopeId"],
1950
"type": "object",
1951
"description": "A list of projects and spaces across teams that a user has marked as a favorite."
1952
}
1953
]
1954
},
1955
"type": "array",
1956
"description": "A list of projects and spaces across teams that a user has marked as a favorite."
1957
},
1958
"hasTrialAvailable": {
1959
"type": "boolean",
1960
"description": "Whether the user has a trial available for a paid plan subscription."
1961
},
1962
"remoteCaching": {
1963
"properties": { "enabled": { "type": "boolean" } },
1964
"type": "object",
1965
"description": "remote caching settings"
1966
},
1967
"dataCache": {
1968
"properties": { "excessBillingEnabled": { "type": "boolean" } },
1969
"type": "object",
1970
"description": "data cache settings"
1971
},
1972
"featureBlocks": {
1973
"properties": {
1974
"webAnalytics": {
1975
"properties": {
1976
"blockedFrom": { "type": "number" },
1977
"blockedUntil": { "type": "number" },
1978
"isCurrentlyBlocked": { "type": "boolean" }
1979
},
1980
"required": ["isCurrentlyBlocked"],
1981
"type": "object"
1982
}
1983
},
1984
"type": "object",
1985
"description": "Feature blocks for the user"
1986
},
1987
"northstarMigration": {
1988
"properties": {
1989
"teamId": {
1990
"type": "string",
1991
"description": "The ID of the team we created for this user."
1992
},
1993
"projects": {
1994
"type": "number",
1995
"description": "The number of projects migrated for this user."
1996
},
1997
"stores": {
1998
"type": "number",
1999
"description": "The number of stores migrated for this user."
2000
},
2001
"integrationConfigurations": {
2002
"type": "number",
2003
"description": "The number of integration configurations migrated for this user."
2004
},
2005
"integrationClients": {
2006
"type": "number",
2007
"description": "The number of integration clients migrated for this user."
2008
},
2009
"startTime": {
2010
"type": "number",
2011
"description": "The migration start time timestamp for this user."
2012
},
2013
"endTime": {
2014
"type": "number",
2015
"description": "The migration end time timestamp for this user."
2016
}
2017
},
2018
"required": [
2019
"teamId",
2020
"projects",
2021
"stores",
2022
"integrationConfigurations",
2023
"integrationClients",
2024
"startTime",
2025
"endTime"
2026
],
2027
"type": "object"
2028
},
2029
"id": {
2030
"type": "string",
2031
"description": "The User's unique identifier.",
2032
"example": "AEIIDYVk59zbFF2Sxfyxxmua"
2033
},
2034
"email": {
2035
"type": "string",
2036
"description": "Email address associated with the User account.",
2037
"example": "[email protected]"
2038
},
2039
"name": {
2040
"nullable": true,
2041
"type": "string",
2042
"description": "Name associated with the User account, or `null` if none has been provided.",
2043
"example": "John Doe"
2044
},
2045
"username": {
2046
"type": "string",
2047
"description": "Unique username associated with the User account.",
2048
"example": "jdoe"
2049
},
2050
"avatar": {
2051
"nullable": true,
2052
"type": "string",
2053
"description": "SHA1 hash of the avatar for the User account. Can be used in conjuction with the ... endpoint to retrieve the avatar image.",
2054
"example": "22cb30c85ff45ac4c72de8981500006b28114aa1"
2055
},
2056
"defaultTeamId": {
2057
"nullable": true,
2058
"type": "string",
2059
"description": "The user's default team. Only applies if the user's `version` is `'northstar'`."
2060
},
2061
"version": {
2062
"nullable": true,
2063
"type": "string",
2064
"enum": ["northstar"],
2065
"description": "The user's version. Will either be unset or `northstar`."
2066
}
2067
},
2068
"required": [
2069
"createdAt",
2070
"softBlock",
2071
"billing",
2072
"resourceConfig",
2073
"stagingPrefix",
2074
"hasTrialAvailable",
2075
"id",
2076
"email",
2077
"name",
2078
"username",
2079
"avatar",
2080
"defaultTeamId",
2081
"version"
2082
],
2083
"type": "object",
2084
"description": "Data for the currently authenticated User."
2085
}

AuthUserLimited

1
{
2
"properties": {
3
"limited": {
4
"type": "boolean",
5
"description": "Property indicating that this User data contains only limited information, due to the authentication token missing privileges to read the full User data. Re-login with email, GitHub, GitLab or Bitbucket in order to upgrade the authentication token with the necessary privileges."
6
},
7
"id": {
8
"type": "string",
9
"description": "The User's unique identifier.",
10
"example": "AEIIDYVk59zbFF2Sxfyxxmua"
11
},
12
"email": {
13
"type": "string",
14
"description": "Email address associated with the User account.",
15
"example": "[email protected]"
16
},
17
"name": {
18
"nullable": true,
19
"type": "string",
20
"description": "Name associated with the User account, or `null` if none has been provided.",
21
"example": "John Doe"
22
},
23
"username": {
24
"type": "string",
25
"description": "Unique username associated with the User account.",
26
"example": "jdoe"
27
},
28
"avatar": {
29
"nullable": true,
30
"type": "string",
31
"description": "SHA1 hash of the avatar for the User account. Can be used in conjuction with the ... endpoint to retrieve the avatar image.",
32
"example": "22cb30c85ff45ac4c72de8981500006b28114aa1"
33
},
34
"defaultTeamId": {
35
"nullable": true,
36
"type": "string",
37
"description": "The user's default team. Only applies if the user's `version` is `'northstar'`."
38
},
39
"version": {
40
"nullable": true,
41
"type": "string",
42
"enum": ["northstar"],
43
"description": "The user's version. Will either be unset or `northstar`."
44
}
45
},
46
"required": [
47
"limited",
48
"id",
49
"email",
50
"name",
51
"username",
52
"avatar",
53
"defaultTeamId",
54
"version"
55
],
56
"type": "object",
57
"description": "A limited form of data for the currently authenticated User, due to the authentication token missing privileges to read the full User data."
58
}

EdgeConfigItem

1
{
2
"properties": {
3
"key": { "type": "string" },
4
"value": { "$ref": "#/components/schemas/EdgeConfigItemValue" },
5
"description": { "type": "string" },
6
"edgeConfigId": { "type": "string" },
7
"createdAt": { "type": "number" },
8
"updatedAt": { "type": "number" }
9
},
10
"required": ["key", "value", "edgeConfigId", "createdAt", "updatedAt"],
11
"type": "object",
12
"description": "The EdgeConfig."
13
}

EdgeConfigItemValue

1
{
2
"nullable": true,
3
"oneOf": [
4
{ "type": "string" },
5
{ "type": "number" },
6
{ "type": "boolean" },
7
{
8
"additionalProperties": {
9
"$ref": "#/components/schemas/EdgeConfigItemValue"
10
},
11
"type": "object"
12
},
13
{
14
"items": { "$ref": "#/components/schemas/EdgeConfigItemValue" },
15
"type": "array"
16
}
17
]
18
}

EdgeConfigToken

1
{
2
"properties": {
3
"token": { "type": "string" },
4
"label": { "type": "string" },
5
"id": {
6
"type": "string",
7
"description": "This is not the token itself, but rather an id to identify the token by"
8
},
9
"edgeConfigId": { "type": "string" },
10
"createdAt": { "type": "number" }
11
},
12
"required": ["token", "label", "id", "edgeConfigId", "createdAt"],
13
"type": "object",
14
"description": "The EdgeConfig."
15
}

FileTree

1
{
2
"properties": {
3
"name": {
4
"type": "string",
5
"description": "The name of the file tree entry",
6
"example": "my-file.json"
7
},
8
"type": {
9
"type": "string",
10
"enum": [
11
"directory",
12
"file",
13
"symlink",
14
"lambda",
15
"middleware",
16
"invalid"
17
],
18
"description": "String indicating the type of file tree entry.",
19
"example": "file"
20
},
21
"uid": {
22
"type": "string",
23
"description": "The unique identifier of the file (only valid for the `file` type)",
24
"example": "2d4aad419917f15b1146e9e03ddc9bb31747e4d0"
25
},
26
"children": {
27
"items": { "$ref": "#/components/schemas/FileTree" },
28
"type": "array",
29
"description": "The list of children files of the directory (only valid for the `directory` type)"
30
},
31
"contentType": {
32
"type": "string",
33
"description": "The content-type of the file (only valid for the `file` type)",
34
"example": "application/json"
35
},
36
"mode": {
37
"type": "number",
38
"description": "The file \"mode\" indicating file type and permissions."
39
},
40
"symlink": {
41
"type": "string",
42
"description": "Not currently used. See `file-list-to-tree.ts`."
43
}
44
},
45
"required": ["name", "type", "mode"],
46
"type": "object",
47
"description": "A deployment file tree entry"
48
}

FlagJSONValue

1
{
2
"nullable": true,
3
"oneOf": [
4
{ "type": "string" },
5
{ "type": "number" },
6
{ "type": "boolean" },
7
{
8
"items": { "$ref": "#/components/schemas/FlagJSONValue" },
9
"type": "array",
10
"description": "TODO: The following types will eventually be exported by a more relevant package."
11
},
12
{
13
"additionalProperties": { "$ref": "#/components/schemas/FlagJSONValue" },
14
"type": "object"
15
}
16
]
17
}

Pagination

1
{
2
"properties": {
3
"count": {
4
"type": "number",
5
"description": "Amount of items in the current page.",
6
"example": 20
7
},
8
"next": {
9
"nullable": true,
10
"type": "number",
11
"description": "Timestamp that must be used to request the next page.",
12
"example": 1540095775951
13
},
14
"prev": {
15
"nullable": true,
16
"type": "number",
17
"description": "Timestamp that must be used to request the previous page.",
18
"example": 1540095775951
19
}
20
},
21
"required": ["count", "next", "prev"],
22
"type": "object",
23
"description": "This object contains information related to the pagination of the current request, including the necessary parameters to get the next or previous page of data."
24
}

Team

1
{ "type": "object", "description": "Data representing a Team." }

TeamLimited

1
{
2
"properties": {
3
"limited": {
4
"type": "boolean",
5
"description": "Property indicating that this Team data contains only limited information, due to the authentication token missing privileges to read the full Team data. Re-login with the Team's configured SAML Single Sign-On provider in order to upgrade the authentication token with the necessary privileges."
6
},
7
"saml": {
8
"properties": {
9
"connection": {
10
"properties": {
11
"type": {
12
"type": "string",
13
"description": "The Identity Provider \"type\", for example Okta.",
14
"example": "OktaSAML"
15
},
16
"status": {
17
"type": "string",
18
"description": "Current status of the connection.",
19
"example": "linked"
20
},
21
"state": {
22
"type": "string",
23
"description": "Current state of the connection.",
24
"example": "active"
25
},
26
"connectedAt": {
27
"type": "number",
28
"description": "Timestamp (in milliseconds) of when the configuration was connected.",
29
"example": 1611796915677
30
},
31
"lastReceivedWebhookEvent": {
32
"type": "number",
33
"description": "Timestamp (in milliseconds) of when the last webhook event was received from WorkOS.",
34
"example": 1611796915677
35
}
36
},
37
"required": ["type", "status", "state", "connectedAt"],
38
"type": "object",
39
"description": "Information for the SAML Single Sign-On configuration."
40
},
41
"directory": {
42
"properties": {
43
"type": {
44
"type": "string",
45
"description": "The Identity Provider \"type\", for example Okta.",
46
"example": "OktaSAML"
47
},
48
"state": {
49
"type": "string",
50
"description": "Current state of the connection.",
51
"example": "active"
52
},
53
"connectedAt": {
54
"type": "number",
55
"description": "Timestamp (in milliseconds) of when the configuration was connected.",
56
"example": 1611796915677
57
},
58
"lastReceivedWebhookEvent": {
59
"type": "number",
60
"description": "Timestamp (in milliseconds) of when the last webhook event was received from WorkOS.",
61
"example": 1611796915677
62
}
63
},
64
"required": ["type", "state", "connectedAt"],
65
"type": "object",
66
"description": "Information for the Directory Sync configuration."
67
},
68
"enforced": {
69
"type": "boolean",
70
"description": "When `true`, interactions with the Team **must** be done with an authentication token that has been authenticated with the Team's SAML Single Sign-On provider."
71
}
72
},
73
"required": ["enforced"],
74
"type": "object",
75
"description": "When \"Single Sign-On (SAML)\" is configured, this object contains information that allows the client-side to identify whether or not this Team has SAML enforced."
76
},
77
"id": {
78
"type": "string",
79
"description": "The Team's unique identifier.",
80
"example": "team_nllPyCtREAqxxdyFKbbMDlxd"
81
},
82
"slug": {
83
"type": "string",
84
"description": "The Team's slug, which is unique across the Vercel platform.",
85
"example": "my-team"
86
},
87
"name": {
88
"nullable": true,
89
"type": "string",
90
"description": "Name associated with the Team account, or `null` if none has been provided.",
91
"example": "My Team"
92
},
93
"avatar": {
94
"nullable": true,
95
"type": "string",
96
"description": "The ID of the file used as avatar for this Team.",
97
"example": "6eb07268bcfadd309905ffb1579354084c24655c"
98
},
99
"membership": {
100
"properties": {
101
"uid": { "type": "string" },
102
"entitlements": {
103
"items": {
104
"properties": { "entitlement": { "type": "string" } },
105
"required": ["entitlement"],
106
"type": "object"
107
},
108
"type": "array"
109
},
110
"confirmed": { "type": "boolean" },
111
"confirmedAt": { "type": "number" },
112
"accessRequestedAt": { "type": "number" },
113
"role": {
114
"type": "string",
115
"enum": [
116
"OWNER",
117
"MEMBER",
118
"DEVELOPER",
119
"BILLING",
120
"VIEWER",
121
"CONTRIBUTOR"
122
]
123
},
124
"teamId": { "type": "string" },
125
"createdAt": { "type": "number" },
126
"created": { "type": "number" },
127
"joinedFrom": {
128
"properties": {
129
"origin": {
130
"type": "string",
131
"enum": [
132
"link",
133
"saml",
134
"mail",
135
"import",
136
"teams",
137
"github",
138
"gitlab",
139
"bitbucket",
140
"dsync",
141
"feedback",
142
"organization-teams"
143
]
144
},
145
"commitId": { "type": "string" },
146
"repoId": { "type": "string" },
147
"repoPath": { "type": "string" },
148
"gitUserId": {
149
"oneOf": [{ "type": "string" }, { "type": "number" }]
150
},
151
"gitUserLogin": { "type": "string" },
152
"ssoUserId": { "type": "string" },
153
"ssoConnectedAt": { "type": "number" },
154
"idpUserId": { "type": "string" },
155
"dsyncUserId": { "type": "string" },
156
"dsyncConnectedAt": { "type": "number" }
157
},
158
"required": ["origin"],
159
"type": "object"
160
}
161
},
162
"required": ["confirmed", "confirmedAt", "role", "createdAt", "created"],
163
"type": "object",
164
"description": "The membership of the authenticated User in relation to the Team."
165
},
166
"created": {
167
"type": "string",
168
"description": "Will remain undocumented. Remove in v3 API."
169
},
170
"createdAt": {
171
"type": "number",
172
"description": "UNIX timestamp (in milliseconds) when the Team was created.",
173
"example": 1630748523395
174
}
175
},
176
"required": [
177
"limited",
178
"id",
179
"slug",
180
"name",
181
"avatar",
182
"membership",
183
"created",
184
"createdAt"
185
],
186
"type": "object",
187
"description": "A limited form of data representing a Team, due to the authentication token missing privileges to read the full Team data."
188
}

UserEvent

1
{
2
"properties": {
3
"id": {
4
"type": "string",
5
"description": "The unique identifier of the Event.",
6
"example": "uev_bfmMjiMnXfnPbT97dGdpJbCN"
7
},
8
"text": {
9
"type": "string",
10
"description": "The human-readable text of the Event.",
11
"example": "You logged in via GitHub"
12
},
13
"entities": {
14
"items": {
15
"properties": {
16
"type": {
17
"type": "string",
18
"enum": [
19
"author",
20
"bitbucket_login",
21
"bold",
22
"deployment_host",
23
"dns_record",
24
"git_link",
25
"github_login",
26
"gitlab_login",
27
"hook_name",
28
"integration",
29
"edge-config",
30
"flag",
31
"flags-segment",
32
"flags-settings",
33
"link",
34
"project_name",
35
"scaling_rules",
36
"env_var_name",
37
"target",
38
"store",
39
"system"
40
],
41
"description": "The type of entity.",
42
"example": "author"
43
},
44
"start": {
45
"type": "number",
46
"description": "The index of where the entity begins within the `text` (inclusive).",
47
"example": 0
48
},
49
"end": {
50
"type": "number",
51
"description": "The index of where the entity ends within the `text` (non-inclusive).",
52
"example": 3
53
}
54
},
55
"required": ["type", "start", "end"],
56
"type": "object",
57
"description": "A list of \"entities\" within the event `text`. Useful for enhancing the displayed text with additional styling and links."
58
},
59
"type": "array",
60
"description": "A list of \"entities\" within the event `text`. Useful for enhancing the displayed text with additional styling and links."
61
},
62
"createdAt": {
63
"type": "number",
64
"description": "Timestamp (in milliseconds) of when the event was generated.",
65
"example": 1632859321020
66
},
67
"user": {
68
"properties": {
69
"avatar": { "type": "string" },
70
"email": { "type": "string" },
71
"slug": { "type": "string" },
72
"uid": { "type": "string" },
73
"username": { "type": "string" }
74
},
75
"required": ["avatar", "email", "uid", "username"],
76
"type": "object",
77
"description": "Metadata for the User who generated the event."
78
},
79
"userId": {
80
"type": "string",
81
"description": "The unique identifier of the User who generated the event.",
82
"example": "zTuNVUXEAvvnNN3IaqinkyMw"
83
}
84
},
85
"required": ["id", "text", "entities", "createdAt", "userId"],
86
"type": "object",
87
"description": "Array of events generated by the User."
88
}
Last updated on October 2, 2024