Vercel REST API Interfaces

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
}

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
}

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