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