Reference
1 min read

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
}

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
"blobStores",
27
"analyticsUsage",
28
"artifacts",
29
"bandwidth",
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
"webAnalyticsEvent"
62
]
63
}
64
},
65
"required": ["blockedAt", "reason"],
66
"type": "object",
67
"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."
68
},
69
"billing": {
70
"nullable": true,
71
"properties": {
72
"currency": { "type": "string", "enum": ["usd", "eur"] },
73
"cancelation": { "nullable": true, "type": "number" },
74
"period": {
75
"nullable": true,
76
"properties": {
77
"start": { "type": "number" },
78
"end": { "type": "number" }
79
},
80
"required": ["start", "end"],
81
"type": "object"
82
},
83
"contract": {
84
"nullable": true,
85
"properties": {
86
"start": { "type": "number" },
87
"end": { "type": "number" }
88
},
89
"required": ["start", "end"],
90
"type": "object"
91
},
92
"plan": { "type": "string", "enum": ["pro", "enterprise", "hobby"] },
93
"planIteration": { "type": "string" },
94
"platform": { "type": "string", "enum": ["stripe", "stripeTestMode"] },
95
"orbCustomerId": { "type": "string" },
96
"syncedAt": { "type": "number" },
97
"programType": { "type": "string", "enum": ["startup", "agency"] },
98
"trial": {
99
"nullable": true,
100
"properties": {
101
"start": { "type": "number" },
102
"end": { "type": "number" }
103
},
104
"required": ["start", "end"],
105
"type": "object"
106
},
107
"email": { "nullable": true, "type": "string" },
108
"tax": {
109
"nullable": true,
110
"properties": {
111
"type": { "type": "string" },
112
"id": { "type": "string" }
113
},
114
"required": ["type", "id"],
115
"type": "object"
116
},
117
"language": { "nullable": true, "type": "string" },
118
"address": {
119
"nullable": true,
120
"properties": {
121
"line1": { "type": "string" },
122
"line2": { "type": "string" },
123
"postalCode": { "type": "string" },
124
"city": { "type": "string" },
125
"country": { "type": "string" },
126
"state": { "type": "string" }
127
},
128
"type": "object"
129
},
130
"name": { "nullable": true, "type": "string" },
131
"invoiceItems": {
132
"nullable": true,
133
"properties": {
134
"concurrentBuilds": {
135
"properties": {
136
"tier": { "type": "number" },
137
"price": { "type": "number" },
138
"quantity": { "type": "number" },
139
"highestQuantity": { "type": "number" },
140
"name": { "type": "string" },
141
"hidden": { "type": "boolean" },
142
"createdAt": { "type": "number" },
143
"disabledAt": { "nullable": true, "type": "number" },
144
"frequency": {
145
"properties": {
146
"interval": { "type": "string", "enum": ["month"] },
147
"intervalCount": {
148
"type": "number",
149
"enum": [1, 2, 3, 6, 12]
150
}
151
},
152
"required": ["interval", "intervalCount"],
153
"type": "object"
154
},
155
"maxQuantity": { "type": "number" }
156
},
157
"required": ["price", "quantity", "hidden"],
158
"type": "object",
159
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
160
},
161
"webAnalytics": {
162
"properties": {
163
"tier": { "type": "number" },
164
"price": { "type": "number" },
165
"quantity": { "type": "number" },
166
"highestQuantity": { "type": "number" },
167
"name": { "type": "string" },
168
"hidden": { "type": "boolean" },
169
"createdAt": { "type": "number" },
170
"disabledAt": { "nullable": true, "type": "number" },
171
"frequency": {
172
"properties": {
173
"interval": { "type": "string", "enum": ["month"] },
174
"intervalCount": {
175
"type": "number",
176
"enum": [1, 2, 3, 6, 12]
177
}
178
},
179
"required": ["interval", "intervalCount"],
180
"type": "object"
181
},
182
"maxQuantity": { "type": "number" }
183
},
184
"required": ["price", "quantity", "hidden"],
185
"type": "object",
186
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
187
},
188
"pro": {
189
"properties": {
190
"tier": { "type": "number" },
191
"price": { "type": "number" },
192
"quantity": { "type": "number" },
193
"highestQuantity": { "type": "number" },
194
"name": { "type": "string" },
195
"hidden": { "type": "boolean" },
196
"createdAt": { "type": "number" },
197
"disabledAt": { "nullable": true, "type": "number" },
198
"frequency": {
199
"properties": {
200
"interval": { "type": "string", "enum": ["month"] },
201
"intervalCount": {
202
"type": "number",
203
"enum": [1, 2, 3, 6, 12]
204
}
205
},
206
"required": ["interval", "intervalCount"],
207
"type": "object"
208
},
209
"maxQuantity": { "type": "number" }
210
},
211
"required": ["price", "quantity", "hidden"],
212
"type": "object",
213
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
214
},
215
"enterprise": {
216
"properties": {
217
"tier": { "type": "number" },
218
"price": { "type": "number" },
219
"quantity": { "type": "number" },
220
"highestQuantity": { "type": "number" },
221
"name": { "type": "string" },
222
"hidden": { "type": "boolean" },
223
"createdAt": { "type": "number" },
224
"disabledAt": { "nullable": true, "type": "number" },
225
"frequency": {
226
"properties": {
227
"interval": { "type": "string", "enum": ["month"] },
228
"intervalCount": {
229
"type": "number",
230
"enum": [1, 2, 3, 6, 12]
231
}
232
},
233
"required": ["interval", "intervalCount"],
234
"type": "object"
235
},
236
"maxQuantity": { "type": "number" }
237
},
238
"required": ["price", "quantity", "hidden"],
239
"type": "object",
240
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
241
},
242
"analytics": {
243
"properties": {
244
"tier": { "type": "number" },
245
"price": { "type": "number" },
246
"quantity": { "type": "number" },
247
"highestQuantity": { "type": "number" },
248
"name": { "type": "string" },
249
"hidden": { "type": "boolean" },
250
"createdAt": { "type": "number" },
251
"disabledAt": { "nullable": true, "type": "number" },
252
"frequency": {
253
"properties": {
254
"interval": { "type": "string", "enum": ["month"] },
255
"intervalCount": {
256
"type": "number",
257
"enum": [1, 2, 3, 6, 12]
258
}
259
},
260
"required": ["interval", "intervalCount"],
261
"type": "object"
262
},
263
"maxQuantity": { "type": "number" }
264
},
265
"required": ["price", "quantity", "hidden"],
266
"type": "object",
267
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
268
},
269
"monitoring": {
270
"properties": {
271
"tier": { "type": "number" },
272
"price": { "type": "number" },
273
"quantity": { "type": "number" },
274
"highestQuantity": { "type": "number" },
275
"name": { "type": "string" },
276
"hidden": { "type": "boolean" },
277
"createdAt": { "type": "number" },
278
"disabledAt": { "nullable": true, "type": "number" },
279
"frequency": {
280
"properties": {
281
"interval": { "type": "string", "enum": ["month"] },
282
"intervalCount": {
283
"type": "number",
284
"enum": [1, 2, 3, 6, 12]
285
}
286
},
287
"required": ["interval", "intervalCount"],
288
"type": "object"
289
},
290
"maxQuantity": { "type": "number" }
291
},
292
"required": ["price", "quantity", "hidden"],
293
"type": "object",
294
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
295
},
296
"passwordProtection": {
297
"properties": {
298
"tier": { "type": "number" },
299
"price": { "type": "number" },
300
"quantity": { "type": "number" },
301
"highestQuantity": { "type": "number" },
302
"name": { "type": "string" },
303
"hidden": { "type": "boolean" },
304
"createdAt": { "type": "number" },
305
"disabledAt": { "nullable": true, "type": "number" },
306
"frequency": {
307
"properties": {
308
"interval": { "type": "string", "enum": ["month"] },
309
"intervalCount": {
310
"type": "number",
311
"enum": [1, 2, 3, 6, 12]
312
}
313
},
314
"required": ["interval", "intervalCount"],
315
"type": "object"
316
},
317
"maxQuantity": { "type": "number" }
318
},
319
"required": ["price", "quantity", "hidden"],
320
"type": "object",
321
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
322
},
323
"previewDeploymentSuffix": {
324
"properties": {
325
"tier": { "type": "number" },
326
"price": { "type": "number" },
327
"quantity": { "type": "number" },
328
"highestQuantity": { "type": "number" },
329
"name": { "type": "string" },
330
"hidden": { "type": "boolean" },
331
"createdAt": { "type": "number" },
332
"disabledAt": { "nullable": true, "type": "number" },
333
"frequency": {
334
"properties": {
335
"interval": { "type": "string", "enum": ["month"] },
336
"intervalCount": {
337
"type": "number",
338
"enum": [1, 2, 3, 6, 12]
339
}
340
},
341
"required": ["interval", "intervalCount"],
342
"type": "object"
343
},
344
"maxQuantity": { "type": "number" }
345
},
346
"required": ["price", "quantity", "hidden"],
347
"type": "object",
348
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
349
},
350
"saml": {
351
"properties": {
352
"tier": { "type": "number" },
353
"price": { "type": "number" },
354
"quantity": { "type": "number" },
355
"highestQuantity": { "type": "number" },
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, 2, 3, 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
"teamSeats": {
378
"properties": {
379
"tier": { "type": "number" },
380
"price": { "type": "number" },
381
"quantity": { "type": "number" },
382
"highestQuantity": { "type": "number" },
383
"name": { "type": "string" },
384
"hidden": { "type": "boolean" },
385
"createdAt": { "type": "number" },
386
"disabledAt": { "nullable": true, "type": "number" },
387
"frequency": {
388
"properties": {
389
"interval": { "type": "string", "enum": ["month"] },
390
"intervalCount": {
391
"type": "number",
392
"enum": [1, 2, 3, 6, 12]
393
}
394
},
395
"required": ["interval", "intervalCount"],
396
"type": "object"
397
},
398
"maxQuantity": { "type": "number" }
399
},
400
"required": ["price", "quantity", "hidden"],
401
"type": "object",
402
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
403
},
404
"blobStores": {
405
"properties": {
406
"matrix": {
407
"properties": {
408
"defaultUnitPrice": { "type": "string" },
409
"dimensionPrices": {
410
"additionalProperties": { "type": "string" },
411
"type": "object"
412
}
413
},
414
"required": ["defaultUnitPrice", "dimensionPrices"],
415
"type": "object"
416
},
417
"tier": { "type": "number" },
418
"price": { "type": "number" },
419
"batch": { "type": "number" },
420
"threshold": { "type": "number" },
421
"name": { "type": "string" },
422
"hidden": { "type": "boolean" },
423
"disabledAt": { "nullable": true, "type": "number" },
424
"enabledAt": { "nullable": true, "type": "number" }
425
},
426
"required": ["price", "batch", "threshold", "hidden"],
427
"type": "object"
428
},
429
"analyticsUsage": {
430
"properties": {
431
"matrix": {
432
"properties": {
433
"defaultUnitPrice": { "type": "string" },
434
"dimensionPrices": {
435
"additionalProperties": { "type": "string" },
436
"type": "object"
437
}
438
},
439
"required": ["defaultUnitPrice", "dimensionPrices"],
440
"type": "object"
441
},
442
"tier": { "type": "number" },
443
"price": { "type": "number" },
444
"batch": { "type": "number" },
445
"threshold": { "type": "number" },
446
"name": { "type": "string" },
447
"hidden": { "type": "boolean" },
448
"disabledAt": { "nullable": true, "type": "number" },
449
"enabledAt": { "nullable": true, "type": "number" }
450
},
451
"required": ["price", "batch", "threshold", "hidden"],
452
"type": "object"
453
},
454
"artifacts": {
455
"properties": {
456
"matrix": {
457
"properties": {
458
"defaultUnitPrice": { "type": "string" },
459
"dimensionPrices": {
460
"additionalProperties": { "type": "string" },
461
"type": "object"
462
}
463
},
464
"required": ["defaultUnitPrice", "dimensionPrices"],
465
"type": "object"
466
},
467
"tier": { "type": "number" },
468
"price": { "type": "number" },
469
"batch": { "type": "number" },
470
"threshold": { "type": "number" },
471
"name": { "type": "string" },
472
"hidden": { "type": "boolean" },
473
"disabledAt": { "nullable": true, "type": "number" },
474
"enabledAt": { "nullable": true, "type": "number" }
475
},
476
"required": ["price", "batch", "threshold", "hidden"],
477
"type": "object"
478
},
479
"bandwidth": {
480
"properties": {
481
"matrix": {
482
"properties": {
483
"defaultUnitPrice": { "type": "string" },
484
"dimensionPrices": {
485
"additionalProperties": { "type": "string" },
486
"type": "object"
487
}
488
},
489
"required": ["defaultUnitPrice", "dimensionPrices"],
490
"type": "object"
491
},
492
"tier": { "type": "number" },
493
"price": { "type": "number" },
494
"batch": { "type": "number" },
495
"threshold": { "type": "number" },
496
"name": { "type": "string" },
497
"hidden": { "type": "boolean" },
498
"disabledAt": { "nullable": true, "type": "number" },
499
"enabledAt": { "nullable": true, "type": "number" }
500
},
501
"required": ["price", "batch", "threshold", "hidden"],
502
"type": "object"
503
},
504
"blobTotalAdvancedRequests": {
505
"properties": {
506
"matrix": {
507
"properties": {
508
"defaultUnitPrice": { "type": "string" },
509
"dimensionPrices": {
510
"additionalProperties": { "type": "string" },
511
"type": "object"
512
}
513
},
514
"required": ["defaultUnitPrice", "dimensionPrices"],
515
"type": "object"
516
},
517
"tier": { "type": "number" },
518
"price": { "type": "number" },
519
"batch": { "type": "number" },
520
"threshold": { "type": "number" },
521
"name": { "type": "string" },
522
"hidden": { "type": "boolean" },
523
"disabledAt": { "nullable": true, "type": "number" },
524
"enabledAt": { "nullable": true, "type": "number" }
525
},
526
"required": ["price", "batch", "threshold", "hidden"],
527
"type": "object"
528
},
529
"blobTotalAvgSizeInBytes": {
530
"properties": {
531
"matrix": {
532
"properties": {
533
"defaultUnitPrice": { "type": "string" },
534
"dimensionPrices": {
535
"additionalProperties": { "type": "string" },
536
"type": "object"
537
}
538
},
539
"required": ["defaultUnitPrice", "dimensionPrices"],
540
"type": "object"
541
},
542
"tier": { "type": "number" },
543
"price": { "type": "number" },
544
"batch": { "type": "number" },
545
"threshold": { "type": "number" },
546
"name": { "type": "string" },
547
"hidden": { "type": "boolean" },
548
"disabledAt": { "nullable": true, "type": "number" },
549
"enabledAt": { "nullable": true, "type": "number" }
550
},
551
"required": ["price", "batch", "threshold", "hidden"],
552
"type": "object"
553
},
554
"blobTotalGetResponseObjectSizeInBytes": {
555
"properties": {
556
"matrix": {
557
"properties": {
558
"defaultUnitPrice": { "type": "string" },
559
"dimensionPrices": {
560
"additionalProperties": { "type": "string" },
561
"type": "object"
562
}
563
},
564
"required": ["defaultUnitPrice", "dimensionPrices"],
565
"type": "object"
566
},
567
"tier": { "type": "number" },
568
"price": { "type": "number" },
569
"batch": { "type": "number" },
570
"threshold": { "type": "number" },
571
"name": { "type": "string" },
572
"hidden": { "type": "boolean" },
573
"disabledAt": { "nullable": true, "type": "number" },
574
"enabledAt": { "nullable": true, "type": "number" }
575
},
576
"required": ["price", "batch", "threshold", "hidden"],
577
"type": "object"
578
},
579
"blobTotalSimpleRequests": {
580
"properties": {
581
"matrix": {
582
"properties": {
583
"defaultUnitPrice": { "type": "string" },
584
"dimensionPrices": {
585
"additionalProperties": { "type": "string" },
586
"type": "object"
587
}
588
},
589
"required": ["defaultUnitPrice", "dimensionPrices"],
590
"type": "object"
591
},
592
"tier": { "type": "number" },
593
"price": { "type": "number" },
594
"batch": { "type": "number" },
595
"threshold": { "type": "number" },
596
"name": { "type": "string" },
597
"hidden": { "type": "boolean" },
598
"disabledAt": { "nullable": true, "type": "number" },
599
"enabledAt": { "nullable": true, "type": "number" }
600
},
601
"required": ["price", "batch", "threshold", "hidden"],
602
"type": "object"
603
},
604
"buildMinute": {
605
"properties": {
606
"matrix": {
607
"properties": {
608
"defaultUnitPrice": { "type": "string" },
609
"dimensionPrices": {
610
"additionalProperties": { "type": "string" },
611
"type": "object"
612
}
613
},
614
"required": ["defaultUnitPrice", "dimensionPrices"],
615
"type": "object"
616
},
617
"tier": { "type": "number" },
618
"price": { "type": "number" },
619
"batch": { "type": "number" },
620
"threshold": { "type": "number" },
621
"name": { "type": "string" },
622
"hidden": { "type": "boolean" },
623
"disabledAt": { "nullable": true, "type": "number" },
624
"enabledAt": { "nullable": true, "type": "number" }
625
},
626
"required": ["price", "batch", "threshold", "hidden"],
627
"type": "object"
628
},
629
"dataCacheRead": {
630
"properties": {
631
"matrix": {
632
"properties": {
633
"defaultUnitPrice": { "type": "string" },
634
"dimensionPrices": {
635
"additionalProperties": { "type": "string" },
636
"type": "object"
637
}
638
},
639
"required": ["defaultUnitPrice", "dimensionPrices"],
640
"type": "object"
641
},
642
"tier": { "type": "number" },
643
"price": { "type": "number" },
644
"batch": { "type": "number" },
645
"threshold": { "type": "number" },
646
"name": { "type": "string" },
647
"hidden": { "type": "boolean" },
648
"disabledAt": { "nullable": true, "type": "number" },
649
"enabledAt": { "nullable": true, "type": "number" }
650
},
651
"required": ["price", "batch", "threshold", "hidden"],
652
"type": "object"
653
},
654
"dataCacheRevalidation": {
655
"properties": {
656
"matrix": {
657
"properties": {
658
"defaultUnitPrice": { "type": "string" },
659
"dimensionPrices": {
660
"additionalProperties": { "type": "string" },
661
"type": "object"
662
}
663
},
664
"required": ["defaultUnitPrice", "dimensionPrices"],
665
"type": "object"
666
},
667
"tier": { "type": "number" },
668
"price": { "type": "number" },
669
"batch": { "type": "number" },
670
"threshold": { "type": "number" },
671
"name": { "type": "string" },
672
"hidden": { "type": "boolean" },
673
"disabledAt": { "nullable": true, "type": "number" },
674
"enabledAt": { "nullable": true, "type": "number" }
675
},
676
"required": ["price", "batch", "threshold", "hidden"],
677
"type": "object"
678
},
679
"dataCacheWrite": {
680
"properties": {
681
"matrix": {
682
"properties": {
683
"defaultUnitPrice": { "type": "string" },
684
"dimensionPrices": {
685
"additionalProperties": { "type": "string" },
686
"type": "object"
687
}
688
},
689
"required": ["defaultUnitPrice", "dimensionPrices"],
690
"type": "object"
691
},
692
"tier": { "type": "number" },
693
"price": { "type": "number" },
694
"batch": { "type": "number" },
695
"threshold": { "type": "number" },
696
"name": { "type": "string" },
697
"hidden": { "type": "boolean" },
698
"disabledAt": { "nullable": true, "type": "number" },
699
"enabledAt": { "nullable": true, "type": "number" }
700
},
701
"required": ["price", "batch", "threshold", "hidden"],
702
"type": "object"
703
},
704
"edgeConfigRead": {
705
"properties": {
706
"matrix": {
707
"properties": {
708
"defaultUnitPrice": { "type": "string" },
709
"dimensionPrices": {
710
"additionalProperties": { "type": "string" },
711
"type": "object"
712
}
713
},
714
"required": ["defaultUnitPrice", "dimensionPrices"],
715
"type": "object"
716
},
717
"tier": { "type": "number" },
718
"price": { "type": "number" },
719
"batch": { "type": "number" },
720
"threshold": { "type": "number" },
721
"name": { "type": "string" },
722
"hidden": { "type": "boolean" },
723
"disabledAt": { "nullable": true, "type": "number" },
724
"enabledAt": { "nullable": true, "type": "number" }
725
},
726
"required": ["price", "batch", "threshold", "hidden"],
727
"type": "object"
728
},
729
"edgeConfigWrite": {
730
"properties": {
731
"matrix": {
732
"properties": {
733
"defaultUnitPrice": { "type": "string" },
734
"dimensionPrices": {
735
"additionalProperties": { "type": "string" },
736
"type": "object"
737
}
738
},
739
"required": ["defaultUnitPrice", "dimensionPrices"],
740
"type": "object"
741
},
742
"tier": { "type": "number" },
743
"price": { "type": "number" },
744
"batch": { "type": "number" },
745
"threshold": { "type": "number" },
746
"name": { "type": "string" },
747
"hidden": { "type": "boolean" },
748
"disabledAt": { "nullable": true, "type": "number" },
749
"enabledAt": { "nullable": true, "type": "number" }
750
},
751
"required": ["price", "batch", "threshold", "hidden"],
752
"type": "object"
753
},
754
"edgeFunctionExecutionUnits": {
755
"properties": {
756
"matrix": {
757
"properties": {
758
"defaultUnitPrice": { "type": "string" },
759
"dimensionPrices": {
760
"additionalProperties": { "type": "string" },
761
"type": "object"
762
}
763
},
764
"required": ["defaultUnitPrice", "dimensionPrices"],
765
"type": "object"
766
},
767
"tier": { "type": "number" },
768
"price": { "type": "number" },
769
"batch": { "type": "number" },
770
"threshold": { "type": "number" },
771
"name": { "type": "string" },
772
"hidden": { "type": "boolean" },
773
"disabledAt": { "nullable": true, "type": "number" },
774
"enabledAt": { "nullable": true, "type": "number" }
775
},
776
"required": ["price", "batch", "threshold", "hidden"],
777
"type": "object"
778
},
779
"edgeMiddlewareInvocations": {
780
"properties": {
781
"matrix": {
782
"properties": {
783
"defaultUnitPrice": { "type": "string" },
784
"dimensionPrices": {
785
"additionalProperties": { "type": "string" },
786
"type": "object"
787
}
788
},
789
"required": ["defaultUnitPrice", "dimensionPrices"],
790
"type": "object"
791
},
792
"tier": { "type": "number" },
793
"price": { "type": "number" },
794
"batch": { "type": "number" },
795
"threshold": { "type": "number" },
796
"name": { "type": "string" },
797
"hidden": { "type": "boolean" },
798
"disabledAt": { "nullable": true, "type": "number" },
799
"enabledAt": { "nullable": true, "type": "number" }
800
},
801
"required": ["price", "batch", "threshold", "hidden"],
802
"type": "object"
803
},
804
"edgeRequest": {
805
"properties": {
806
"matrix": {
807
"properties": {
808
"defaultUnitPrice": { "type": "string" },
809
"dimensionPrices": {
810
"additionalProperties": { "type": "string" },
811
"type": "object"
812
}
813
},
814
"required": ["defaultUnitPrice", "dimensionPrices"],
815
"type": "object"
816
},
817
"tier": { "type": "number" },
818
"price": { "type": "number" },
819
"batch": { "type": "number" },
820
"threshold": { "type": "number" },
821
"name": { "type": "string" },
822
"hidden": { "type": "boolean" },
823
"disabledAt": { "nullable": true, "type": "number" },
824
"enabledAt": { "nullable": true, "type": "number" }
825
},
826
"required": ["price", "batch", "threshold", "hidden"],
827
"type": "object"
828
},
829
"edgeRequestAdditionalCpuDuration": {
830
"properties": {
831
"matrix": {
832
"properties": {
833
"defaultUnitPrice": { "type": "string" },
834
"dimensionPrices": {
835
"additionalProperties": { "type": "string" },
836
"type": "object"
837
}
838
},
839
"required": ["defaultUnitPrice", "dimensionPrices"],
840
"type": "object"
841
},
842
"tier": { "type": "number" },
843
"price": { "type": "number" },
844
"batch": { "type": "number" },
845
"threshold": { "type": "number" },
846
"name": { "type": "string" },
847
"hidden": { "type": "boolean" },
848
"disabledAt": { "nullable": true, "type": "number" },
849
"enabledAt": { "nullable": true, "type": "number" }
850
},
851
"required": ["price", "batch", "threshold", "hidden"],
852
"type": "object"
853
},
854
"fastDataTransfer": {
855
"properties": {
856
"matrix": {
857
"properties": {
858
"defaultUnitPrice": { "type": "string" },
859
"dimensionPrices": {
860
"additionalProperties": { "type": "string" },
861
"type": "object"
862
}
863
},
864
"required": ["defaultUnitPrice", "dimensionPrices"],
865
"type": "object"
866
},
867
"tier": { "type": "number" },
868
"price": { "type": "number" },
869
"batch": { "type": "number" },
870
"threshold": { "type": "number" },
871
"name": { "type": "string" },
872
"hidden": { "type": "boolean" },
873
"disabledAt": { "nullable": true, "type": "number" },
874
"enabledAt": { "nullable": true, "type": "number" }
875
},
876
"required": ["price", "batch", "threshold", "hidden"],
877
"type": "object"
878
},
879
"fastOriginTransfer": {
880
"properties": {
881
"matrix": {
882
"properties": {
883
"defaultUnitPrice": { "type": "string" },
884
"dimensionPrices": {
885
"additionalProperties": { "type": "string" },
886
"type": "object"
887
}
888
},
889
"required": ["defaultUnitPrice", "dimensionPrices"],
890
"type": "object"
891
},
892
"tier": { "type": "number" },
893
"price": { "type": "number" },
894
"batch": { "type": "number" },
895
"threshold": { "type": "number" },
896
"name": { "type": "string" },
897
"hidden": { "type": "boolean" },
898
"disabledAt": { "nullable": true, "type": "number" },
899
"enabledAt": { "nullable": true, "type": "number" }
900
},
901
"required": ["price", "batch", "threshold", "hidden"],
902
"type": "object"
903
},
904
"functionDuration": {
905
"properties": {
906
"matrix": {
907
"properties": {
908
"defaultUnitPrice": { "type": "string" },
909
"dimensionPrices": {
910
"additionalProperties": { "type": "string" },
911
"type": "object"
912
}
913
},
914
"required": ["defaultUnitPrice", "dimensionPrices"],
915
"type": "object"
916
},
917
"tier": { "type": "number" },
918
"price": { "type": "number" },
919
"batch": { "type": "number" },
920
"threshold": { "type": "number" },
921
"name": { "type": "string" },
922
"hidden": { "type": "boolean" },
923
"disabledAt": { "nullable": true, "type": "number" },
924
"enabledAt": { "nullable": true, "type": "number" }
925
},
926
"required": ["price", "batch", "threshold", "hidden"],
927
"type": "object"
928
},
929
"functionInvocation": {
930
"properties": {
931
"matrix": {
932
"properties": {
933
"defaultUnitPrice": { "type": "string" },
934
"dimensionPrices": {
935
"additionalProperties": { "type": "string" },
936
"type": "object"
937
}
938
},
939
"required": ["defaultUnitPrice", "dimensionPrices"],
940
"type": "object"
941
},
942
"tier": { "type": "number" },
943
"price": { "type": "number" },
944
"batch": { "type": "number" },
945
"threshold": { "type": "number" },
946
"name": { "type": "string" },
947
"hidden": { "type": "boolean" },
948
"disabledAt": { "nullable": true, "type": "number" },
949
"enabledAt": { "nullable": true, "type": "number" }
950
},
951
"required": ["price", "batch", "threshold", "hidden"],
952
"type": "object"
953
},
954
"logDrainsVolume": {
955
"properties": {
956
"matrix": {
957
"properties": {
958
"defaultUnitPrice": { "type": "string" },
959
"dimensionPrices": {
960
"additionalProperties": { "type": "string" },
961
"type": "object"
962
}
963
},
964
"required": ["defaultUnitPrice", "dimensionPrices"],
965
"type": "object"
966
},
967
"tier": { "type": "number" },
968
"price": { "type": "number" },
969
"batch": { "type": "number" },
970
"threshold": { "type": "number" },
971
"name": { "type": "string" },
972
"hidden": { "type": "boolean" },
973
"disabledAt": { "nullable": true, "type": "number" },
974
"enabledAt": { "nullable": true, "type": "number" }
975
},
976
"required": ["price", "batch", "threshold", "hidden"],
977
"type": "object"
978
},
979
"monitoringMetric": {
980
"properties": {
981
"matrix": {
982
"properties": {
983
"defaultUnitPrice": { "type": "string" },
984
"dimensionPrices": {
985
"additionalProperties": { "type": "string" },
986
"type": "object"
987
}
988
},
989
"required": ["defaultUnitPrice", "dimensionPrices"],
990
"type": "object"
991
},
992
"tier": { "type": "number" },
993
"price": { "type": "number" },
994
"batch": { "type": "number" },
995
"threshold": { "type": "number" },
996
"name": { "type": "string" },
997
"hidden": { "type": "boolean" },
998
"disabledAt": { "nullable": true, "type": "number" },
999
"enabledAt": { "nullable": true, "type": "number" }
1000
},
1001
"required": ["price", "batch", "threshold", "hidden"],
1002
"type": "object"
1003
},
1004
"postgresComputeTime": {
1005
"properties": {
1006
"matrix": {
1007
"properties": {
1008
"defaultUnitPrice": { "type": "string" },
1009
"dimensionPrices": {
1010
"additionalProperties": { "type": "string" },
1011
"type": "object"
1012
}
1013
},
1014
"required": ["defaultUnitPrice", "dimensionPrices"],
1015
"type": "object"
1016
},
1017
"tier": { "type": "number" },
1018
"price": { "type": "number" },
1019
"batch": { "type": "number" },
1020
"threshold": { "type": "number" },
1021
"name": { "type": "string" },
1022
"hidden": { "type": "boolean" },
1023
"disabledAt": { "nullable": true, "type": "number" },
1024
"enabledAt": { "nullable": true, "type": "number" }
1025
},
1026
"required": ["price", "batch", "threshold", "hidden"],
1027
"type": "object"
1028
},
1029
"postgresDataStorage": {
1030
"properties": {
1031
"matrix": {
1032
"properties": {
1033
"defaultUnitPrice": { "type": "string" },
1034
"dimensionPrices": {
1035
"additionalProperties": { "type": "string" },
1036
"type": "object"
1037
}
1038
},
1039
"required": ["defaultUnitPrice", "dimensionPrices"],
1040
"type": "object"
1041
},
1042
"tier": { "type": "number" },
1043
"price": { "type": "number" },
1044
"batch": { "type": "number" },
1045
"threshold": { "type": "number" },
1046
"name": { "type": "string" },
1047
"hidden": { "type": "boolean" },
1048
"disabledAt": { "nullable": true, "type": "number" },
1049
"enabledAt": { "nullable": true, "type": "number" }
1050
},
1051
"required": ["price", "batch", "threshold", "hidden"],
1052
"type": "object"
1053
},
1054
"postgresDataTransfer": {
1055
"properties": {
1056
"matrix": {
1057
"properties": {
1058
"defaultUnitPrice": { "type": "string" },
1059
"dimensionPrices": {
1060
"additionalProperties": { "type": "string" },
1061
"type": "object"
1062
}
1063
},
1064
"required": ["defaultUnitPrice", "dimensionPrices"],
1065
"type": "object"
1066
},
1067
"tier": { "type": "number" },
1068
"price": { "type": "number" },
1069
"batch": { "type": "number" },
1070
"threshold": { "type": "number" },
1071
"name": { "type": "string" },
1072
"hidden": { "type": "boolean" },
1073
"disabledAt": { "nullable": true, "type": "number" },
1074
"enabledAt": { "nullable": true, "type": "number" }
1075
},
1076
"required": ["price", "batch", "threshold", "hidden"],
1077
"type": "object"
1078
},
1079
"postgresDatabase": {
1080
"properties": {
1081
"matrix": {
1082
"properties": {
1083
"defaultUnitPrice": { "type": "string" },
1084
"dimensionPrices": {
1085
"additionalProperties": { "type": "string" },
1086
"type": "object"
1087
}
1088
},
1089
"required": ["defaultUnitPrice", "dimensionPrices"],
1090
"type": "object"
1091
},
1092
"tier": { "type": "number" },
1093
"price": { "type": "number" },
1094
"batch": { "type": "number" },
1095
"threshold": { "type": "number" },
1096
"name": { "type": "string" },
1097
"hidden": { "type": "boolean" },
1098
"disabledAt": { "nullable": true, "type": "number" },
1099
"enabledAt": { "nullable": true, "type": "number" }
1100
},
1101
"required": ["price", "batch", "threshold", "hidden"],
1102
"type": "object"
1103
},
1104
"postgresWrittenData": {
1105
"properties": {
1106
"matrix": {
1107
"properties": {
1108
"defaultUnitPrice": { "type": "string" },
1109
"dimensionPrices": {
1110
"additionalProperties": { "type": "string" },
1111
"type": "object"
1112
}
1113
},
1114
"required": ["defaultUnitPrice", "dimensionPrices"],
1115
"type": "object"
1116
},
1117
"tier": { "type": "number" },
1118
"price": { "type": "number" },
1119
"batch": { "type": "number" },
1120
"threshold": { "type": "number" },
1121
"name": { "type": "string" },
1122
"hidden": { "type": "boolean" },
1123
"disabledAt": { "nullable": true, "type": "number" },
1124
"enabledAt": { "nullable": true, "type": "number" }
1125
},
1126
"required": ["price", "batch", "threshold", "hidden"],
1127
"type": "object"
1128
},
1129
"serverlessFunctionExecution": {
1130
"properties": {
1131
"matrix": {
1132
"properties": {
1133
"defaultUnitPrice": { "type": "string" },
1134
"dimensionPrices": {
1135
"additionalProperties": { "type": "string" },
1136
"type": "object"
1137
}
1138
},
1139
"required": ["defaultUnitPrice", "dimensionPrices"],
1140
"type": "object"
1141
},
1142
"tier": { "type": "number" },
1143
"price": { "type": "number" },
1144
"batch": { "type": "number" },
1145
"threshold": { "type": "number" },
1146
"name": { "type": "string" },
1147
"hidden": { "type": "boolean" },
1148
"disabledAt": { "nullable": true, "type": "number" },
1149
"enabledAt": { "nullable": true, "type": "number" }
1150
},
1151
"required": ["price", "batch", "threshold", "hidden"],
1152
"type": "object"
1153
},
1154
"sourceImages": {
1155
"properties": {
1156
"matrix": {
1157
"properties": {
1158
"defaultUnitPrice": { "type": "string" },
1159
"dimensionPrices": {
1160
"additionalProperties": { "type": "string" },
1161
"type": "object"
1162
}
1163
},
1164
"required": ["defaultUnitPrice", "dimensionPrices"],
1165
"type": "object"
1166
},
1167
"tier": { "type": "number" },
1168
"price": { "type": "number" },
1169
"batch": { "type": "number" },
1170
"threshold": { "type": "number" },
1171
"name": { "type": "string" },
1172
"hidden": { "type": "boolean" },
1173
"disabledAt": { "nullable": true, "type": "number" },
1174
"enabledAt": { "nullable": true, "type": "number" }
1175
},
1176
"required": ["price", "batch", "threshold", "hidden"],
1177
"type": "object"
1178
},
1179
"storageRedisTotalBandwidthInBytes": {
1180
"properties": {
1181
"matrix": {
1182
"properties": {
1183
"defaultUnitPrice": { "type": "string" },
1184
"dimensionPrices": {
1185
"additionalProperties": { "type": "string" },
1186
"type": "object"
1187
}
1188
},
1189
"required": ["defaultUnitPrice", "dimensionPrices"],
1190
"type": "object"
1191
},
1192
"tier": { "type": "number" },
1193
"price": { "type": "number" },
1194
"batch": { "type": "number" },
1195
"threshold": { "type": "number" },
1196
"name": { "type": "string" },
1197
"hidden": { "type": "boolean" },
1198
"disabledAt": { "nullable": true, "type": "number" },
1199
"enabledAt": { "nullable": true, "type": "number" }
1200
},
1201
"required": ["price", "batch", "threshold", "hidden"],
1202
"type": "object"
1203
},
1204
"storageRedisTotalCommands": {
1205
"properties": {
1206
"matrix": {
1207
"properties": {
1208
"defaultUnitPrice": { "type": "string" },
1209
"dimensionPrices": {
1210
"additionalProperties": { "type": "string" },
1211
"type": "object"
1212
}
1213
},
1214
"required": ["defaultUnitPrice", "dimensionPrices"],
1215
"type": "object"
1216
},
1217
"tier": { "type": "number" },
1218
"price": { "type": "number" },
1219
"batch": { "type": "number" },
1220
"threshold": { "type": "number" },
1221
"name": { "type": "string" },
1222
"hidden": { "type": "boolean" },
1223
"disabledAt": { "nullable": true, "type": "number" },
1224
"enabledAt": { "nullable": true, "type": "number" }
1225
},
1226
"required": ["price", "batch", "threshold", "hidden"],
1227
"type": "object"
1228
},
1229
"storageRedisTotalDailyAvgStorageInBytes": {
1230
"properties": {
1231
"matrix": {
1232
"properties": {
1233
"defaultUnitPrice": { "type": "string" },
1234
"dimensionPrices": {
1235
"additionalProperties": { "type": "string" },
1236
"type": "object"
1237
}
1238
},
1239
"required": ["defaultUnitPrice", "dimensionPrices"],
1240
"type": "object"
1241
},
1242
"tier": { "type": "number" },
1243
"price": { "type": "number" },
1244
"batch": { "type": "number" },
1245
"threshold": { "type": "number" },
1246
"name": { "type": "string" },
1247
"hidden": { "type": "boolean" },
1248
"disabledAt": { "nullable": true, "type": "number" },
1249
"enabledAt": { "nullable": true, "type": "number" }
1250
},
1251
"required": ["price", "batch", "threshold", "hidden"],
1252
"type": "object"
1253
},
1254
"storageRedisTotalDatabases": {
1255
"properties": {
1256
"matrix": {
1257
"properties": {
1258
"defaultUnitPrice": { "type": "string" },
1259
"dimensionPrices": {
1260
"additionalProperties": { "type": "string" },
1261
"type": "object"
1262
}
1263
},
1264
"required": ["defaultUnitPrice", "dimensionPrices"],
1265
"type": "object"
1266
},
1267
"tier": { "type": "number" },
1268
"price": { "type": "number" },
1269
"batch": { "type": "number" },
1270
"threshold": { "type": "number" },
1271
"name": { "type": "string" },
1272
"hidden": { "type": "boolean" },
1273
"disabledAt": { "nullable": true, "type": "number" },
1274
"enabledAt": { "nullable": true, "type": "number" }
1275
},
1276
"required": ["price", "batch", "threshold", "hidden"],
1277
"type": "object"
1278
},
1279
"webAnalyticsEvent": {
1280
"properties": {
1281
"matrix": {
1282
"properties": {
1283
"defaultUnitPrice": { "type": "string" },
1284
"dimensionPrices": {
1285
"additionalProperties": { "type": "string" },
1286
"type": "object"
1287
}
1288
},
1289
"required": ["defaultUnitPrice", "dimensionPrices"],
1290
"type": "object"
1291
},
1292
"tier": { "type": "number" },
1293
"price": { "type": "number" },
1294
"batch": { "type": "number" },
1295
"threshold": { "type": "number" },
1296
"name": { "type": "string" },
1297
"hidden": { "type": "boolean" },
1298
"disabledAt": { "nullable": true, "type": "number" },
1299
"enabledAt": { "nullable": true, "type": "number" }
1300
},
1301
"required": ["price", "batch", "threshold", "hidden"],
1302
"type": "object"
1303
}
1304
},
1305
"type": "object"
1306
},
1307
"invoiceSettings": {
1308
"properties": { "footer": { "type": "string" } },
1309
"type": "object"
1310
},
1311
"subscriptions": {
1312
"nullable": true,
1313
"items": {
1314
"properties": {
1315
"id": { "type": "string" },
1316
"trial": {
1317
"nullable": true,
1318
"properties": {
1319
"start": { "type": "number" },
1320
"end": { "type": "number" }
1321
},
1322
"required": ["start", "end"],
1323
"type": "object"
1324
},
1325
"period": {
1326
"properties": {
1327
"start": { "type": "number" },
1328
"end": { "type": "number" }
1329
},
1330
"required": ["start", "end"],
1331
"type": "object"
1332
},
1333
"frequency": {
1334
"properties": {
1335
"interval": {
1336
"type": "string",
1337
"enum": ["month", "day", "week", "year"]
1338
},
1339
"intervalCount": { "type": "number" }
1340
},
1341
"required": ["interval", "intervalCount"],
1342
"type": "object"
1343
},
1344
"discount": {
1345
"nullable": true,
1346
"properties": {
1347
"id": { "type": "string" },
1348
"coupon": {
1349
"properties": {
1350
"id": { "type": "string" },
1351
"name": { "nullable": true, "type": "string" },
1352
"amountOff": { "nullable": true, "type": "number" },
1353
"percentageOff": { "nullable": true, "type": "number" },
1354
"durationInMonths": {
1355
"nullable": true,
1356
"type": "number"
1357
},
1358
"duration": {
1359
"type": "string",
1360
"enum": ["forever", "repeating", "once"]
1361
}
1362
},
1363
"required": [
1364
"id",
1365
"name",
1366
"amountOff",
1367
"percentageOff",
1368
"durationInMonths",
1369
"duration"
1370
],
1371
"type": "object"
1372
}
1373
},
1374
"required": ["id", "coupon"],
1375
"type": "object"
1376
},
1377
"items": {
1378
"items": {
1379
"properties": {
1380
"id": { "type": "string" },
1381
"priceId": { "type": "string" },
1382
"productId": { "type": "string" },
1383
"amount": { "type": "number" },
1384
"quantity": { "type": "number" }
1385
},
1386
"required": [
1387
"id",
1388
"priceId",
1389
"productId",
1390
"amount",
1391
"quantity"
1392
],
1393
"type": "object"
1394
},
1395
"type": "array"
1396
}
1397
},
1398
"required": [
1399
"id",
1400
"trial",
1401
"period",
1402
"frequency",
1403
"discount",
1404
"items"
1405
],
1406
"type": "object"
1407
},
1408
"type": "array"
1409
},
1410
"controls": {
1411
"nullable": true,
1412
"properties": {
1413
"analyticsSampleRateInPercent": {
1414
"nullable": true,
1415
"type": "number"
1416
},
1417
"analyticsSpendLimitInDollars": {
1418
"nullable": true,
1419
"type": "number"
1420
}
1421
},
1422
"type": "object"
1423
},
1424
"purchaseOrder": { "nullable": true, "type": "string" },
1425
"status": {
1426
"type": "string",
1427
"enum": ["active", "trialing", "overdue", "expired", "canceled"]
1428
},
1429
"pricingExperiment": { "type": "string", "enum": ["august-2022"] },
1430
"orbMigrationScheduledAt": { "nullable": true, "type": "number" }
1431
},
1432
"required": ["period", "plan"],
1433
"type": "object",
1434
"description": "An object containing billing infomation associated with the User account."
1435
},
1436
"resourceConfig": {
1437
"properties": {
1438
"nodeType": {
1439
"type": "string",
1440
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1441
},
1442
"concurrentBuilds": {
1443
"type": "number",
1444
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1445
},
1446
"awsAccountType": {
1447
"type": "string",
1448
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1449
},
1450
"awsAccountIds": {
1451
"items": { "type": "string" },
1452
"type": "array",
1453
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1454
},
1455
"cfZoneName": {
1456
"type": "string",
1457
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1458
},
1459
"edgeConfigs": {
1460
"type": "number",
1461
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1462
},
1463
"edgeConfigSize": {
1464
"type": "number",
1465
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1466
},
1467
"edgeFunctionMaxSizeBytes": {
1468
"type": "number",
1469
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1470
},
1471
"edgeFunctionExecutionTimeoutMs": {
1472
"type": "number",
1473
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1474
},
1475
"serverlessFunctionDefaultMaxExecutionTime": {
1476
"type": "number",
1477
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1478
},
1479
"kvDatabases": {
1480
"type": "number",
1481
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1482
},
1483
"postgresDatabases": {
1484
"type": "number",
1485
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1486
},
1487
"blobStores": {
1488
"type": "number",
1489
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1490
},
1491
"integrationStores": {
1492
"type": "number",
1493
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1494
},
1495
"cronJobs": {
1496
"type": "number",
1497
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1498
},
1499
"cronJobsPerProject": {
1500
"type": "number",
1501
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1502
}
1503
},
1504
"type": "object",
1505
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1506
},
1507
"stagingPrefix": {
1508
"type": "string",
1509
"description": "Prefix that will be used in the URL of \"Preview\" deployments created by the User account."
1510
},
1511
"activeDashboardViews": {
1512
"items": {
1513
"properties": {
1514
"scopeId": { "type": "string" },
1515
"viewPreference": { "type": "string", "enum": ["list", "cards"] },
1516
"favoritesViewPreference": {
1517
"type": "string",
1518
"enum": ["open", "closed"]
1519
},
1520
"recentsViewPreference": {
1521
"type": "string",
1522
"enum": ["open", "closed"]
1523
}
1524
},
1525
"required": ["scopeId"],
1526
"type": "object",
1527
"description": "set of dashboard view preferences (cards or list) per scopeId"
1528
},
1529
"type": "array",
1530
"description": "set of dashboard view preferences (cards or list) per scopeId"
1531
},
1532
"importFlowGitNamespace": {
1533
"nullable": true,
1534
"oneOf": [{ "type": "string" }, { "type": "number" }]
1535
},
1536
"importFlowGitNamespaceId": {
1537
"nullable": true,
1538
"oneOf": [{ "type": "string" }, { "type": "number" }]
1539
},
1540
"importFlowGitProvider": {
1541
"type": "string",
1542
"enum": ["github", "gitlab", "bitbucket"]
1543
},
1544
"preferredScopesAndGitNamespaces": {
1545
"items": {
1546
"properties": {
1547
"scopeId": { "type": "string" },
1548
"gitNamespaceId": {
1549
"nullable": true,
1550
"oneOf": [{ "type": "string" }, { "type": "number" }]
1551
}
1552
},
1553
"required": ["scopeId", "gitNamespaceId"],
1554
"type": "object"
1555
},
1556
"type": "array"
1557
},
1558
"dismissedToasts": {
1559
"items": {
1560
"properties": {
1561
"name": { "type": "string" },
1562
"dismissals": {
1563
"items": {
1564
"properties": {
1565
"scopeId": { "type": "string" },
1566
"createdAt": { "type": "number" }
1567
},
1568
"required": ["scopeId", "createdAt"],
1569
"type": "object"
1570
},
1571
"type": "array"
1572
}
1573
},
1574
"required": ["name", "dismissals"],
1575
"type": "object",
1576
"description": "A record of when, under a certain scopeId, a toast was dismissed"
1577
},
1578
"type": "array",
1579
"description": "A record of when, under a certain scopeId, a toast was dismissed"
1580
},
1581
"favoriteProjectsAndSpaces": {
1582
"items": {
1583
"oneOf": [
1584
{
1585
"properties": {
1586
"projectId": { "type": "string" },
1587
"scopeSlug": { "type": "string" },
1588
"scopeId": { "type": "string" }
1589
},
1590
"required": ["projectId", "scopeSlug", "scopeId"],
1591
"type": "object",
1592
"description": "A list of projects and spaces across teams that a user has marked as a favorite."
1593
},
1594
{
1595
"properties": {
1596
"spaceId": { "type": "string" },
1597
"scopeSlug": { "type": "string" },
1598
"scopeId": { "type": "string" }
1599
},
1600
"required": ["spaceId", "scopeSlug", "scopeId"],
1601
"type": "object",
1602
"description": "A list of projects and spaces across teams that a user has marked as a favorite."
1603
}
1604
]
1605
},
1606
"type": "array",
1607
"description": "A list of projects and spaces across teams that a user has marked as a favorite."
1608
},
1609
"hasTrialAvailable": {
1610
"type": "boolean",
1611
"description": "Whether the user has a trial available for a paid plan subscription."
1612
},
1613
"remoteCaching": {
1614
"properties": { "enabled": { "type": "boolean" } },
1615
"type": "object",
1616
"description": "remote caching settings"
1617
},
1618
"dataCache": {
1619
"properties": { "excessBillingEnabled": { "type": "boolean" } },
1620
"type": "object",
1621
"description": "data cache settings"
1622
},
1623
"featureBlocks": {
1624
"properties": {
1625
"webAnalytics": {
1626
"properties": {
1627
"blockedFrom": { "type": "number" },
1628
"blockedUntil": { "type": "number" },
1629
"isCurrentlyBlocked": { "type": "boolean" }
1630
},
1631
"required": ["isCurrentlyBlocked"],
1632
"type": "object"
1633
}
1634
},
1635
"type": "object",
1636
"description": "Feature blocks for the user"
1637
},
1638
"northstar": {
1639
"properties": {
1640
"migration": {
1641
"properties": {
1642
"teamId": { "type": "string" },
1643
"status": {
1644
"type": "string",
1645
"enum": ["migrating", "completed", "failed", "will-migrate"],
1646
"description": "- `will-migrate`: Show dashboard toast saying \"your account will be migrated soon\" - `migrating`: Show dashboard toast saying \"your account is currently migrating to `teamId`\" - `completed`: Show dashboard toast saying \"your account has been migrated to `teamId`\" - `failed`: Show dashboard toast saying \"your account migration has failed `teamId`\""
1647
}
1648
},
1649
"required": ["status"],
1650
"type": "object"
1651
}
1652
},
1653
"type": "object",
1654
"description": "Northstar migration specific data"
1655
},
1656
"northstarMigration": {
1657
"properties": {
1658
"teamId": {
1659
"type": "string",
1660
"description": "The ID of the team we created for this user."
1661
},
1662
"projects": {
1663
"type": "number",
1664
"description": "The number of projects migrated for this user."
1665
},
1666
"stores": {
1667
"type": "number",
1668
"description": "The number of stores migrated for this user."
1669
},
1670
"integrationConfigurations": {
1671
"type": "number",
1672
"description": "The number of integration configurations migrated for this user."
1673
},
1674
"integrationClients": {
1675
"type": "number",
1676
"description": "The number of integration clients migrated for this user."
1677
},
1678
"startTime": {
1679
"type": "number",
1680
"description": "The migration start time timestamp for this user."
1681
},
1682
"endTime": {
1683
"type": "number",
1684
"description": "The migration end time timestamp for this user."
1685
}
1686
},
1687
"required": [
1688
"teamId",
1689
"projects",
1690
"stores",
1691
"integrationConfigurations",
1692
"integrationClients",
1693
"startTime",
1694
"endTime"
1695
],
1696
"type": "object"
1697
},
1698
"id": {
1699
"type": "string",
1700
"description": "The User's unique identifier.",
1701
"example": "AEIIDYVk59zbFF2Sxfyxxmua"
1702
},
1703
"email": {
1704
"type": "string",
1705
"description": "Email address associated with the User account.",
1706
"example": "me@example.com"
1707
},
1708
"name": {
1709
"nullable": true,
1710
"type": "string",
1711
"description": "Name associated with the User account, or `null` if none has been provided.",
1712
"example": "John Doe"
1713
},
1714
"username": {
1715
"type": "string",
1716
"description": "Unique username associated with the User account.",
1717
"example": "jdoe"
1718
},
1719
"avatar": {
1720
"nullable": true,
1721
"type": "string",
1722
"description": "SHA1 hash of the avatar for the User account. Can be used in conjuction with the ... endpoint to retrieve the avatar image.",
1723
"example": "22cb30c85ff45ac4c72de8981500006b28114aa1"
1724
},
1725
"defaultTeamId": {
1726
"nullable": true,
1727
"type": "string",
1728
"description": "The user's default team. Only applies if the user's `version` is `'northstar'`."
1729
},
1730
"version": {
1731
"nullable": true,
1732
"type": "string",
1733
"enum": ["northstar"],
1734
"description": "The user's version. Will either be unset or `northstar`."
1735
}
1736
},
1737
"required": [
1738
"createdAt",
1739
"softBlock",
1740
"billing",
1741
"resourceConfig",
1742
"stagingPrefix",
1743
"hasTrialAvailable",
1744
"id",
1745
"email",
1746
"name",
1747
"username",
1748
"avatar",
1749
"defaultTeamId",
1750
"version"
1751
],
1752
"type": "object",
1753
"description": "Data for the currently authenticated User."
1754
}

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": "me@example.com"
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
}

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
"status": {
49
"type": "string",
50
"description": "Current status of the connection.",
51
"example": "linked"
52
},
53
"state": {
54
"type": "string",
55
"description": "Current state of the connection.",
56
"example": "active"
57
},
58
"connectedAt": {
59
"type": "number",
60
"description": "Timestamp (in milliseconds) of when the configuration was connected.",
61
"example": 1611796915677
62
},
63
"lastReceivedWebhookEvent": {
64
"type": "number",
65
"description": "Timestamp (in milliseconds) of when the last webhook event was received from WorkOS.",
66
"example": 1611796915677
67
}
68
},
69
"required": ["type", "status", "state", "connectedAt"],
70
"type": "object",
71
"description": "Information for the SAML Single Sign-On configuration."
72
},
73
"enforced": {
74
"type": "boolean",
75
"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."
76
}
77
},
78
"required": ["enforced"],
79
"type": "object",
80
"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."
81
},
82
"id": {
83
"type": "string",
84
"description": "The Team's unique identifier.",
85
"example": "team_nllPyCtREAqxxdyFKbbMDlxd"
86
},
87
"slug": {
88
"type": "string",
89
"description": "The Team's slug, which is unique across the Vercel platform.",
90
"example": "my-team"
91
},
92
"name": {
93
"nullable": true,
94
"type": "string",
95
"description": "Name associated with the Team account, or `null` if none has been provided.",
96
"example": "My Team"
97
},
98
"avatar": {
99
"nullable": true,
100
"type": "string",
101
"description": "The ID of the file used as avatar for this Team.",
102
"example": "6eb07268bcfadd309905ffb1579354084c24655c"
103
},
104
"membership": {
105
"oneOf": [
106
{
107
"properties": {
108
"confirmed": { "type": "boolean" },
109
"confirmedAt": { "type": "number" },
110
"accessRequestedAt": { "type": "number" },
111
"role": {
112
"type": "string",
113
"enum": [
114
"OWNER",
115
"MEMBER",
116
"DEVELOPER",
117
"BILLING",
118
"VIEWER",
119
"CONTRIBUTOR"
120
]
121
},
122
"teamId": { "type": "string" },
123
"uid": { "type": "string" },
124
"createdAt": { "type": "number" },
125
"created": { "type": "number" },
126
"joinedFrom": {
127
"properties": {
128
"origin": {
129
"type": "string",
130
"enum": [
131
"link",
132
"saml",
133
"mail",
134
"import",
135
"teams",
136
"github",
137
"gitlab",
138
"bitbucket",
139
"dsync",
140
"feedback",
141
"organization-teams"
142
]
143
},
144
"commitId": { "type": "string" },
145
"repoId": { "type": "string" },
146
"repoPath": { "type": "string" },
147
"gitUserId": {
148
"oneOf": [{ "type": "string" }, { "type": "number" }]
149
},
150
"gitUserLogin": { "type": "string" },
151
"ssoUserId": { "type": "string" },
152
"ssoConnectedAt": { "type": "number" },
153
"idpUserId": { "type": "string" },
154
"dsyncUserId": { "type": "string" },
155
"dsyncConnectedAt": { "type": "number" }
156
},
157
"required": ["origin"],
158
"type": "object"
159
}
160
},
161
"required": [
162
"confirmed",
163
"confirmedAt",
164
"role",
165
"uid",
166
"createdAt",
167
"created"
168
],
169
"type": "object",
170
"description": "The membership of the authenticated User in relation to the Team."
171
},
172
{
173
"properties": {
174
"confirmed": { "type": "boolean" },
175
"confirmedAt": { "type": "number" },
176
"accessRequestedAt": { "type": "number" },
177
"role": {
178
"type": "string",
179
"enum": [
180
"OWNER",
181
"MEMBER",
182
"DEVELOPER",
183
"BILLING",
184
"VIEWER",
185
"CONTRIBUTOR"
186
]
187
},
188
"teamId": { "type": "string" },
189
"uid": { "type": "string" },
190
"createdAt": { "type": "number" },
191
"created": { "type": "number" },
192
"joinedFrom": {
193
"properties": {
194
"origin": {
195
"type": "string",
196
"enum": [
197
"link",
198
"saml",
199
"mail",
200
"import",
201
"teams",
202
"github",
203
"gitlab",
204
"bitbucket",
205
"dsync",
206
"feedback",
207
"organization-teams"
208
]
209
},
210
"commitId": { "type": "string" },
211
"repoId": { "type": "string" },
212
"repoPath": { "type": "string" },
213
"gitUserId": {
214
"oneOf": [{ "type": "string" }, { "type": "number" }]
215
},
216
"gitUserLogin": { "type": "string" },
217
"ssoUserId": { "type": "string" },
218
"ssoConnectedAt": { "type": "number" },
219
"idpUserId": { "type": "string" },
220
"dsyncUserId": { "type": "string" },
221
"dsyncConnectedAt": { "type": "number" }
222
},
223
"required": ["origin"],
224
"type": "object"
225
}
226
},
227
"required": [
228
"confirmed",
229
"accessRequestedAt",
230
"role",
231
"uid",
232
"createdAt",
233
"created"
234
],
235
"type": "object",
236
"description": "The membership of the authenticated User in relation to the Team."
237
}
238
]
239
},
240
"created": {
241
"type": "string",
242
"description": "Will remain undocumented. Remove in v3 API."
243
},
244
"createdAt": {
245
"type": "number",
246
"description": "UNIX timestamp (in milliseconds) when the Team was created.",
247
"example": 1630748523395
248
}
249
},
250
"required": [
251
"limited",
252
"id",
253
"slug",
254
"name",
255
"avatar",
256
"membership",
257
"created",
258
"createdAt"
259
],
260
"type": "object",
261
"description": "A limited form of data representing a Team, due to the authentication token missing privileges to read the full Team data."
262
}

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
"link",
31
"project_name",
32
"scaling_rules",
33
"env_var_name",
34
"target",
35
"store",
36
"system"
37
],
38
"description": "The type of entity.",
39
"example": "author"
40
},
41
"start": {
42
"type": "number",
43
"description": "The index of where the entity begins within the `text` (inclusive).",
44
"example": 0
45
},
46
"end": {
47
"type": "number",
48
"description": "The index of where the entity ends within the `text` (non-inclusive).",
49
"example": 3
50
}
51
},
52
"required": ["type", "start", "end"],
53
"type": "object",
54
"description": "A list of \"entities\" within the event `text`. Useful for enhancing the displayed text with additional styling and links."
55
},
56
"type": "array",
57
"description": "A list of \"entities\" within the event `text`. Useful for enhancing the displayed text with additional styling and links."
58
},
59
"createdAt": {
60
"type": "number",
61
"description": "Timestamp (in milliseconds) of when the event was generated.",
62
"example": 1632859321020
63
},
64
"user": {
65
"properties": {
66
"avatar": { "type": "string" },
67
"email": { "type": "string" },
68
"slug": { "type": "string" },
69
"uid": { "type": "string" },
70
"username": { "type": "string" }
71
},
72
"required": ["avatar", "email", "uid", "username"],
73
"type": "object",
74
"description": "Metadata for the User who generated the event."
75
},
76
"userId": {
77
"type": "string",
78
"description": "The unique identifier of the User who generated the event.",
79
"example": "zTuNVUXEAvvnNN3IaqinkyMw"
80
}
81
},
82
"required": ["id", "text", "entities", "createdAt", "userId"],
83
"type": "object",
84
"description": "Array of events generated by the User."
85
}
Last updated on May 4, 2024