@botpress/api 1.71.0 → 1.72.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.js +1947 -191
- package/dist/src/gen/admin/state.d.ts +119 -0
- package/dist/src/gen/billing/state.d.ts +1502 -331
- package/dist/src/gen/state.d.ts +95 -0
- package/package.json +4 -4
package/dist/index.js
CHANGED
|
@@ -279445,7 +279445,7 @@ var state = {
|
|
|
279445
279445
|
"title": "Botpress Runtime API",
|
|
279446
279446
|
"description": "API for Botpress Runtime",
|
|
279447
279447
|
"server": "https://api.botpress.cloud",
|
|
279448
|
-
"version": "1.
|
|
279448
|
+
"version": "1.72.0",
|
|
279449
279449
|
"prefix": "v1"
|
|
279450
279450
|
},
|
|
279451
279451
|
"defaultParameters": {
|
|
@@ -281242,6 +281242,11 @@ var state2 = {
|
|
|
281242
281242
|
"maxLength": 2e3,
|
|
281243
281243
|
"description": "URL of the [Integration](#schema_integration)"
|
|
281244
281244
|
},
|
|
281245
|
+
"signingSecret": {
|
|
281246
|
+
"type": "string",
|
|
281247
|
+
"maxLength": 2e3,
|
|
281248
|
+
"description": "Signing secret of the [Integration](#schema_integration). This field is only visible when creating a new integration or when rotating the signing secret of an existing integration."
|
|
281249
|
+
},
|
|
281245
281250
|
"name": {
|
|
281246
281251
|
"type": "string",
|
|
281247
281252
|
"maxLength": 200,
|
|
@@ -281885,6 +281890,7 @@ var state2 = {
|
|
|
281885
281890
|
"updatedAt",
|
|
281886
281891
|
"identifier",
|
|
281887
281892
|
"url",
|
|
281893
|
+
"signingSecret",
|
|
281888
281894
|
"name",
|
|
281889
281895
|
"version",
|
|
281890
281896
|
"interfaces",
|
|
@@ -282016,6 +282022,11 @@ var state2 = {
|
|
|
282016
282022
|
"maxLength": 2e3,
|
|
282017
282023
|
"description": "URL of the [Integration](#schema_integration)"
|
|
282018
282024
|
},
|
|
282025
|
+
"signingSecret": {
|
|
282026
|
+
"type": "string",
|
|
282027
|
+
"maxLength": 2e3,
|
|
282028
|
+
"description": "Signing secret of the [Integration](#schema_integration). This field is only visible when creating a new integration or when rotating the signing secret of an existing integration."
|
|
282029
|
+
},
|
|
282019
282030
|
"name": {
|
|
282020
282031
|
"type": "string",
|
|
282021
282032
|
"maxLength": 200,
|
|
@@ -282659,6 +282670,7 @@ var state2 = {
|
|
|
282659
282670
|
"updatedAt",
|
|
282660
282671
|
"identifier",
|
|
282661
282672
|
"url",
|
|
282673
|
+
"signingSecret",
|
|
282662
282674
|
"name",
|
|
282663
282675
|
"version",
|
|
282664
282676
|
"interfaces",
|
|
@@ -285316,9 +285328,10 @@ var state2 = {
|
|
|
285316
285328
|
"authentication": {
|
|
285317
285329
|
"type": "string",
|
|
285318
285330
|
"enum": [
|
|
285319
|
-
"iam"
|
|
285331
|
+
"iam",
|
|
285332
|
+
"hmac-sha256"
|
|
285320
285333
|
],
|
|
285321
|
-
"description": "Type of the [Bot](#schema_bot) authentication (`iam`)"
|
|
285334
|
+
"description": "Type of the [Bot](#schema_bot) authentication (`iam` or `hmac-sha256`)"
|
|
285322
285335
|
},
|
|
285323
285336
|
"configuration": {
|
|
285324
285337
|
"type": "object",
|
|
@@ -285795,6 +285808,60 @@ var state2 = {
|
|
|
285795
285808
|
"documented"
|
|
285796
285809
|
]
|
|
285797
285810
|
},
|
|
285811
|
+
"rotateBotSigningSecrets": {
|
|
285812
|
+
"name": "rotateBotSigningSecrets",
|
|
285813
|
+
"description": "Rotate bot signing secrets. This will generate a new signing secret and invalidate the old ones after 24 hours.",
|
|
285814
|
+
"method": "post",
|
|
285815
|
+
"section": "bot",
|
|
285816
|
+
"path": "/v1/admin/bots/{id}/signing-secrets/rotate",
|
|
285817
|
+
"parameters": {
|
|
285818
|
+
"id": {
|
|
285819
|
+
"type": "string",
|
|
285820
|
+
"description": "Bot ID",
|
|
285821
|
+
"in": "path"
|
|
285822
|
+
},
|
|
285823
|
+
"x-workspace-id": {
|
|
285824
|
+
"in": "header",
|
|
285825
|
+
"type": "string",
|
|
285826
|
+
"description": "Workspace ID",
|
|
285827
|
+
"required": true
|
|
285828
|
+
},
|
|
285829
|
+
"x-multiple-integrations": {
|
|
285830
|
+
"in": "header",
|
|
285831
|
+
"type": "string",
|
|
285832
|
+
"description": 'Whether the client supports bots with multiple instances of the same integration. Set to "true" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.',
|
|
285833
|
+
"required": false
|
|
285834
|
+
}
|
|
285835
|
+
},
|
|
285836
|
+
"requestBody": {
|
|
285837
|
+
"description": "Empty body",
|
|
285838
|
+
"schema": {
|
|
285839
|
+
"type": "object",
|
|
285840
|
+
"title": "rotateBotSigningSecretsBody",
|
|
285841
|
+
"additionalProperties": false
|
|
285842
|
+
}
|
|
285843
|
+
},
|
|
285844
|
+
"response": {
|
|
285845
|
+
"description": "Success",
|
|
285846
|
+
"schema": {
|
|
285847
|
+
"type": "object",
|
|
285848
|
+
"properties": {
|
|
285849
|
+
"newSigningSecret": {
|
|
285850
|
+
"type": "string",
|
|
285851
|
+
"description": "The new signing secret that can be used immediately. The old signing secret(s) will continue to work for 24 hours after this operation to allow for a smooth transition."
|
|
285852
|
+
}
|
|
285853
|
+
},
|
|
285854
|
+
"required": [
|
|
285855
|
+
"newSigningSecret"
|
|
285856
|
+
],
|
|
285857
|
+
"title": "rotateBotSigningSecretsResponse",
|
|
285858
|
+
"additionalProperties": false
|
|
285859
|
+
}
|
|
285860
|
+
},
|
|
285861
|
+
"tags": [
|
|
285862
|
+
"experimental"
|
|
285863
|
+
]
|
|
285864
|
+
},
|
|
285798
285865
|
"transferBot": {
|
|
285799
285866
|
"name": "transferBot",
|
|
285800
285867
|
"description": "Transfer bot to another workspace. You need to be a Manager member of the workspace the bot currently belongs to and have permission to create bots in the target workspace.",
|
|
@@ -292080,6 +292147,60 @@ var state2 = {
|
|
|
292080
292147
|
"documented"
|
|
292081
292148
|
]
|
|
292082
292149
|
},
|
|
292150
|
+
"rotateIntegrationSigningSecrets": {
|
|
292151
|
+
"name": "rotateIntegrationSigningSecrets",
|
|
292152
|
+
"description": "Rotate integration signing secrets. This will generate a new signing secret and invalidate the old ones after 24 hours.",
|
|
292153
|
+
"method": "post",
|
|
292154
|
+
"section": "integration",
|
|
292155
|
+
"path": "/v1/admin/integrations/{id}/signing-secrets/rotate",
|
|
292156
|
+
"parameters": {
|
|
292157
|
+
"id": {
|
|
292158
|
+
"type": "string",
|
|
292159
|
+
"description": "Integration Version ID",
|
|
292160
|
+
"in": "path"
|
|
292161
|
+
},
|
|
292162
|
+
"x-workspace-id": {
|
|
292163
|
+
"in": "header",
|
|
292164
|
+
"type": "string",
|
|
292165
|
+
"description": "Workspace ID",
|
|
292166
|
+
"required": true
|
|
292167
|
+
},
|
|
292168
|
+
"x-multiple-integrations": {
|
|
292169
|
+
"in": "header",
|
|
292170
|
+
"type": "string",
|
|
292171
|
+
"description": 'Whether the client supports bots with multiple instances of the same integration. Set to "true" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.',
|
|
292172
|
+
"required": false
|
|
292173
|
+
}
|
|
292174
|
+
},
|
|
292175
|
+
"requestBody": {
|
|
292176
|
+
"description": "Empty body",
|
|
292177
|
+
"schema": {
|
|
292178
|
+
"type": "object",
|
|
292179
|
+
"title": "rotateIntegrationSigningSecretsBody",
|
|
292180
|
+
"additionalProperties": false
|
|
292181
|
+
}
|
|
292182
|
+
},
|
|
292183
|
+
"response": {
|
|
292184
|
+
"description": "Success",
|
|
292185
|
+
"schema": {
|
|
292186
|
+
"type": "object",
|
|
292187
|
+
"properties": {
|
|
292188
|
+
"newSigningSecret": {
|
|
292189
|
+
"type": "string",
|
|
292190
|
+
"description": "The new signing secret that can be used immediately. The old signing secret(s) will continue to work for 24 hours after this operation to allow for a smooth transition."
|
|
292191
|
+
}
|
|
292192
|
+
},
|
|
292193
|
+
"required": [
|
|
292194
|
+
"newSigningSecret"
|
|
292195
|
+
],
|
|
292196
|
+
"title": "rotateIntegrationSigningSecretsResponse",
|
|
292197
|
+
"additionalProperties": false
|
|
292198
|
+
}
|
|
292199
|
+
},
|
|
292200
|
+
"tags": [
|
|
292201
|
+
"experimental"
|
|
292202
|
+
]
|
|
292203
|
+
},
|
|
292083
292204
|
"validateIntegrationUpdate": {
|
|
292084
292205
|
"name": "validateIntegrationUpdate",
|
|
292085
292206
|
"description": "Perform a validation of an integration update request",
|
|
@@ -295871,7 +295992,7 @@ var state2 = {
|
|
|
295871
295992
|
"title": "Botpress Admin API",
|
|
295872
295993
|
"description": "API for Botpress Cloud Manager",
|
|
295873
295994
|
"server": "https://api.botpress.cloud",
|
|
295874
|
-
"version": "1.
|
|
295995
|
+
"version": "1.72.0",
|
|
295875
295996
|
"prefix": "v1"
|
|
295876
295997
|
},
|
|
295877
295998
|
"defaultParameters": {
|
|
@@ -296030,6 +296151,7 @@ var state2 = {
|
|
|
296030
296151
|
"setAccountPreferenceBody": true,
|
|
296031
296152
|
"createBotBody": true,
|
|
296032
296153
|
"updateBotBody": true,
|
|
296154
|
+
"rotateBotSigningSecretsBody": true,
|
|
296033
296155
|
"transferBotBody": true,
|
|
296034
296156
|
"publishFromBotJsonBody": true,
|
|
296035
296157
|
"createBotVersionBody": true,
|
|
@@ -296048,6 +296170,7 @@ var state2 = {
|
|
|
296048
296170
|
"createIntegrationBody": true,
|
|
296049
296171
|
"validateIntegrationCreationBody": true,
|
|
296050
296172
|
"updateIntegrationBody": true,
|
|
296173
|
+
"rotateIntegrationSigningSecretsBody": true,
|
|
296051
296174
|
"validateIntegrationUpdateBody": true,
|
|
296052
296175
|
"requestIntegrationVerificationBody": true,
|
|
296053
296176
|
"createInterfaceBody": true,
|
|
@@ -296080,6 +296203,7 @@ var state2 = {
|
|
|
296080
296203
|
"getPublicInterfaceResponse": true,
|
|
296081
296204
|
"createBotResponse": true,
|
|
296082
296205
|
"updateBotResponse": true,
|
|
296206
|
+
"rotateBotSigningSecretsResponse": true,
|
|
296083
296207
|
"transferBotResponse": true,
|
|
296084
296208
|
"listBotsResponse": true,
|
|
296085
296209
|
"getBotResponse": true,
|
|
@@ -296137,6 +296261,7 @@ var state2 = {
|
|
|
296137
296261
|
"createIntegrationResponse": true,
|
|
296138
296262
|
"validateIntegrationCreationResponse": true,
|
|
296139
296263
|
"updateIntegrationResponse": true,
|
|
296264
|
+
"rotateIntegrationSigningSecretsResponse": true,
|
|
296140
296265
|
"validateIntegrationUpdateResponse": true,
|
|
296141
296266
|
"listIntegrationsResponse": true,
|
|
296142
296267
|
"getIntegrationResponse": true,
|
|
@@ -296207,7 +296332,7 @@ var state2 = {
|
|
|
296207
296332
|
"signingSecret": {
|
|
296208
296333
|
"type": "string",
|
|
296209
296334
|
"maxLength": 2e3,
|
|
296210
|
-
"description": "Signing secret of the [Bot](#schema_bot)"
|
|
296335
|
+
"description": "Signing secret of the [Bot](#schema_bot). This field is only visible when creating a new bot or when rotating the signing secret of an existing bot."
|
|
296211
296336
|
},
|
|
296212
296337
|
"integrations": {
|
|
296213
296338
|
"type": "object",
|
|
@@ -296987,6 +297112,11 @@ var state2 = {
|
|
|
296987
297112
|
"maxLength": 2e3,
|
|
296988
297113
|
"description": "URL of the [Integration](#schema_integration)"
|
|
296989
297114
|
},
|
|
297115
|
+
"signingSecret": {
|
|
297116
|
+
"type": "string",
|
|
297117
|
+
"maxLength": 2e3,
|
|
297118
|
+
"description": "Signing secret of the [Integration](#schema_integration). This field is only visible when creating a new integration or when rotating the signing secret of an existing integration."
|
|
297119
|
+
},
|
|
296990
297120
|
"name": {
|
|
296991
297121
|
"type": "string",
|
|
296992
297122
|
"maxLength": 200,
|
|
@@ -297593,6 +297723,7 @@ var state2 = {
|
|
|
297593
297723
|
"updatedAt",
|
|
297594
297724
|
"identifier",
|
|
297595
297725
|
"url",
|
|
297726
|
+
"signingSecret",
|
|
297596
297727
|
"name",
|
|
297597
297728
|
"version",
|
|
297598
297729
|
"interfaces",
|
|
@@ -298697,6 +298828,7 @@ var state2 = {
|
|
|
298697
298828
|
"operations": [
|
|
298698
298829
|
"createBot",
|
|
298699
298830
|
"updateBot",
|
|
298831
|
+
"rotateBotSigningSecrets",
|
|
298700
298832
|
"transferBot",
|
|
298701
298833
|
"listBots",
|
|
298702
298834
|
"getBot",
|
|
@@ -298738,6 +298870,7 @@ var state2 = {
|
|
|
298738
298870
|
"createIntegration",
|
|
298739
298871
|
"validateIntegrationCreation",
|
|
298740
298872
|
"updateIntegration",
|
|
298873
|
+
"rotateIntegrationSigningSecrets",
|
|
298741
298874
|
"validateIntegrationUpdate",
|
|
298742
298875
|
"listIntegrations",
|
|
298743
298876
|
"getIntegration",
|
|
@@ -301380,7 +301513,7 @@ var state3 = {
|
|
|
301380
301513
|
"title": "Botpress Files API",
|
|
301381
301514
|
"description": "API for Botpress Files",
|
|
301382
301515
|
"server": "https://api.botpress.cloud",
|
|
301383
|
-
"version": "1.
|
|
301516
|
+
"version": "1.72.0",
|
|
301384
301517
|
"prefix": "v1"
|
|
301385
301518
|
},
|
|
301386
301519
|
"defaultParameters": {
|
|
@@ -303676,7 +303809,7 @@ var state4 = {
|
|
|
303676
303809
|
"title": "Botpress Tables API",
|
|
303677
303810
|
"description": "API for Botpress Tables",
|
|
303678
303811
|
"server": "https://api.botpress.cloud",
|
|
303679
|
-
"version": "1.
|
|
303812
|
+
"version": "1.72.0",
|
|
303680
303813
|
"prefix": "v1"
|
|
303681
303814
|
},
|
|
303682
303815
|
"defaultParameters": {
|
|
@@ -308297,6 +308430,11 @@ var state5 = {
|
|
|
308297
308430
|
"maxLength": 2e3,
|
|
308298
308431
|
"description": "URL of the [Integration](#schema_integration)"
|
|
308299
308432
|
},
|
|
308433
|
+
"signingSecret": {
|
|
308434
|
+
"type": "string",
|
|
308435
|
+
"maxLength": 2e3,
|
|
308436
|
+
"description": "Signing secret of the [Integration](#schema_integration). This field is only visible when creating a new integration or when rotating the signing secret of an existing integration."
|
|
308437
|
+
},
|
|
308300
308438
|
"name": {
|
|
308301
308439
|
"type": "string",
|
|
308302
308440
|
"maxLength": 200,
|
|
@@ -308940,6 +309078,7 @@ var state5 = {
|
|
|
308940
309078
|
"updatedAt",
|
|
308941
309079
|
"identifier",
|
|
308942
309080
|
"url",
|
|
309081
|
+
"signingSecret",
|
|
308943
309082
|
"name",
|
|
308944
309083
|
"version",
|
|
308945
309084
|
"interfaces",
|
|
@@ -309065,6 +309204,11 @@ var state5 = {
|
|
|
309065
309204
|
"maxLength": 2e3,
|
|
309066
309205
|
"description": "URL of the [Integration](#schema_integration)"
|
|
309067
309206
|
},
|
|
309207
|
+
"signingSecret": {
|
|
309208
|
+
"type": "string",
|
|
309209
|
+
"maxLength": 2e3,
|
|
309210
|
+
"description": "Signing secret of the [Integration](#schema_integration). This field is only visible when creating a new integration or when rotating the signing secret of an existing integration."
|
|
309211
|
+
},
|
|
309068
309212
|
"name": {
|
|
309069
309213
|
"type": "string",
|
|
309070
309214
|
"maxLength": 200,
|
|
@@ -309708,6 +309852,7 @@ var state5 = {
|
|
|
309708
309852
|
"updatedAt",
|
|
309709
309853
|
"identifier",
|
|
309710
309854
|
"url",
|
|
309855
|
+
"signingSecret",
|
|
309711
309856
|
"name",
|
|
309712
309857
|
"version",
|
|
309713
309858
|
"interfaces",
|
|
@@ -312292,9 +312437,10 @@ var state5 = {
|
|
|
312292
312437
|
"authentication": {
|
|
312293
312438
|
"type": "string",
|
|
312294
312439
|
"enum": [
|
|
312295
|
-
"iam"
|
|
312440
|
+
"iam",
|
|
312441
|
+
"hmac-sha256"
|
|
312296
312442
|
],
|
|
312297
|
-
"description": "Type of the [Bot](#schema_bot) authentication (`iam`)"
|
|
312443
|
+
"description": "Type of the [Bot](#schema_bot) authentication (`iam` or `hmac-sha256`)"
|
|
312298
312444
|
},
|
|
312299
312445
|
"configuration": {
|
|
312300
312446
|
"type": "object",
|
|
@@ -312771,6 +312917,48 @@ var state5 = {
|
|
|
312771
312917
|
"documented"
|
|
312772
312918
|
]
|
|
312773
312919
|
},
|
|
312920
|
+
"rotateBotSigningSecrets": {
|
|
312921
|
+
"name": "rotateBotSigningSecrets",
|
|
312922
|
+
"description": "Rotate bot signing secrets. This will generate a new signing secret and invalidate the old ones after 24 hours.",
|
|
312923
|
+
"method": "post",
|
|
312924
|
+
"section": "bot",
|
|
312925
|
+
"path": "/v1/admin/bots/{id}/signing-secrets/rotate",
|
|
312926
|
+
"parameters": {
|
|
312927
|
+
"id": {
|
|
312928
|
+
"type": "string",
|
|
312929
|
+
"description": "Bot ID",
|
|
312930
|
+
"in": "path"
|
|
312931
|
+
}
|
|
312932
|
+
},
|
|
312933
|
+
"requestBody": {
|
|
312934
|
+
"description": "Empty body",
|
|
312935
|
+
"schema": {
|
|
312936
|
+
"type": "object",
|
|
312937
|
+
"title": "rotateBotSigningSecretsBody",
|
|
312938
|
+
"additionalProperties": false
|
|
312939
|
+
}
|
|
312940
|
+
},
|
|
312941
|
+
"response": {
|
|
312942
|
+
"description": "Success",
|
|
312943
|
+
"schema": {
|
|
312944
|
+
"type": "object",
|
|
312945
|
+
"properties": {
|
|
312946
|
+
"newSigningSecret": {
|
|
312947
|
+
"type": "string",
|
|
312948
|
+
"description": "The new signing secret that can be used immediately. The old signing secret(s) will continue to work for 24 hours after this operation to allow for a smooth transition."
|
|
312949
|
+
}
|
|
312950
|
+
},
|
|
312951
|
+
"required": [
|
|
312952
|
+
"newSigningSecret"
|
|
312953
|
+
],
|
|
312954
|
+
"title": "rotateBotSigningSecretsResponse",
|
|
312955
|
+
"additionalProperties": false
|
|
312956
|
+
}
|
|
312957
|
+
},
|
|
312958
|
+
"tags": [
|
|
312959
|
+
"experimental"
|
|
312960
|
+
]
|
|
312961
|
+
},
|
|
312774
312962
|
"transferBot": {
|
|
312775
312963
|
"name": "transferBot",
|
|
312776
312964
|
"description": "Transfer bot to another workspace. You need to be a Manager member of the workspace the bot currently belongs to and have permission to create bots in the target workspace.",
|
|
@@ -318478,6 +318666,48 @@ var state5 = {
|
|
|
318478
318666
|
"documented"
|
|
318479
318667
|
]
|
|
318480
318668
|
},
|
|
318669
|
+
"rotateIntegrationSigningSecrets": {
|
|
318670
|
+
"name": "rotateIntegrationSigningSecrets",
|
|
318671
|
+
"description": "Rotate integration signing secrets. This will generate a new signing secret and invalidate the old ones after 24 hours.",
|
|
318672
|
+
"method": "post",
|
|
318673
|
+
"section": "integration",
|
|
318674
|
+
"path": "/v1/admin/integrations/{id}/signing-secrets/rotate",
|
|
318675
|
+
"parameters": {
|
|
318676
|
+
"id": {
|
|
318677
|
+
"type": "string",
|
|
318678
|
+
"description": "Integration Version ID",
|
|
318679
|
+
"in": "path"
|
|
318680
|
+
}
|
|
318681
|
+
},
|
|
318682
|
+
"requestBody": {
|
|
318683
|
+
"description": "Empty body",
|
|
318684
|
+
"schema": {
|
|
318685
|
+
"type": "object",
|
|
318686
|
+
"title": "rotateIntegrationSigningSecretsBody",
|
|
318687
|
+
"additionalProperties": false
|
|
318688
|
+
}
|
|
318689
|
+
},
|
|
318690
|
+
"response": {
|
|
318691
|
+
"description": "Success",
|
|
318692
|
+
"schema": {
|
|
318693
|
+
"type": "object",
|
|
318694
|
+
"properties": {
|
|
318695
|
+
"newSigningSecret": {
|
|
318696
|
+
"type": "string",
|
|
318697
|
+
"description": "The new signing secret that can be used immediately. The old signing secret(s) will continue to work for 24 hours after this operation to allow for a smooth transition."
|
|
318698
|
+
}
|
|
318699
|
+
},
|
|
318700
|
+
"required": [
|
|
318701
|
+
"newSigningSecret"
|
|
318702
|
+
],
|
|
318703
|
+
"title": "rotateIntegrationSigningSecretsResponse",
|
|
318704
|
+
"additionalProperties": false
|
|
318705
|
+
}
|
|
318706
|
+
},
|
|
318707
|
+
"tags": [
|
|
318708
|
+
"experimental"
|
|
318709
|
+
]
|
|
318710
|
+
},
|
|
318481
318711
|
"validateIntegrationUpdate": {
|
|
318482
318712
|
"name": "validateIntegrationUpdate",
|
|
318483
318713
|
"description": "Perform a validation of an integration update request",
|
|
@@ -325150,7 +325380,7 @@ var state5 = {
|
|
|
325150
325380
|
"title": "Botpress API",
|
|
325151
325381
|
"description": "API for Botpress Cloud",
|
|
325152
325382
|
"server": "https://api.botpress.cloud",
|
|
325153
|
-
"version": "1.
|
|
325383
|
+
"version": "1.72.0",
|
|
325154
325384
|
"prefix": "v1"
|
|
325155
325385
|
},
|
|
325156
325386
|
"errors": [
|
|
@@ -325321,6 +325551,7 @@ var state5 = {
|
|
|
325321
325551
|
"setAccountPreferenceBody": true,
|
|
325322
325552
|
"createBotBody": true,
|
|
325323
325553
|
"updateBotBody": true,
|
|
325554
|
+
"rotateBotSigningSecretsBody": true,
|
|
325324
325555
|
"transferBotBody": true,
|
|
325325
325556
|
"publishFromBotJsonBody": true,
|
|
325326
325557
|
"createBotVersionBody": true,
|
|
@@ -325339,6 +325570,7 @@ var state5 = {
|
|
|
325339
325570
|
"createIntegrationBody": true,
|
|
325340
325571
|
"validateIntegrationCreationBody": true,
|
|
325341
325572
|
"updateIntegrationBody": true,
|
|
325573
|
+
"rotateIntegrationSigningSecretsBody": true,
|
|
325342
325574
|
"validateIntegrationUpdateBody": true,
|
|
325343
325575
|
"requestIntegrationVerificationBody": true,
|
|
325344
325576
|
"createInterfaceBody": true,
|
|
@@ -325437,6 +325669,7 @@ var state5 = {
|
|
|
325437
325669
|
"getPublicInterfaceResponse": true,
|
|
325438
325670
|
"createBotResponse": true,
|
|
325439
325671
|
"updateBotResponse": true,
|
|
325672
|
+
"rotateBotSigningSecretsResponse": true,
|
|
325440
325673
|
"transferBotResponse": true,
|
|
325441
325674
|
"listBotsResponse": true,
|
|
325442
325675
|
"getBotResponse": true,
|
|
@@ -325494,6 +325727,7 @@ var state5 = {
|
|
|
325494
325727
|
"createIntegrationResponse": true,
|
|
325495
325728
|
"validateIntegrationCreationResponse": true,
|
|
325496
325729
|
"updateIntegrationResponse": true,
|
|
325730
|
+
"rotateIntegrationSigningSecretsResponse": true,
|
|
325497
325731
|
"validateIntegrationUpdateResponse": true,
|
|
325498
325732
|
"listIntegrationsResponse": true,
|
|
325499
325733
|
"getIntegrationResponse": true,
|
|
@@ -325607,7 +325841,7 @@ var state5 = {
|
|
|
325607
325841
|
"signingSecret": {
|
|
325608
325842
|
"type": "string",
|
|
325609
325843
|
"maxLength": 2e3,
|
|
325610
|
-
"description": "Signing secret of the [Bot](#schema_bot)"
|
|
325844
|
+
"description": "Signing secret of the [Bot](#schema_bot). This field is only visible when creating a new bot or when rotating the signing secret of an existing bot."
|
|
325611
325845
|
},
|
|
325612
325846
|
"integrations": {
|
|
325613
325847
|
"type": "object",
|
|
@@ -326387,6 +326621,11 @@ var state5 = {
|
|
|
326387
326621
|
"maxLength": 2e3,
|
|
326388
326622
|
"description": "URL of the [Integration](#schema_integration)"
|
|
326389
326623
|
},
|
|
326624
|
+
"signingSecret": {
|
|
326625
|
+
"type": "string",
|
|
326626
|
+
"maxLength": 2e3,
|
|
326627
|
+
"description": "Signing secret of the [Integration](#schema_integration). This field is only visible when creating a new integration or when rotating the signing secret of an existing integration."
|
|
326628
|
+
},
|
|
326390
326629
|
"name": {
|
|
326391
326630
|
"type": "string",
|
|
326392
326631
|
"maxLength": 200,
|
|
@@ -326993,6 +327232,7 @@ var state5 = {
|
|
|
326993
327232
|
"updatedAt",
|
|
326994
327233
|
"identifier",
|
|
326995
327234
|
"url",
|
|
327235
|
+
"signingSecret",
|
|
326996
327236
|
"name",
|
|
326997
327237
|
"version",
|
|
326998
327238
|
"interfaces",
|
|
@@ -329361,6 +329601,7 @@ var state5 = {
|
|
|
329361
329601
|
"operations": [
|
|
329362
329602
|
"createBot",
|
|
329363
329603
|
"updateBot",
|
|
329604
|
+
"rotateBotSigningSecrets",
|
|
329364
329605
|
"transferBot",
|
|
329365
329606
|
"listBots",
|
|
329366
329607
|
"getBot",
|
|
@@ -329402,6 +329643,7 @@ var state5 = {
|
|
|
329402
329643
|
"createIntegration",
|
|
329403
329644
|
"validateIntegrationCreation",
|
|
329404
329645
|
"updateIntegration",
|
|
329646
|
+
"rotateIntegrationSigningSecrets",
|
|
329405
329647
|
"validateIntegrationUpdate",
|
|
329406
329648
|
"listIntegrations",
|
|
329407
329649
|
"getIntegration",
|
|
@@ -329656,53 +329898,48 @@ var state6 = {
|
|
|
329656
329898
|
"description": {
|
|
329657
329899
|
"type": "string"
|
|
329658
329900
|
},
|
|
329659
|
-
"providerProductId": {
|
|
329660
|
-
"type": "string"
|
|
329661
|
-
},
|
|
329662
329901
|
"prices": {
|
|
329663
329902
|
"type": "object",
|
|
329664
|
-
"
|
|
329665
|
-
"
|
|
329666
|
-
|
|
329667
|
-
"
|
|
329668
|
-
"
|
|
329669
|
-
|
|
329670
|
-
|
|
329671
|
-
"
|
|
329672
|
-
},
|
|
329673
|
-
"currency": {
|
|
329674
|
-
"type": "string",
|
|
329675
|
-
"enum": [
|
|
329676
|
-
"usd"
|
|
329677
|
-
]
|
|
329678
|
-
},
|
|
329679
|
-
"interval": {
|
|
329680
|
-
"type": "string",
|
|
329681
|
-
"enum": [
|
|
329682
|
-
"month",
|
|
329683
|
-
"year"
|
|
329684
|
-
]
|
|
329685
|
-
},
|
|
329686
|
-
"metadata": {
|
|
329687
|
-
"type": "object",
|
|
329688
|
-
"additionalProperties": {
|
|
329903
|
+
"properties": {
|
|
329904
|
+
"month": {
|
|
329905
|
+
"type": "object",
|
|
329906
|
+
"properties": {
|
|
329907
|
+
"amount": {
|
|
329908
|
+
"type": "number"
|
|
329909
|
+
},
|
|
329910
|
+
"currency": {
|
|
329689
329911
|
"type": "string"
|
|
329690
329912
|
}
|
|
329691
|
-
}
|
|
329913
|
+
},
|
|
329914
|
+
"required": [
|
|
329915
|
+
"amount",
|
|
329916
|
+
"currency"
|
|
329917
|
+
],
|
|
329918
|
+
"additionalProperties": false
|
|
329692
329919
|
},
|
|
329693
|
-
"
|
|
329694
|
-
"
|
|
329695
|
-
"
|
|
329696
|
-
|
|
329697
|
-
|
|
329698
|
-
|
|
329699
|
-
|
|
329700
|
-
|
|
329920
|
+
"year": {
|
|
329921
|
+
"type": "object",
|
|
329922
|
+
"properties": {
|
|
329923
|
+
"amount": {
|
|
329924
|
+
"type": "number"
|
|
329925
|
+
},
|
|
329926
|
+
"currency": {
|
|
329927
|
+
"type": "string"
|
|
329928
|
+
}
|
|
329929
|
+
},
|
|
329930
|
+
"required": [
|
|
329931
|
+
"amount",
|
|
329932
|
+
"currency"
|
|
329933
|
+
],
|
|
329934
|
+
"additionalProperties": false
|
|
329935
|
+
}
|
|
329936
|
+
},
|
|
329937
|
+
"additionalProperties": false
|
|
329701
329938
|
},
|
|
329702
329939
|
"features": {
|
|
329703
329940
|
"type": "object",
|
|
329704
329941
|
"additionalProperties": {
|
|
329705
|
-
"
|
|
329942
|
+
"type": "number"
|
|
329706
329943
|
}
|
|
329707
329944
|
},
|
|
329708
329945
|
"metadata": {
|
|
@@ -329716,7 +329953,6 @@ var state6 = {
|
|
|
329716
329953
|
"id",
|
|
329717
329954
|
"name",
|
|
329718
329955
|
"description",
|
|
329719
|
-
"providerProductId",
|
|
329720
329956
|
"prices",
|
|
329721
329957
|
"features"
|
|
329722
329958
|
],
|
|
@@ -329750,52 +329986,45 @@ var state6 = {
|
|
|
329750
329986
|
"description": {
|
|
329751
329987
|
"type": "string"
|
|
329752
329988
|
},
|
|
329753
|
-
"providerProductId": {
|
|
329754
|
-
"type": "string"
|
|
329755
|
-
},
|
|
329756
329989
|
"prices": {
|
|
329757
329990
|
"type": "object",
|
|
329758
|
-
"
|
|
329759
|
-
"
|
|
329760
|
-
|
|
329761
|
-
"
|
|
329762
|
-
"
|
|
329763
|
-
|
|
329764
|
-
|
|
329765
|
-
"
|
|
329766
|
-
},
|
|
329767
|
-
"currency": {
|
|
329768
|
-
"type": "string",
|
|
329769
|
-
"enum": [
|
|
329770
|
-
"usd"
|
|
329771
|
-
]
|
|
329772
|
-
},
|
|
329773
|
-
"interval": {
|
|
329774
|
-
"type": "string",
|
|
329775
|
-
"enum": [
|
|
329776
|
-
"month",
|
|
329777
|
-
"year"
|
|
329778
|
-
]
|
|
329779
|
-
},
|
|
329780
|
-
"metadata": {
|
|
329781
|
-
"type": "object",
|
|
329782
|
-
"additionalProperties": {
|
|
329991
|
+
"properties": {
|
|
329992
|
+
"month": {
|
|
329993
|
+
"type": "object",
|
|
329994
|
+
"properties": {
|
|
329995
|
+
"amount": {
|
|
329996
|
+
"type": "number"
|
|
329997
|
+
},
|
|
329998
|
+
"currency": {
|
|
329783
329999
|
"type": "string"
|
|
329784
330000
|
}
|
|
329785
|
-
}
|
|
330001
|
+
},
|
|
330002
|
+
"required": [
|
|
330003
|
+
"amount",
|
|
330004
|
+
"currency"
|
|
330005
|
+
]
|
|
329786
330006
|
},
|
|
329787
|
-
"
|
|
329788
|
-
"
|
|
329789
|
-
"
|
|
329790
|
-
|
|
329791
|
-
|
|
329792
|
-
|
|
330007
|
+
"year": {
|
|
330008
|
+
"type": "object",
|
|
330009
|
+
"properties": {
|
|
330010
|
+
"amount": {
|
|
330011
|
+
"type": "number"
|
|
330012
|
+
},
|
|
330013
|
+
"currency": {
|
|
330014
|
+
"type": "string"
|
|
330015
|
+
}
|
|
330016
|
+
},
|
|
330017
|
+
"required": [
|
|
330018
|
+
"amount",
|
|
330019
|
+
"currency"
|
|
330020
|
+
]
|
|
330021
|
+
}
|
|
329793
330022
|
}
|
|
329794
330023
|
},
|
|
329795
330024
|
"features": {
|
|
329796
330025
|
"type": "object",
|
|
329797
330026
|
"additionalProperties": {
|
|
329798
|
-
"
|
|
330027
|
+
"type": "number"
|
|
329799
330028
|
}
|
|
329800
330029
|
},
|
|
329801
330030
|
"metadata": {
|
|
@@ -329809,10 +330038,10 @@ var state6 = {
|
|
|
329809
330038
|
"id",
|
|
329810
330039
|
"name",
|
|
329811
330040
|
"description",
|
|
329812
|
-
"providerProductId",
|
|
329813
330041
|
"prices",
|
|
329814
330042
|
"features"
|
|
329815
|
-
]
|
|
330043
|
+
],
|
|
330044
|
+
"title": "getPlanResponse"
|
|
329816
330045
|
},
|
|
329817
330046
|
"title": "listPlansResponse"
|
|
329818
330047
|
}
|
|
@@ -329849,48 +330078,8 @@ var state6 = {
|
|
|
329849
330078
|
"description": {
|
|
329850
330079
|
"type": "string"
|
|
329851
330080
|
},
|
|
329852
|
-
"
|
|
329853
|
-
"type": "
|
|
329854
|
-
},
|
|
329855
|
-
"prices": {
|
|
329856
|
-
"type": "object",
|
|
329857
|
-
"additionalProperties": {
|
|
329858
|
-
"type": "object",
|
|
329859
|
-
"properties": {
|
|
329860
|
-
"providerPriceId": {
|
|
329861
|
-
"type": "string"
|
|
329862
|
-
},
|
|
329863
|
-
"amount": {
|
|
329864
|
-
"type": "number"
|
|
329865
|
-
},
|
|
329866
|
-
"currency": {
|
|
329867
|
-
"type": "string",
|
|
329868
|
-
"enum": [
|
|
329869
|
-
"usd"
|
|
329870
|
-
]
|
|
329871
|
-
},
|
|
329872
|
-
"interval": {
|
|
329873
|
-
"type": "string",
|
|
329874
|
-
"enum": [
|
|
329875
|
-
"month",
|
|
329876
|
-
"year"
|
|
329877
|
-
]
|
|
329878
|
-
},
|
|
329879
|
-
"metadata": {
|
|
329880
|
-
"type": "object",
|
|
329881
|
-
"additionalProperties": {
|
|
329882
|
-
"type": "string"
|
|
329883
|
-
}
|
|
329884
|
-
}
|
|
329885
|
-
},
|
|
329886
|
-
"required": [
|
|
329887
|
-
"providerPriceId",
|
|
329888
|
-
"amount",
|
|
329889
|
-
"currency",
|
|
329890
|
-
"interval"
|
|
329891
|
-
],
|
|
329892
|
-
"additionalProperties": false
|
|
329893
|
-
}
|
|
330081
|
+
"price": {
|
|
330082
|
+
"type": "number"
|
|
329894
330083
|
},
|
|
329895
330084
|
"feature": {
|
|
329896
330085
|
"type": "string",
|
|
@@ -329924,8 +330113,7 @@ var state6 = {
|
|
|
329924
330113
|
"id",
|
|
329925
330114
|
"name",
|
|
329926
330115
|
"description",
|
|
329927
|
-
"
|
|
329928
|
-
"prices",
|
|
330116
|
+
"price",
|
|
329929
330117
|
"feature",
|
|
329930
330118
|
"increment"
|
|
329931
330119
|
],
|
|
@@ -329959,26 +330147,967 @@ var state6 = {
|
|
|
329959
330147
|
"description": {
|
|
329960
330148
|
"type": "string"
|
|
329961
330149
|
},
|
|
329962
|
-
"
|
|
329963
|
-
"type": "
|
|
330150
|
+
"price": {
|
|
330151
|
+
"type": "number"
|
|
329964
330152
|
},
|
|
329965
|
-
"
|
|
330153
|
+
"feature": {
|
|
330154
|
+
"type": "string",
|
|
330155
|
+
"enum": [
|
|
330156
|
+
"human_in_the_loop",
|
|
330157
|
+
"ratelimit",
|
|
330158
|
+
"incoming_messages_events",
|
|
330159
|
+
"integration_spend",
|
|
330160
|
+
"integration_subscription",
|
|
330161
|
+
"table_rows",
|
|
330162
|
+
"bot_count",
|
|
330163
|
+
"always_alive_count",
|
|
330164
|
+
"always_alive_concurrency",
|
|
330165
|
+
"collaborator_count",
|
|
330166
|
+
"file_storage",
|
|
330167
|
+
"vector_db_storage",
|
|
330168
|
+
"saved_versions"
|
|
330169
|
+
]
|
|
330170
|
+
},
|
|
330171
|
+
"increment": {
|
|
330172
|
+
"type": "number"
|
|
330173
|
+
},
|
|
330174
|
+
"metadata": {
|
|
329966
330175
|
"type": "object",
|
|
329967
330176
|
"additionalProperties": {
|
|
330177
|
+
"type": "string"
|
|
330178
|
+
}
|
|
330179
|
+
}
|
|
330180
|
+
},
|
|
330181
|
+
"required": [
|
|
330182
|
+
"id",
|
|
330183
|
+
"name",
|
|
330184
|
+
"description",
|
|
330185
|
+
"price",
|
|
330186
|
+
"feature",
|
|
330187
|
+
"increment"
|
|
330188
|
+
],
|
|
330189
|
+
"title": "getAddonResponse"
|
|
330190
|
+
},
|
|
330191
|
+
"title": "listAddonsResponse"
|
|
330192
|
+
}
|
|
330193
|
+
},
|
|
330194
|
+
"parameters": {}
|
|
330195
|
+
},
|
|
330196
|
+
"getCurrentSubscription": {
|
|
330197
|
+
"name": "getCurrentSubscription",
|
|
330198
|
+
"description": "Get current subscription for a workspace",
|
|
330199
|
+
"method": "get",
|
|
330200
|
+
"path": "/v2/billing/subscriptions/current",
|
|
330201
|
+
"response": {
|
|
330202
|
+
"description": "Current subscription details",
|
|
330203
|
+
"status": 200,
|
|
330204
|
+
"schema": {
|
|
330205
|
+
"type": "object",
|
|
330206
|
+
"properties": {
|
|
330207
|
+
"plan": {
|
|
330208
|
+
"type": "object",
|
|
330209
|
+
"properties": {
|
|
330210
|
+
"current": {
|
|
329968
330211
|
"type": "object",
|
|
329969
330212
|
"properties": {
|
|
329970
|
-
"
|
|
330213
|
+
"status": {
|
|
330214
|
+
"type": "string",
|
|
330215
|
+
"enum": [
|
|
330216
|
+
"active",
|
|
330217
|
+
"canceled",
|
|
330218
|
+
"past_due",
|
|
330219
|
+
"action_required",
|
|
330220
|
+
"grace_period"
|
|
330221
|
+
]
|
|
330222
|
+
},
|
|
330223
|
+
"planId": {
|
|
329971
330224
|
"type": "string"
|
|
329972
330225
|
},
|
|
329973
|
-
"
|
|
330226
|
+
"interval": {
|
|
330227
|
+
"type": "string",
|
|
330228
|
+
"enum": [
|
|
330229
|
+
"month",
|
|
330230
|
+
"year"
|
|
330231
|
+
]
|
|
330232
|
+
},
|
|
330233
|
+
"price": {
|
|
329974
330234
|
"type": "number"
|
|
329975
330235
|
},
|
|
329976
|
-
"
|
|
330236
|
+
"proratedPrice": {
|
|
330237
|
+
"type": "number"
|
|
330238
|
+
},
|
|
330239
|
+
"cancelAtPeriodEnd": {
|
|
330240
|
+
"type": "boolean"
|
|
330241
|
+
},
|
|
330242
|
+
"periodEnd": {
|
|
330243
|
+
"type": "string"
|
|
330244
|
+
}
|
|
330245
|
+
},
|
|
330246
|
+
"required": [
|
|
330247
|
+
"status",
|
|
330248
|
+
"planId",
|
|
330249
|
+
"interval",
|
|
330250
|
+
"price",
|
|
330251
|
+
"cancelAtPeriodEnd",
|
|
330252
|
+
"periodEnd"
|
|
330253
|
+
],
|
|
330254
|
+
"additionalProperties": false
|
|
330255
|
+
},
|
|
330256
|
+
"next": {
|
|
330257
|
+
"type": "object",
|
|
330258
|
+
"properties": {
|
|
330259
|
+
"planId": {
|
|
330260
|
+
"type": "string"
|
|
330261
|
+
},
|
|
330262
|
+
"interval": {
|
|
330263
|
+
"type": "string",
|
|
330264
|
+
"enum": [
|
|
330265
|
+
"month",
|
|
330266
|
+
"year"
|
|
330267
|
+
]
|
|
330268
|
+
},
|
|
330269
|
+
"price": {
|
|
330270
|
+
"type": "number",
|
|
330271
|
+
"nullable": true
|
|
330272
|
+
},
|
|
330273
|
+
"effectiveDate": {
|
|
330274
|
+
"type": "string"
|
|
330275
|
+
}
|
|
330276
|
+
},
|
|
330277
|
+
"required": [
|
|
330278
|
+
"planId",
|
|
330279
|
+
"interval",
|
|
330280
|
+
"price",
|
|
330281
|
+
"effectiveDate"
|
|
330282
|
+
],
|
|
330283
|
+
"nullable": true,
|
|
330284
|
+
"additionalProperties": false
|
|
330285
|
+
}
|
|
330286
|
+
},
|
|
330287
|
+
"required": [
|
|
330288
|
+
"current",
|
|
330289
|
+
"next"
|
|
330290
|
+
],
|
|
330291
|
+
"additionalProperties": false
|
|
330292
|
+
},
|
|
330293
|
+
"addons": {
|
|
330294
|
+
"type": "object",
|
|
330295
|
+
"additionalProperties": {
|
|
330296
|
+
"type": "object",
|
|
330297
|
+
"properties": {
|
|
330298
|
+
"current": {
|
|
330299
|
+
"type": "object",
|
|
330300
|
+
"properties": {
|
|
330301
|
+
"quantity": {
|
|
330302
|
+
"type": "number"
|
|
330303
|
+
},
|
|
330304
|
+
"price": {
|
|
330305
|
+
"type": "number"
|
|
330306
|
+
},
|
|
330307
|
+
"proratedPrice": {
|
|
330308
|
+
"type": "number"
|
|
330309
|
+
}
|
|
330310
|
+
},
|
|
330311
|
+
"required": [
|
|
330312
|
+
"quantity",
|
|
330313
|
+
"price"
|
|
330314
|
+
],
|
|
330315
|
+
"additionalProperties": false
|
|
330316
|
+
},
|
|
330317
|
+
"next": {
|
|
330318
|
+
"type": "object",
|
|
330319
|
+
"properties": {
|
|
330320
|
+
"quantity": {
|
|
330321
|
+
"type": "number"
|
|
330322
|
+
},
|
|
330323
|
+
"price": {
|
|
330324
|
+
"type": "number"
|
|
330325
|
+
},
|
|
330326
|
+
"effectiveDate": {
|
|
330327
|
+
"type": "string"
|
|
330328
|
+
}
|
|
330329
|
+
},
|
|
330330
|
+
"required": [
|
|
330331
|
+
"quantity",
|
|
330332
|
+
"price",
|
|
330333
|
+
"effectiveDate"
|
|
330334
|
+
],
|
|
330335
|
+
"nullable": true,
|
|
330336
|
+
"additionalProperties": false
|
|
330337
|
+
}
|
|
330338
|
+
},
|
|
330339
|
+
"required": [
|
|
330340
|
+
"current",
|
|
330341
|
+
"next"
|
|
330342
|
+
],
|
|
330343
|
+
"additionalProperties": false
|
|
330344
|
+
}
|
|
330345
|
+
}
|
|
330346
|
+
},
|
|
330347
|
+
"required": [
|
|
330348
|
+
"plan",
|
|
330349
|
+
"addons"
|
|
330350
|
+
],
|
|
330351
|
+
"title": "getCurrentSubscriptionResponse",
|
|
330352
|
+
"additionalProperties": false
|
|
330353
|
+
}
|
|
330354
|
+
},
|
|
330355
|
+
"parameters": {
|
|
330356
|
+
"x-workspace-id": {
|
|
330357
|
+
"in": "header",
|
|
330358
|
+
"type": "string",
|
|
330359
|
+
"description": "Workspace ID",
|
|
330360
|
+
"required": true
|
|
330361
|
+
}
|
|
330362
|
+
}
|
|
330363
|
+
},
|
|
330364
|
+
"getNextSubscription": {
|
|
330365
|
+
"name": "getNextSubscription",
|
|
330366
|
+
"description": "Get next subscription details for a workspace",
|
|
330367
|
+
"method": "get",
|
|
330368
|
+
"path": "/v2/billing/subscriptions/next",
|
|
330369
|
+
"response": {
|
|
330370
|
+
"description": "Next subscription details",
|
|
330371
|
+
"status": 200,
|
|
330372
|
+
"schema": {
|
|
330373
|
+
"type": "object",
|
|
330374
|
+
"properties": {
|
|
330375
|
+
"plan": {
|
|
330376
|
+
"type": "object",
|
|
330377
|
+
"properties": {
|
|
330378
|
+
"current": {
|
|
330379
|
+
"type": "object",
|
|
330380
|
+
"properties": {
|
|
330381
|
+
"status": {
|
|
330382
|
+
"type": "string",
|
|
330383
|
+
"enum": [
|
|
330384
|
+
"active",
|
|
330385
|
+
"canceled",
|
|
330386
|
+
"past_due",
|
|
330387
|
+
"action_required",
|
|
330388
|
+
"grace_period"
|
|
330389
|
+
]
|
|
330390
|
+
},
|
|
330391
|
+
"planId": {
|
|
330392
|
+
"type": "string"
|
|
330393
|
+
},
|
|
330394
|
+
"interval": {
|
|
330395
|
+
"type": "string",
|
|
330396
|
+
"enum": [
|
|
330397
|
+
"month",
|
|
330398
|
+
"year"
|
|
330399
|
+
]
|
|
330400
|
+
},
|
|
330401
|
+
"price": {
|
|
330402
|
+
"type": "number"
|
|
330403
|
+
},
|
|
330404
|
+
"proratedPrice": {
|
|
330405
|
+
"type": "number"
|
|
330406
|
+
},
|
|
330407
|
+
"cancelAtPeriodEnd": {
|
|
330408
|
+
"type": "boolean"
|
|
330409
|
+
},
|
|
330410
|
+
"periodEnd": {
|
|
330411
|
+
"type": "string"
|
|
330412
|
+
}
|
|
330413
|
+
},
|
|
330414
|
+
"required": [
|
|
330415
|
+
"status",
|
|
330416
|
+
"planId",
|
|
330417
|
+
"interval",
|
|
330418
|
+
"price",
|
|
330419
|
+
"cancelAtPeriodEnd",
|
|
330420
|
+
"periodEnd"
|
|
330421
|
+
],
|
|
330422
|
+
"additionalProperties": false
|
|
330423
|
+
},
|
|
330424
|
+
"next": {
|
|
330425
|
+
"type": "object",
|
|
330426
|
+
"properties": {
|
|
330427
|
+
"planId": {
|
|
330428
|
+
"type": "string"
|
|
330429
|
+
},
|
|
330430
|
+
"interval": {
|
|
329977
330431
|
"type": "string",
|
|
329978
330432
|
"enum": [
|
|
329979
|
-
"
|
|
330433
|
+
"month",
|
|
330434
|
+
"year"
|
|
329980
330435
|
]
|
|
329981
330436
|
},
|
|
330437
|
+
"price": {
|
|
330438
|
+
"type": "number",
|
|
330439
|
+
"nullable": true
|
|
330440
|
+
},
|
|
330441
|
+
"effectiveDate": {
|
|
330442
|
+
"type": "string"
|
|
330443
|
+
}
|
|
330444
|
+
},
|
|
330445
|
+
"required": [
|
|
330446
|
+
"planId",
|
|
330447
|
+
"interval",
|
|
330448
|
+
"price",
|
|
330449
|
+
"effectiveDate"
|
|
330450
|
+
],
|
|
330451
|
+
"nullable": true,
|
|
330452
|
+
"additionalProperties": false
|
|
330453
|
+
}
|
|
330454
|
+
},
|
|
330455
|
+
"required": [
|
|
330456
|
+
"current",
|
|
330457
|
+
"next"
|
|
330458
|
+
],
|
|
330459
|
+
"additionalProperties": false
|
|
330460
|
+
},
|
|
330461
|
+
"addons": {
|
|
330462
|
+
"type": "object",
|
|
330463
|
+
"additionalProperties": {
|
|
330464
|
+
"type": "object",
|
|
330465
|
+
"properties": {
|
|
330466
|
+
"current": {
|
|
330467
|
+
"type": "object",
|
|
330468
|
+
"properties": {
|
|
330469
|
+
"quantity": {
|
|
330470
|
+
"type": "number"
|
|
330471
|
+
},
|
|
330472
|
+
"price": {
|
|
330473
|
+
"type": "number"
|
|
330474
|
+
},
|
|
330475
|
+
"proratedPrice": {
|
|
330476
|
+
"type": "number"
|
|
330477
|
+
}
|
|
330478
|
+
},
|
|
330479
|
+
"required": [
|
|
330480
|
+
"quantity",
|
|
330481
|
+
"price"
|
|
330482
|
+
],
|
|
330483
|
+
"additionalProperties": false
|
|
330484
|
+
},
|
|
330485
|
+
"next": {
|
|
330486
|
+
"type": "object",
|
|
330487
|
+
"properties": {
|
|
330488
|
+
"quantity": {
|
|
330489
|
+
"type": "number"
|
|
330490
|
+
},
|
|
330491
|
+
"price": {
|
|
330492
|
+
"type": "number"
|
|
330493
|
+
},
|
|
330494
|
+
"effectiveDate": {
|
|
330495
|
+
"type": "string"
|
|
330496
|
+
}
|
|
330497
|
+
},
|
|
330498
|
+
"required": [
|
|
330499
|
+
"quantity",
|
|
330500
|
+
"price",
|
|
330501
|
+
"effectiveDate"
|
|
330502
|
+
],
|
|
330503
|
+
"nullable": true,
|
|
330504
|
+
"additionalProperties": false
|
|
330505
|
+
}
|
|
330506
|
+
},
|
|
330507
|
+
"required": [
|
|
330508
|
+
"current",
|
|
330509
|
+
"next"
|
|
330510
|
+
],
|
|
330511
|
+
"additionalProperties": false
|
|
330512
|
+
}
|
|
330513
|
+
}
|
|
330514
|
+
},
|
|
330515
|
+
"required": [
|
|
330516
|
+
"plan",
|
|
330517
|
+
"addons"
|
|
330518
|
+
],
|
|
330519
|
+
"title": "getNextSubscriptionResponse",
|
|
330520
|
+
"additionalProperties": false
|
|
330521
|
+
}
|
|
330522
|
+
},
|
|
330523
|
+
"parameters": {
|
|
330524
|
+
"x-workspace-id": {
|
|
330525
|
+
"in": "header",
|
|
330526
|
+
"type": "string",
|
|
330527
|
+
"description": "Workspace ID",
|
|
330528
|
+
"required": true
|
|
330529
|
+
}
|
|
330530
|
+
}
|
|
330531
|
+
},
|
|
330532
|
+
"previewSubscriptionUpdate": {
|
|
330533
|
+
"name": "previewSubscriptionUpdate",
|
|
330534
|
+
"description": "Preview subscription update costs (dry run)",
|
|
330535
|
+
"method": "post",
|
|
330536
|
+
"path": "/v2/billing/subscriptions/preview",
|
|
330537
|
+
"requestBody": {
|
|
330538
|
+
"description": "Subscription update parameters to preview",
|
|
330539
|
+
"schema": {
|
|
330540
|
+
"type": "object",
|
|
330541
|
+
"properties": {
|
|
330542
|
+
"plan": {
|
|
330543
|
+
"type": "object",
|
|
330544
|
+
"properties": {
|
|
330545
|
+
"planId": {
|
|
330546
|
+
"type": "string",
|
|
330547
|
+
"description": "New plan ID (optional)"
|
|
330548
|
+
},
|
|
330549
|
+
"interval": {
|
|
330550
|
+
"type": "string",
|
|
330551
|
+
"enum": [
|
|
330552
|
+
"month",
|
|
330553
|
+
"year"
|
|
330554
|
+
],
|
|
330555
|
+
"description": "New billing interval (optional)"
|
|
330556
|
+
}
|
|
330557
|
+
},
|
|
330558
|
+
"required": [
|
|
330559
|
+
"planId",
|
|
330560
|
+
"interval"
|
|
330561
|
+
],
|
|
330562
|
+
"additionalProperties": false
|
|
330563
|
+
},
|
|
330564
|
+
"addons": {
|
|
330565
|
+
"type": "object",
|
|
330566
|
+
"additionalProperties": {
|
|
330567
|
+
"type": "number"
|
|
330568
|
+
},
|
|
330569
|
+
"description": "Map of addon IDs to quantities (optional). Set quantity to 0 to remove addon."
|
|
330570
|
+
}
|
|
330571
|
+
},
|
|
330572
|
+
"required": [
|
|
330573
|
+
"plan"
|
|
330574
|
+
],
|
|
330575
|
+
"title": "previewSubscriptionUpdateBody",
|
|
330576
|
+
"additionalProperties": false
|
|
330577
|
+
}
|
|
330578
|
+
},
|
|
330579
|
+
"response": {
|
|
330580
|
+
"description": "Preview of subscription update costs",
|
|
330581
|
+
"status": 200,
|
|
330582
|
+
"schema": {
|
|
330583
|
+
"type": "object",
|
|
330584
|
+
"properties": {
|
|
330585
|
+
"subscription": {
|
|
330586
|
+
"type": "object",
|
|
330587
|
+
"properties": {
|
|
330588
|
+
"plan": {
|
|
330589
|
+
"type": "object",
|
|
330590
|
+
"properties": {
|
|
330591
|
+
"planId": {
|
|
330592
|
+
"type": "string"
|
|
330593
|
+
},
|
|
330594
|
+
"interval": {
|
|
330595
|
+
"type": "string",
|
|
330596
|
+
"enum": [
|
|
330597
|
+
"month",
|
|
330598
|
+
"year"
|
|
330599
|
+
]
|
|
330600
|
+
},
|
|
330601
|
+
"effectiveDate": {
|
|
330602
|
+
"type": "string"
|
|
330603
|
+
}
|
|
330604
|
+
},
|
|
330605
|
+
"required": [
|
|
330606
|
+
"planId",
|
|
330607
|
+
"interval",
|
|
330608
|
+
"effectiveDate"
|
|
330609
|
+
],
|
|
330610
|
+
"additionalProperties": false
|
|
330611
|
+
},
|
|
330612
|
+
"addons": {
|
|
330613
|
+
"type": "object",
|
|
330614
|
+
"additionalProperties": {
|
|
330615
|
+
"type": "object",
|
|
330616
|
+
"properties": {
|
|
330617
|
+
"quantity": {
|
|
330618
|
+
"type": "number"
|
|
330619
|
+
},
|
|
330620
|
+
"effectiveDate": {
|
|
330621
|
+
"type": "string"
|
|
330622
|
+
}
|
|
330623
|
+
},
|
|
330624
|
+
"required": [
|
|
330625
|
+
"quantity",
|
|
330626
|
+
"effectiveDate"
|
|
330627
|
+
],
|
|
330628
|
+
"additionalProperties": false
|
|
330629
|
+
}
|
|
330630
|
+
}
|
|
330631
|
+
},
|
|
330632
|
+
"required": [
|
|
330633
|
+
"plan",
|
|
330634
|
+
"addons"
|
|
330635
|
+
],
|
|
330636
|
+
"additionalProperties": false
|
|
330637
|
+
},
|
|
330638
|
+
"changeType": {
|
|
330639
|
+
"type": "string",
|
|
330640
|
+
"enum": [
|
|
330641
|
+
"upgrade",
|
|
330642
|
+
"downgrade",
|
|
330643
|
+
"same"
|
|
330644
|
+
]
|
|
330645
|
+
},
|
|
330646
|
+
"costs": {
|
|
330647
|
+
"type": "object",
|
|
330648
|
+
"properties": {
|
|
330649
|
+
"immediate": {
|
|
330650
|
+
"type": "object",
|
|
330651
|
+
"properties": {
|
|
330652
|
+
"total": {
|
|
330653
|
+
"type": "number"
|
|
330654
|
+
},
|
|
330655
|
+
"lineItems": {
|
|
330656
|
+
"type": "array",
|
|
330657
|
+
"items": {
|
|
330658
|
+
"type": "object",
|
|
330659
|
+
"properties": {
|
|
330660
|
+
"type": {
|
|
330661
|
+
"type": "string",
|
|
330662
|
+
"enum": [
|
|
330663
|
+
"plan",
|
|
330664
|
+
"addon",
|
|
330665
|
+
"proration_credit"
|
|
330666
|
+
]
|
|
330667
|
+
},
|
|
330668
|
+
"id": {
|
|
330669
|
+
"type": "string"
|
|
330670
|
+
},
|
|
330671
|
+
"description": {
|
|
330672
|
+
"type": "string"
|
|
330673
|
+
},
|
|
330674
|
+
"amount": {
|
|
330675
|
+
"type": "number"
|
|
330676
|
+
},
|
|
330677
|
+
"quantity": {
|
|
330678
|
+
"type": "number"
|
|
330679
|
+
}
|
|
330680
|
+
},
|
|
330681
|
+
"required": [
|
|
330682
|
+
"type",
|
|
330683
|
+
"id",
|
|
330684
|
+
"description",
|
|
330685
|
+
"amount"
|
|
330686
|
+
],
|
|
330687
|
+
"description": "A line item in the cost breakdown"
|
|
330688
|
+
}
|
|
330689
|
+
}
|
|
330690
|
+
},
|
|
330691
|
+
"required": [
|
|
330692
|
+
"total",
|
|
330693
|
+
"lineItems"
|
|
330694
|
+
],
|
|
330695
|
+
"description": "Prorated charges due immediately (0 for downgrades)",
|
|
330696
|
+
"additionalProperties": false
|
|
330697
|
+
},
|
|
330698
|
+
"monthly": {
|
|
330699
|
+
"type": "object",
|
|
330700
|
+
"properties": {
|
|
330701
|
+
"total": {
|
|
330702
|
+
"type": "number"
|
|
330703
|
+
},
|
|
330704
|
+
"lineItems": {
|
|
330705
|
+
"type": "array",
|
|
330706
|
+
"items": {
|
|
330707
|
+
"type": "object",
|
|
330708
|
+
"properties": {
|
|
330709
|
+
"type": {
|
|
330710
|
+
"type": "string",
|
|
330711
|
+
"enum": [
|
|
330712
|
+
"plan",
|
|
330713
|
+
"addon",
|
|
330714
|
+
"proration_credit"
|
|
330715
|
+
]
|
|
330716
|
+
},
|
|
330717
|
+
"id": {
|
|
330718
|
+
"type": "string"
|
|
330719
|
+
},
|
|
330720
|
+
"description": {
|
|
330721
|
+
"type": "string"
|
|
330722
|
+
},
|
|
330723
|
+
"amount": {
|
|
330724
|
+
"type": "number"
|
|
330725
|
+
},
|
|
330726
|
+
"quantity": {
|
|
330727
|
+
"type": "number"
|
|
330728
|
+
}
|
|
330729
|
+
},
|
|
330730
|
+
"required": [
|
|
330731
|
+
"type",
|
|
330732
|
+
"id",
|
|
330733
|
+
"description",
|
|
330734
|
+
"amount"
|
|
330735
|
+
],
|
|
330736
|
+
"description": "A line item in the cost breakdown"
|
|
330737
|
+
}
|
|
330738
|
+
}
|
|
330739
|
+
},
|
|
330740
|
+
"required": [
|
|
330741
|
+
"total",
|
|
330742
|
+
"lineItems"
|
|
330743
|
+
],
|
|
330744
|
+
"description": "Monthly recurring cost (addons, or plan if monthly interval)",
|
|
330745
|
+
"additionalProperties": false
|
|
330746
|
+
},
|
|
330747
|
+
"yearly": {
|
|
330748
|
+
"type": "object",
|
|
330749
|
+
"properties": {
|
|
330750
|
+
"total": {
|
|
330751
|
+
"type": "number"
|
|
330752
|
+
},
|
|
330753
|
+
"lineItems": {
|
|
330754
|
+
"type": "array",
|
|
330755
|
+
"items": {
|
|
330756
|
+
"type": "object",
|
|
330757
|
+
"properties": {
|
|
330758
|
+
"type": {
|
|
330759
|
+
"type": "string",
|
|
330760
|
+
"enum": [
|
|
330761
|
+
"plan",
|
|
330762
|
+
"addon",
|
|
330763
|
+
"proration_credit"
|
|
330764
|
+
]
|
|
330765
|
+
},
|
|
330766
|
+
"id": {
|
|
330767
|
+
"type": "string"
|
|
330768
|
+
},
|
|
330769
|
+
"description": {
|
|
330770
|
+
"type": "string"
|
|
330771
|
+
},
|
|
330772
|
+
"amount": {
|
|
330773
|
+
"type": "number"
|
|
330774
|
+
},
|
|
330775
|
+
"quantity": {
|
|
330776
|
+
"type": "number"
|
|
330777
|
+
}
|
|
330778
|
+
},
|
|
330779
|
+
"required": [
|
|
330780
|
+
"type",
|
|
330781
|
+
"id",
|
|
330782
|
+
"description",
|
|
330783
|
+
"amount"
|
|
330784
|
+
],
|
|
330785
|
+
"description": "A line item in the cost breakdown"
|
|
330786
|
+
}
|
|
330787
|
+
}
|
|
330788
|
+
},
|
|
330789
|
+
"required": [
|
|
330790
|
+
"total",
|
|
330791
|
+
"lineItems"
|
|
330792
|
+
],
|
|
330793
|
+
"description": "Yearly recurring cost (plan if yearly interval)",
|
|
330794
|
+
"additionalProperties": false
|
|
330795
|
+
}
|
|
330796
|
+
},
|
|
330797
|
+
"required": [
|
|
330798
|
+
"immediate",
|
|
330799
|
+
"monthly",
|
|
330800
|
+
"yearly"
|
|
330801
|
+
],
|
|
330802
|
+
"additionalProperties": false
|
|
330803
|
+
},
|
|
330804
|
+
"currentPeriodEnd": {
|
|
330805
|
+
"type": "string"
|
|
330806
|
+
}
|
|
330807
|
+
},
|
|
330808
|
+
"required": [
|
|
330809
|
+
"subscription",
|
|
330810
|
+
"changeType",
|
|
330811
|
+
"costs",
|
|
330812
|
+
"currentPeriodEnd"
|
|
330813
|
+
],
|
|
330814
|
+
"description": "Preview of subscription update costs",
|
|
330815
|
+
"title": "previewSubscriptionUpdateResponse",
|
|
330816
|
+
"additionalProperties": false
|
|
330817
|
+
}
|
|
330818
|
+
},
|
|
330819
|
+
"parameters": {
|
|
330820
|
+
"x-workspace-id": {
|
|
330821
|
+
"in": "header",
|
|
330822
|
+
"type": "string",
|
|
330823
|
+
"description": "Workspace ID",
|
|
330824
|
+
"required": true
|
|
330825
|
+
}
|
|
330826
|
+
}
|
|
330827
|
+
},
|
|
330828
|
+
"setPlan": {
|
|
330829
|
+
"name": "setPlan",
|
|
330830
|
+
"description": "Update the plan for a workspace subscription",
|
|
330831
|
+
"method": "put",
|
|
330832
|
+
"path": "/v2/billing/plans",
|
|
330833
|
+
"requestBody": {
|
|
330834
|
+
"description": "Plan update parameters",
|
|
330835
|
+
"schema": {
|
|
330836
|
+
"type": "object",
|
|
330837
|
+
"properties": {
|
|
330838
|
+
"planId": {
|
|
330839
|
+
"type": "string"
|
|
330840
|
+
},
|
|
330841
|
+
"interval": {
|
|
330842
|
+
"type": "string",
|
|
330843
|
+
"enum": [
|
|
330844
|
+
"month",
|
|
330845
|
+
"year"
|
|
330846
|
+
]
|
|
330847
|
+
},
|
|
330848
|
+
"testReferenceTime": {
|
|
330849
|
+
"type": "number"
|
|
330850
|
+
}
|
|
330851
|
+
},
|
|
330852
|
+
"required": [
|
|
330853
|
+
"planId",
|
|
330854
|
+
"interval"
|
|
330855
|
+
],
|
|
330856
|
+
"description": "Plan update parameters",
|
|
330857
|
+
"title": "setPlanBody",
|
|
330858
|
+
"additionalProperties": false
|
|
330859
|
+
}
|
|
330860
|
+
},
|
|
330861
|
+
"response": {
|
|
330862
|
+
"description": "Updated subscription details",
|
|
330863
|
+
"status": 200,
|
|
330864
|
+
"schema": {
|
|
330865
|
+
"type": "object",
|
|
330866
|
+
"properties": {
|
|
330867
|
+
"plan": {
|
|
330868
|
+
"type": "object",
|
|
330869
|
+
"properties": {
|
|
330870
|
+
"current": {
|
|
330871
|
+
"type": "object",
|
|
330872
|
+
"properties": {
|
|
330873
|
+
"status": {
|
|
330874
|
+
"type": "string",
|
|
330875
|
+
"enum": [
|
|
330876
|
+
"active",
|
|
330877
|
+
"canceled",
|
|
330878
|
+
"past_due",
|
|
330879
|
+
"action_required",
|
|
330880
|
+
"grace_period"
|
|
330881
|
+
]
|
|
330882
|
+
},
|
|
330883
|
+
"planId": {
|
|
330884
|
+
"type": "string"
|
|
330885
|
+
},
|
|
330886
|
+
"interval": {
|
|
330887
|
+
"type": "string",
|
|
330888
|
+
"enum": [
|
|
330889
|
+
"month",
|
|
330890
|
+
"year"
|
|
330891
|
+
]
|
|
330892
|
+
},
|
|
330893
|
+
"price": {
|
|
330894
|
+
"type": "number"
|
|
330895
|
+
},
|
|
330896
|
+
"proratedPrice": {
|
|
330897
|
+
"type": "number"
|
|
330898
|
+
},
|
|
330899
|
+
"cancelAtPeriodEnd": {
|
|
330900
|
+
"type": "boolean"
|
|
330901
|
+
},
|
|
330902
|
+
"periodEnd": {
|
|
330903
|
+
"type": "string"
|
|
330904
|
+
}
|
|
330905
|
+
},
|
|
330906
|
+
"required": [
|
|
330907
|
+
"status",
|
|
330908
|
+
"planId",
|
|
330909
|
+
"interval",
|
|
330910
|
+
"price",
|
|
330911
|
+
"cancelAtPeriodEnd",
|
|
330912
|
+
"periodEnd"
|
|
330913
|
+
],
|
|
330914
|
+
"additionalProperties": false
|
|
330915
|
+
},
|
|
330916
|
+
"next": {
|
|
330917
|
+
"type": "object",
|
|
330918
|
+
"properties": {
|
|
330919
|
+
"planId": {
|
|
330920
|
+
"type": "string"
|
|
330921
|
+
},
|
|
330922
|
+
"interval": {
|
|
330923
|
+
"type": "string",
|
|
330924
|
+
"enum": [
|
|
330925
|
+
"month",
|
|
330926
|
+
"year"
|
|
330927
|
+
]
|
|
330928
|
+
},
|
|
330929
|
+
"price": {
|
|
330930
|
+
"type": "number",
|
|
330931
|
+
"nullable": true
|
|
330932
|
+
},
|
|
330933
|
+
"effectiveDate": {
|
|
330934
|
+
"type": "string"
|
|
330935
|
+
}
|
|
330936
|
+
},
|
|
330937
|
+
"required": [
|
|
330938
|
+
"planId",
|
|
330939
|
+
"interval",
|
|
330940
|
+
"price",
|
|
330941
|
+
"effectiveDate"
|
|
330942
|
+
],
|
|
330943
|
+
"nullable": true,
|
|
330944
|
+
"additionalProperties": false
|
|
330945
|
+
}
|
|
330946
|
+
},
|
|
330947
|
+
"required": [
|
|
330948
|
+
"current",
|
|
330949
|
+
"next"
|
|
330950
|
+
],
|
|
330951
|
+
"additionalProperties": false
|
|
330952
|
+
},
|
|
330953
|
+
"addons": {
|
|
330954
|
+
"type": "object",
|
|
330955
|
+
"additionalProperties": {
|
|
330956
|
+
"type": "object",
|
|
330957
|
+
"properties": {
|
|
330958
|
+
"current": {
|
|
330959
|
+
"type": "object",
|
|
330960
|
+
"properties": {
|
|
330961
|
+
"quantity": {
|
|
330962
|
+
"type": "number"
|
|
330963
|
+
},
|
|
330964
|
+
"price": {
|
|
330965
|
+
"type": "number"
|
|
330966
|
+
},
|
|
330967
|
+
"proratedPrice": {
|
|
330968
|
+
"type": "number"
|
|
330969
|
+
}
|
|
330970
|
+
},
|
|
330971
|
+
"required": [
|
|
330972
|
+
"quantity",
|
|
330973
|
+
"price"
|
|
330974
|
+
],
|
|
330975
|
+
"additionalProperties": false
|
|
330976
|
+
},
|
|
330977
|
+
"next": {
|
|
330978
|
+
"type": "object",
|
|
330979
|
+
"properties": {
|
|
330980
|
+
"quantity": {
|
|
330981
|
+
"type": "number"
|
|
330982
|
+
},
|
|
330983
|
+
"price": {
|
|
330984
|
+
"type": "number"
|
|
330985
|
+
},
|
|
330986
|
+
"effectiveDate": {
|
|
330987
|
+
"type": "string"
|
|
330988
|
+
}
|
|
330989
|
+
},
|
|
330990
|
+
"required": [
|
|
330991
|
+
"quantity",
|
|
330992
|
+
"price",
|
|
330993
|
+
"effectiveDate"
|
|
330994
|
+
],
|
|
330995
|
+
"nullable": true,
|
|
330996
|
+
"additionalProperties": false
|
|
330997
|
+
}
|
|
330998
|
+
},
|
|
330999
|
+
"required": [
|
|
331000
|
+
"current",
|
|
331001
|
+
"next"
|
|
331002
|
+
],
|
|
331003
|
+
"additionalProperties": false
|
|
331004
|
+
}
|
|
331005
|
+
}
|
|
331006
|
+
},
|
|
331007
|
+
"required": [
|
|
331008
|
+
"plan",
|
|
331009
|
+
"addons"
|
|
331010
|
+
],
|
|
331011
|
+
"description": "Subscription details including current plan, addons, and costs",
|
|
331012
|
+
"title": "setPlanResponse",
|
|
331013
|
+
"additionalProperties": false
|
|
331014
|
+
}
|
|
331015
|
+
},
|
|
331016
|
+
"parameters": {
|
|
331017
|
+
"x-workspace-id": {
|
|
331018
|
+
"in": "header",
|
|
331019
|
+
"type": "string",
|
|
331020
|
+
"description": "Workspace ID",
|
|
331021
|
+
"required": true
|
|
331022
|
+
}
|
|
331023
|
+
}
|
|
331024
|
+
},
|
|
331025
|
+
"setAddons": {
|
|
331026
|
+
"name": "setAddons",
|
|
331027
|
+
"description": "Update addons for a workspace subscription",
|
|
331028
|
+
"method": "patch",
|
|
331029
|
+
"path": "/v2/billing/addons",
|
|
331030
|
+
"requestBody": {
|
|
331031
|
+
"description": "Addons update parameters. Set quantity to 0 to remove an addon.",
|
|
331032
|
+
"schema": {
|
|
331033
|
+
"type": "object",
|
|
331034
|
+
"properties": {
|
|
331035
|
+
"addons": {
|
|
331036
|
+
"type": "object",
|
|
331037
|
+
"additionalProperties": {
|
|
331038
|
+
"type": "number"
|
|
331039
|
+
}
|
|
331040
|
+
}
|
|
331041
|
+
},
|
|
331042
|
+
"required": [
|
|
331043
|
+
"addons"
|
|
331044
|
+
],
|
|
331045
|
+
"description": "Addons update parameters. Set quantity to 0 to remove an addon.",
|
|
331046
|
+
"title": "setAddonsBody",
|
|
331047
|
+
"additionalProperties": false
|
|
331048
|
+
}
|
|
331049
|
+
},
|
|
331050
|
+
"response": {
|
|
331051
|
+
"description": "Updated subscription details",
|
|
331052
|
+
"status": 200,
|
|
331053
|
+
"schema": {
|
|
331054
|
+
"type": "object",
|
|
331055
|
+
"properties": {
|
|
331056
|
+
"plan": {
|
|
331057
|
+
"type": "object",
|
|
331058
|
+
"properties": {
|
|
331059
|
+
"current": {
|
|
331060
|
+
"type": "object",
|
|
331061
|
+
"properties": {
|
|
331062
|
+
"status": {
|
|
331063
|
+
"type": "string",
|
|
331064
|
+
"enum": [
|
|
331065
|
+
"active",
|
|
331066
|
+
"canceled",
|
|
331067
|
+
"past_due",
|
|
331068
|
+
"action_required",
|
|
331069
|
+
"grace_period"
|
|
331070
|
+
]
|
|
331071
|
+
},
|
|
331072
|
+
"planId": {
|
|
331073
|
+
"type": "string"
|
|
331074
|
+
},
|
|
331075
|
+
"interval": {
|
|
331076
|
+
"type": "string",
|
|
331077
|
+
"enum": [
|
|
331078
|
+
"month",
|
|
331079
|
+
"year"
|
|
331080
|
+
]
|
|
331081
|
+
},
|
|
331082
|
+
"price": {
|
|
331083
|
+
"type": "number"
|
|
331084
|
+
},
|
|
331085
|
+
"proratedPrice": {
|
|
331086
|
+
"type": "number"
|
|
331087
|
+
},
|
|
331088
|
+
"cancelAtPeriodEnd": {
|
|
331089
|
+
"type": "boolean"
|
|
331090
|
+
},
|
|
331091
|
+
"periodEnd": {
|
|
331092
|
+
"type": "string"
|
|
331093
|
+
}
|
|
331094
|
+
},
|
|
331095
|
+
"required": [
|
|
331096
|
+
"status",
|
|
331097
|
+
"planId",
|
|
331098
|
+
"interval",
|
|
331099
|
+
"price",
|
|
331100
|
+
"cancelAtPeriodEnd",
|
|
331101
|
+
"periodEnd"
|
|
331102
|
+
],
|
|
331103
|
+
"additionalProperties": false
|
|
331104
|
+
},
|
|
331105
|
+
"next": {
|
|
331106
|
+
"type": "object",
|
|
331107
|
+
"properties": {
|
|
331108
|
+
"planId": {
|
|
331109
|
+
"type": "string"
|
|
331110
|
+
},
|
|
329982
331111
|
"interval": {
|
|
329983
331112
|
"type": "string",
|
|
329984
331113
|
"enum": [
|
|
@@ -329986,63 +331115,101 @@ var state6 = {
|
|
|
329986
331115
|
"year"
|
|
329987
331116
|
]
|
|
329988
331117
|
},
|
|
329989
|
-
"
|
|
329990
|
-
"type": "
|
|
329991
|
-
"
|
|
329992
|
-
|
|
329993
|
-
|
|
331118
|
+
"price": {
|
|
331119
|
+
"type": "number",
|
|
331120
|
+
"nullable": true
|
|
331121
|
+
},
|
|
331122
|
+
"effectiveDate": {
|
|
331123
|
+
"type": "string"
|
|
329994
331124
|
}
|
|
329995
331125
|
},
|
|
329996
331126
|
"required": [
|
|
329997
|
-
"
|
|
329998
|
-
"
|
|
329999
|
-
"
|
|
330000
|
-
"
|
|
330001
|
-
]
|
|
331127
|
+
"planId",
|
|
331128
|
+
"interval",
|
|
331129
|
+
"price",
|
|
331130
|
+
"effectiveDate"
|
|
331131
|
+
],
|
|
331132
|
+
"nullable": true,
|
|
331133
|
+
"additionalProperties": false
|
|
330002
331134
|
}
|
|
330003
331135
|
},
|
|
330004
|
-
"
|
|
330005
|
-
"
|
|
330006
|
-
"
|
|
330007
|
-
|
|
330008
|
-
|
|
330009
|
-
|
|
330010
|
-
|
|
330011
|
-
|
|
330012
|
-
|
|
330013
|
-
"bot_count",
|
|
330014
|
-
"always_alive_count",
|
|
330015
|
-
"always_alive_concurrency",
|
|
330016
|
-
"collaborator_count",
|
|
330017
|
-
"file_storage",
|
|
330018
|
-
"vector_db_storage",
|
|
330019
|
-
"saved_versions"
|
|
330020
|
-
]
|
|
330021
|
-
},
|
|
330022
|
-
"increment": {
|
|
330023
|
-
"type": "number"
|
|
330024
|
-
},
|
|
330025
|
-
"metadata": {
|
|
331136
|
+
"required": [
|
|
331137
|
+
"current",
|
|
331138
|
+
"next"
|
|
331139
|
+
],
|
|
331140
|
+
"additionalProperties": false
|
|
331141
|
+
},
|
|
331142
|
+
"addons": {
|
|
331143
|
+
"type": "object",
|
|
331144
|
+
"additionalProperties": {
|
|
330026
331145
|
"type": "object",
|
|
330027
|
-
"
|
|
330028
|
-
"
|
|
330029
|
-
|
|
331146
|
+
"properties": {
|
|
331147
|
+
"current": {
|
|
331148
|
+
"type": "object",
|
|
331149
|
+
"properties": {
|
|
331150
|
+
"quantity": {
|
|
331151
|
+
"type": "number"
|
|
331152
|
+
},
|
|
331153
|
+
"price": {
|
|
331154
|
+
"type": "number"
|
|
331155
|
+
},
|
|
331156
|
+
"proratedPrice": {
|
|
331157
|
+
"type": "number"
|
|
331158
|
+
}
|
|
331159
|
+
},
|
|
331160
|
+
"required": [
|
|
331161
|
+
"quantity",
|
|
331162
|
+
"price"
|
|
331163
|
+
],
|
|
331164
|
+
"additionalProperties": false
|
|
331165
|
+
},
|
|
331166
|
+
"next": {
|
|
331167
|
+
"type": "object",
|
|
331168
|
+
"properties": {
|
|
331169
|
+
"quantity": {
|
|
331170
|
+
"type": "number"
|
|
331171
|
+
},
|
|
331172
|
+
"price": {
|
|
331173
|
+
"type": "number"
|
|
331174
|
+
},
|
|
331175
|
+
"effectiveDate": {
|
|
331176
|
+
"type": "string"
|
|
331177
|
+
}
|
|
331178
|
+
},
|
|
331179
|
+
"required": [
|
|
331180
|
+
"quantity",
|
|
331181
|
+
"price",
|
|
331182
|
+
"effectiveDate"
|
|
331183
|
+
],
|
|
331184
|
+
"nullable": true,
|
|
331185
|
+
"additionalProperties": false
|
|
331186
|
+
}
|
|
331187
|
+
},
|
|
331188
|
+
"required": [
|
|
331189
|
+
"current",
|
|
331190
|
+
"next"
|
|
331191
|
+
],
|
|
331192
|
+
"additionalProperties": false
|
|
330030
331193
|
}
|
|
330031
|
-
}
|
|
330032
|
-
"required": [
|
|
330033
|
-
"id",
|
|
330034
|
-
"name",
|
|
330035
|
-
"description",
|
|
330036
|
-
"providerProductId",
|
|
330037
|
-
"prices",
|
|
330038
|
-
"feature",
|
|
330039
|
-
"increment"
|
|
330040
|
-
]
|
|
331194
|
+
}
|
|
330041
331195
|
},
|
|
330042
|
-
"
|
|
331196
|
+
"required": [
|
|
331197
|
+
"plan",
|
|
331198
|
+
"addons"
|
|
331199
|
+
],
|
|
331200
|
+
"description": "Subscription details including current plan, addons, and costs",
|
|
331201
|
+
"title": "setAddonsResponse",
|
|
331202
|
+
"additionalProperties": false
|
|
330043
331203
|
}
|
|
330044
331204
|
},
|
|
330045
|
-
"parameters": {
|
|
331205
|
+
"parameters": {
|
|
331206
|
+
"x-workspace-id": {
|
|
331207
|
+
"in": "header",
|
|
331208
|
+
"type": "string",
|
|
331209
|
+
"description": "Workspace ID",
|
|
331210
|
+
"required": true
|
|
331211
|
+
}
|
|
331212
|
+
}
|
|
330046
331213
|
},
|
|
330047
331214
|
"listInvoices": {
|
|
330048
331215
|
"name": "listInvoices",
|
|
@@ -330140,7 +331307,6 @@ var state6 = {
|
|
|
330140
331307
|
"invoices",
|
|
330141
331308
|
"meta"
|
|
330142
331309
|
],
|
|
330143
|
-
"description": "List of invoices with pagination.",
|
|
330144
331310
|
"title": "listInvoicesResponse",
|
|
330145
331311
|
"additionalProperties": false
|
|
330146
331312
|
}
|
|
@@ -330425,13 +331591,38 @@ var state6 = {
|
|
|
330425
331591
|
"required": true
|
|
330426
331592
|
}
|
|
330427
331593
|
}
|
|
331594
|
+
},
|
|
331595
|
+
"getQuotas": {
|
|
331596
|
+
"name": "getQuotas",
|
|
331597
|
+
"description": "Get calculated quotas for the authenticated workspace based on plan and addons",
|
|
331598
|
+
"method": "get",
|
|
331599
|
+
"path": "/v2/billing/quotas",
|
|
331600
|
+
"response": {
|
|
331601
|
+
"description": "Calculated quotas for the workspace (featureId -> value)",
|
|
331602
|
+
"status": 200,
|
|
331603
|
+
"schema": {
|
|
331604
|
+
"type": "object",
|
|
331605
|
+
"additionalProperties": {
|
|
331606
|
+
"type": "number"
|
|
331607
|
+
},
|
|
331608
|
+
"title": "getQuotasResponse"
|
|
331609
|
+
}
|
|
331610
|
+
},
|
|
331611
|
+
"parameters": {
|
|
331612
|
+
"x-workspace-id": {
|
|
331613
|
+
"in": "header",
|
|
331614
|
+
"type": "string",
|
|
331615
|
+
"description": "Workspace ID",
|
|
331616
|
+
"required": true
|
|
331617
|
+
}
|
|
331618
|
+
}
|
|
330428
331619
|
}
|
|
330429
331620
|
},
|
|
330430
331621
|
"metadata": {
|
|
330431
331622
|
"title": "Botpress Billing Public API",
|
|
330432
331623
|
"description": "API for Botpress Billing",
|
|
330433
331624
|
"server": "https://api.botpress.cloud",
|
|
330434
|
-
"version": "1.
|
|
331625
|
+
"version": "1.72.0",
|
|
330435
331626
|
"prefix": "v2"
|
|
330436
331627
|
},
|
|
330437
331628
|
"defaultParameters": {
|
|
@@ -330577,6 +331768,9 @@ var state6 = {
|
|
|
330577
331768
|
"refs": {
|
|
330578
331769
|
"parameters": {},
|
|
330579
331770
|
"requestBodies": {
|
|
331771
|
+
"previewSubscriptionUpdateBody": true,
|
|
331772
|
+
"setPlanBody": true,
|
|
331773
|
+
"setAddonsBody": true,
|
|
330580
331774
|
"payInvoiceBody": true,
|
|
330581
331775
|
"setPaymentMethodBody": true,
|
|
330582
331776
|
"createPaymentMethodIntentBody": true
|
|
@@ -330587,14 +331781,26 @@ var state6 = {
|
|
|
330587
331781
|
"listPlansResponse": true,
|
|
330588
331782
|
"getAddonResponse": true,
|
|
330589
331783
|
"listAddonsResponse": true,
|
|
331784
|
+
"getCurrentSubscriptionResponse": true,
|
|
331785
|
+
"getNextSubscriptionResponse": true,
|
|
331786
|
+
"previewSubscriptionUpdateResponse": true,
|
|
331787
|
+
"setPlanResponse": true,
|
|
331788
|
+
"setAddonsResponse": true,
|
|
330590
331789
|
"listInvoicesResponse": true,
|
|
330591
331790
|
"payInvoiceResponse": true,
|
|
330592
331791
|
"getPaymentMethodResponse": true,
|
|
330593
331792
|
"setPaymentMethodResponse": true,
|
|
330594
|
-
"createPaymentMethodIntentResponse": true
|
|
331793
|
+
"createPaymentMethodIntentResponse": true,
|
|
331794
|
+
"getQuotasResponse": true
|
|
330595
331795
|
},
|
|
330596
331796
|
"schemas": {
|
|
330597
|
-
"Invoice": true
|
|
331797
|
+
"Invoice": true,
|
|
331798
|
+
"Subscription": true,
|
|
331799
|
+
"SubscriptionPreview": true,
|
|
331800
|
+
"SubscriptionUpdateParams": true,
|
|
331801
|
+
"SubscriptionDetails": true,
|
|
331802
|
+
"SetPlanParams": true,
|
|
331803
|
+
"SetAddonsParams": true
|
|
330598
331804
|
}
|
|
330599
331805
|
},
|
|
330600
331806
|
"schemas": {
|
|
@@ -330653,7 +331859,550 @@ var state6 = {
|
|
|
330653
331859
|
"dueDate",
|
|
330654
331860
|
"pdfUrl"
|
|
330655
331861
|
],
|
|
330656
|
-
"
|
|
331862
|
+
"additionalProperties": false
|
|
331863
|
+
}
|
|
331864
|
+
},
|
|
331865
|
+
"Subscription": {
|
|
331866
|
+
"section": "subscription",
|
|
331867
|
+
"schema": {
|
|
331868
|
+
"type": "object",
|
|
331869
|
+
"properties": {
|
|
331870
|
+
"plan": {
|
|
331871
|
+
"type": "object",
|
|
331872
|
+
"properties": {
|
|
331873
|
+
"current": {
|
|
331874
|
+
"type": "object",
|
|
331875
|
+
"properties": {
|
|
331876
|
+
"status": {
|
|
331877
|
+
"type": "string",
|
|
331878
|
+
"enum": [
|
|
331879
|
+
"active",
|
|
331880
|
+
"canceled",
|
|
331881
|
+
"past_due",
|
|
331882
|
+
"action_required",
|
|
331883
|
+
"grace_period"
|
|
331884
|
+
]
|
|
331885
|
+
},
|
|
331886
|
+
"planId": {
|
|
331887
|
+
"type": "string"
|
|
331888
|
+
},
|
|
331889
|
+
"interval": {
|
|
331890
|
+
"type": "string",
|
|
331891
|
+
"enum": [
|
|
331892
|
+
"month",
|
|
331893
|
+
"year"
|
|
331894
|
+
]
|
|
331895
|
+
},
|
|
331896
|
+
"price": {
|
|
331897
|
+
"type": "number"
|
|
331898
|
+
},
|
|
331899
|
+
"proratedPrice": {
|
|
331900
|
+
"type": "number"
|
|
331901
|
+
},
|
|
331902
|
+
"cancelAtPeriodEnd": {
|
|
331903
|
+
"type": "boolean"
|
|
331904
|
+
},
|
|
331905
|
+
"periodEnd": {
|
|
331906
|
+
"type": "string"
|
|
331907
|
+
}
|
|
331908
|
+
},
|
|
331909
|
+
"required": [
|
|
331910
|
+
"status",
|
|
331911
|
+
"planId",
|
|
331912
|
+
"interval",
|
|
331913
|
+
"price",
|
|
331914
|
+
"cancelAtPeriodEnd",
|
|
331915
|
+
"periodEnd"
|
|
331916
|
+
],
|
|
331917
|
+
"additionalProperties": false
|
|
331918
|
+
},
|
|
331919
|
+
"next": {
|
|
331920
|
+
"type": "object",
|
|
331921
|
+
"properties": {
|
|
331922
|
+
"planId": {
|
|
331923
|
+
"type": "string"
|
|
331924
|
+
},
|
|
331925
|
+
"interval": {
|
|
331926
|
+
"type": "string",
|
|
331927
|
+
"enum": [
|
|
331928
|
+
"month",
|
|
331929
|
+
"year"
|
|
331930
|
+
]
|
|
331931
|
+
},
|
|
331932
|
+
"price": {
|
|
331933
|
+
"type": "number",
|
|
331934
|
+
"nullable": true
|
|
331935
|
+
},
|
|
331936
|
+
"effectiveDate": {
|
|
331937
|
+
"type": "string"
|
|
331938
|
+
}
|
|
331939
|
+
},
|
|
331940
|
+
"required": [
|
|
331941
|
+
"planId",
|
|
331942
|
+
"interval",
|
|
331943
|
+
"price",
|
|
331944
|
+
"effectiveDate"
|
|
331945
|
+
],
|
|
331946
|
+
"nullable": true,
|
|
331947
|
+
"additionalProperties": false
|
|
331948
|
+
}
|
|
331949
|
+
},
|
|
331950
|
+
"required": [
|
|
331951
|
+
"current",
|
|
331952
|
+
"next"
|
|
331953
|
+
],
|
|
331954
|
+
"additionalProperties": false
|
|
331955
|
+
},
|
|
331956
|
+
"addons": {
|
|
331957
|
+
"type": "object",
|
|
331958
|
+
"additionalProperties": {
|
|
331959
|
+
"type": "object",
|
|
331960
|
+
"properties": {
|
|
331961
|
+
"current": {
|
|
331962
|
+
"type": "object",
|
|
331963
|
+
"properties": {
|
|
331964
|
+
"quantity": {
|
|
331965
|
+
"type": "number"
|
|
331966
|
+
},
|
|
331967
|
+
"price": {
|
|
331968
|
+
"type": "number"
|
|
331969
|
+
},
|
|
331970
|
+
"proratedPrice": {
|
|
331971
|
+
"type": "number"
|
|
331972
|
+
}
|
|
331973
|
+
},
|
|
331974
|
+
"required": [
|
|
331975
|
+
"quantity",
|
|
331976
|
+
"price"
|
|
331977
|
+
],
|
|
331978
|
+
"additionalProperties": false
|
|
331979
|
+
},
|
|
331980
|
+
"next": {
|
|
331981
|
+
"type": "object",
|
|
331982
|
+
"properties": {
|
|
331983
|
+
"quantity": {
|
|
331984
|
+
"type": "number"
|
|
331985
|
+
},
|
|
331986
|
+
"price": {
|
|
331987
|
+
"type": "number"
|
|
331988
|
+
},
|
|
331989
|
+
"effectiveDate": {
|
|
331990
|
+
"type": "string"
|
|
331991
|
+
}
|
|
331992
|
+
},
|
|
331993
|
+
"required": [
|
|
331994
|
+
"quantity",
|
|
331995
|
+
"price",
|
|
331996
|
+
"effectiveDate"
|
|
331997
|
+
],
|
|
331998
|
+
"nullable": true,
|
|
331999
|
+
"additionalProperties": false
|
|
332000
|
+
}
|
|
332001
|
+
},
|
|
332002
|
+
"required": [
|
|
332003
|
+
"current",
|
|
332004
|
+
"next"
|
|
332005
|
+
],
|
|
332006
|
+
"additionalProperties": false
|
|
332007
|
+
}
|
|
332008
|
+
}
|
|
332009
|
+
},
|
|
332010
|
+
"required": [
|
|
332011
|
+
"plan",
|
|
332012
|
+
"addons"
|
|
332013
|
+
],
|
|
332014
|
+
"additionalProperties": false
|
|
332015
|
+
}
|
|
332016
|
+
},
|
|
332017
|
+
"SubscriptionPreview": {
|
|
332018
|
+
"section": "subscription",
|
|
332019
|
+
"schema": {
|
|
332020
|
+
"type": "object",
|
|
332021
|
+
"properties": {
|
|
332022
|
+
"plan": {
|
|
332023
|
+
"type": "object",
|
|
332024
|
+
"properties": {
|
|
332025
|
+
"current": {
|
|
332026
|
+
"type": "object",
|
|
332027
|
+
"properties": {
|
|
332028
|
+
"status": {
|
|
332029
|
+
"type": "string",
|
|
332030
|
+
"enum": [
|
|
332031
|
+
"active",
|
|
332032
|
+
"canceled",
|
|
332033
|
+
"past_due",
|
|
332034
|
+
"action_required",
|
|
332035
|
+
"grace_period"
|
|
332036
|
+
]
|
|
332037
|
+
},
|
|
332038
|
+
"planId": {
|
|
332039
|
+
"type": "string"
|
|
332040
|
+
},
|
|
332041
|
+
"interval": {
|
|
332042
|
+
"type": "string",
|
|
332043
|
+
"enum": [
|
|
332044
|
+
"month",
|
|
332045
|
+
"year"
|
|
332046
|
+
]
|
|
332047
|
+
},
|
|
332048
|
+
"price": {
|
|
332049
|
+
"type": "number"
|
|
332050
|
+
},
|
|
332051
|
+
"proratedPrice": {
|
|
332052
|
+
"type": "number"
|
|
332053
|
+
},
|
|
332054
|
+
"cancelAtPeriodEnd": {
|
|
332055
|
+
"type": "boolean"
|
|
332056
|
+
},
|
|
332057
|
+
"periodEnd": {
|
|
332058
|
+
"type": "string"
|
|
332059
|
+
}
|
|
332060
|
+
},
|
|
332061
|
+
"required": [
|
|
332062
|
+
"status",
|
|
332063
|
+
"planId",
|
|
332064
|
+
"interval",
|
|
332065
|
+
"price",
|
|
332066
|
+
"cancelAtPeriodEnd",
|
|
332067
|
+
"periodEnd"
|
|
332068
|
+
],
|
|
332069
|
+
"additionalProperties": false
|
|
332070
|
+
},
|
|
332071
|
+
"next": {
|
|
332072
|
+
"type": "object",
|
|
332073
|
+
"properties": {
|
|
332074
|
+
"planId": {
|
|
332075
|
+
"type": "string"
|
|
332076
|
+
},
|
|
332077
|
+
"interval": {
|
|
332078
|
+
"type": "string",
|
|
332079
|
+
"enum": [
|
|
332080
|
+
"month",
|
|
332081
|
+
"year"
|
|
332082
|
+
]
|
|
332083
|
+
},
|
|
332084
|
+
"price": {
|
|
332085
|
+
"type": "number",
|
|
332086
|
+
"nullable": true
|
|
332087
|
+
},
|
|
332088
|
+
"effectiveDate": {
|
|
332089
|
+
"type": "string"
|
|
332090
|
+
}
|
|
332091
|
+
},
|
|
332092
|
+
"required": [
|
|
332093
|
+
"planId",
|
|
332094
|
+
"interval",
|
|
332095
|
+
"price",
|
|
332096
|
+
"effectiveDate"
|
|
332097
|
+
],
|
|
332098
|
+
"nullable": true,
|
|
332099
|
+
"additionalProperties": false
|
|
332100
|
+
}
|
|
332101
|
+
},
|
|
332102
|
+
"required": [
|
|
332103
|
+
"current",
|
|
332104
|
+
"next"
|
|
332105
|
+
],
|
|
332106
|
+
"additionalProperties": false
|
|
332107
|
+
},
|
|
332108
|
+
"addons": {
|
|
332109
|
+
"type": "object",
|
|
332110
|
+
"additionalProperties": {
|
|
332111
|
+
"type": "object",
|
|
332112
|
+
"properties": {
|
|
332113
|
+
"current": {
|
|
332114
|
+
"type": "object",
|
|
332115
|
+
"properties": {
|
|
332116
|
+
"quantity": {
|
|
332117
|
+
"type": "number"
|
|
332118
|
+
},
|
|
332119
|
+
"price": {
|
|
332120
|
+
"type": "number"
|
|
332121
|
+
},
|
|
332122
|
+
"proratedPrice": {
|
|
332123
|
+
"type": "number"
|
|
332124
|
+
}
|
|
332125
|
+
},
|
|
332126
|
+
"required": [
|
|
332127
|
+
"quantity",
|
|
332128
|
+
"price"
|
|
332129
|
+
],
|
|
332130
|
+
"additionalProperties": false
|
|
332131
|
+
},
|
|
332132
|
+
"next": {
|
|
332133
|
+
"type": "object",
|
|
332134
|
+
"properties": {
|
|
332135
|
+
"quantity": {
|
|
332136
|
+
"type": "number"
|
|
332137
|
+
},
|
|
332138
|
+
"price": {
|
|
332139
|
+
"type": "number"
|
|
332140
|
+
},
|
|
332141
|
+
"effectiveDate": {
|
|
332142
|
+
"type": "string"
|
|
332143
|
+
}
|
|
332144
|
+
},
|
|
332145
|
+
"required": [
|
|
332146
|
+
"quantity",
|
|
332147
|
+
"price",
|
|
332148
|
+
"effectiveDate"
|
|
332149
|
+
],
|
|
332150
|
+
"nullable": true,
|
|
332151
|
+
"additionalProperties": false
|
|
332152
|
+
}
|
|
332153
|
+
},
|
|
332154
|
+
"required": [
|
|
332155
|
+
"current",
|
|
332156
|
+
"next"
|
|
332157
|
+
],
|
|
332158
|
+
"additionalProperties": false
|
|
332159
|
+
}
|
|
332160
|
+
}
|
|
332161
|
+
},
|
|
332162
|
+
"required": [
|
|
332163
|
+
"plan",
|
|
332164
|
+
"addons"
|
|
332165
|
+
],
|
|
332166
|
+
"additionalProperties": false
|
|
332167
|
+
}
|
|
332168
|
+
},
|
|
332169
|
+
"SubscriptionUpdateParams": {
|
|
332170
|
+
"section": "subscription",
|
|
332171
|
+
"schema": {
|
|
332172
|
+
"type": "object",
|
|
332173
|
+
"properties": {
|
|
332174
|
+
"plan": {
|
|
332175
|
+
"type": "object",
|
|
332176
|
+
"properties": {
|
|
332177
|
+
"planId": {
|
|
332178
|
+
"type": "string",
|
|
332179
|
+
"description": "New plan ID (optional)"
|
|
332180
|
+
},
|
|
332181
|
+
"interval": {
|
|
332182
|
+
"type": "string",
|
|
332183
|
+
"enum": [
|
|
332184
|
+
"month",
|
|
332185
|
+
"year"
|
|
332186
|
+
],
|
|
332187
|
+
"description": "New billing interval (optional)"
|
|
332188
|
+
}
|
|
332189
|
+
},
|
|
332190
|
+
"required": [
|
|
332191
|
+
"planId",
|
|
332192
|
+
"interval"
|
|
332193
|
+
],
|
|
332194
|
+
"additionalProperties": false
|
|
332195
|
+
},
|
|
332196
|
+
"addons": {
|
|
332197
|
+
"type": "object",
|
|
332198
|
+
"additionalProperties": {
|
|
332199
|
+
"type": "number"
|
|
332200
|
+
},
|
|
332201
|
+
"description": "Map of addon IDs to quantities (optional). Set quantity to 0 to remove addon."
|
|
332202
|
+
}
|
|
332203
|
+
},
|
|
332204
|
+
"required": [
|
|
332205
|
+
"plan"
|
|
332206
|
+
],
|
|
332207
|
+
"additionalProperties": false
|
|
332208
|
+
}
|
|
332209
|
+
},
|
|
332210
|
+
"SubscriptionDetails": {
|
|
332211
|
+
"section": "subscription",
|
|
332212
|
+
"schema": {
|
|
332213
|
+
"type": "object",
|
|
332214
|
+
"properties": {
|
|
332215
|
+
"plan": {
|
|
332216
|
+
"type": "object",
|
|
332217
|
+
"properties": {
|
|
332218
|
+
"current": {
|
|
332219
|
+
"type": "object",
|
|
332220
|
+
"properties": {
|
|
332221
|
+
"status": {
|
|
332222
|
+
"type": "string",
|
|
332223
|
+
"enum": [
|
|
332224
|
+
"active",
|
|
332225
|
+
"canceled",
|
|
332226
|
+
"past_due",
|
|
332227
|
+
"action_required",
|
|
332228
|
+
"grace_period"
|
|
332229
|
+
]
|
|
332230
|
+
},
|
|
332231
|
+
"planId": {
|
|
332232
|
+
"type": "string"
|
|
332233
|
+
},
|
|
332234
|
+
"interval": {
|
|
332235
|
+
"type": "string",
|
|
332236
|
+
"enum": [
|
|
332237
|
+
"month",
|
|
332238
|
+
"year"
|
|
332239
|
+
]
|
|
332240
|
+
},
|
|
332241
|
+
"price": {
|
|
332242
|
+
"type": "number"
|
|
332243
|
+
},
|
|
332244
|
+
"proratedPrice": {
|
|
332245
|
+
"type": "number"
|
|
332246
|
+
},
|
|
332247
|
+
"cancelAtPeriodEnd": {
|
|
332248
|
+
"type": "boolean"
|
|
332249
|
+
},
|
|
332250
|
+
"periodEnd": {
|
|
332251
|
+
"type": "string"
|
|
332252
|
+
}
|
|
332253
|
+
},
|
|
332254
|
+
"required": [
|
|
332255
|
+
"status",
|
|
332256
|
+
"planId",
|
|
332257
|
+
"interval",
|
|
332258
|
+
"price",
|
|
332259
|
+
"cancelAtPeriodEnd",
|
|
332260
|
+
"periodEnd"
|
|
332261
|
+
],
|
|
332262
|
+
"additionalProperties": false
|
|
332263
|
+
},
|
|
332264
|
+
"next": {
|
|
332265
|
+
"type": "object",
|
|
332266
|
+
"properties": {
|
|
332267
|
+
"planId": {
|
|
332268
|
+
"type": "string"
|
|
332269
|
+
},
|
|
332270
|
+
"interval": {
|
|
332271
|
+
"type": "string",
|
|
332272
|
+
"enum": [
|
|
332273
|
+
"month",
|
|
332274
|
+
"year"
|
|
332275
|
+
]
|
|
332276
|
+
},
|
|
332277
|
+
"price": {
|
|
332278
|
+
"type": "number",
|
|
332279
|
+
"nullable": true
|
|
332280
|
+
},
|
|
332281
|
+
"effectiveDate": {
|
|
332282
|
+
"type": "string"
|
|
332283
|
+
}
|
|
332284
|
+
},
|
|
332285
|
+
"required": [
|
|
332286
|
+
"planId",
|
|
332287
|
+
"interval",
|
|
332288
|
+
"price",
|
|
332289
|
+
"effectiveDate"
|
|
332290
|
+
],
|
|
332291
|
+
"nullable": true,
|
|
332292
|
+
"additionalProperties": false
|
|
332293
|
+
}
|
|
332294
|
+
},
|
|
332295
|
+
"required": [
|
|
332296
|
+
"current",
|
|
332297
|
+
"next"
|
|
332298
|
+
],
|
|
332299
|
+
"additionalProperties": false
|
|
332300
|
+
},
|
|
332301
|
+
"addons": {
|
|
332302
|
+
"type": "object",
|
|
332303
|
+
"additionalProperties": {
|
|
332304
|
+
"type": "object",
|
|
332305
|
+
"properties": {
|
|
332306
|
+
"current": {
|
|
332307
|
+
"type": "object",
|
|
332308
|
+
"properties": {
|
|
332309
|
+
"quantity": {
|
|
332310
|
+
"type": "number"
|
|
332311
|
+
},
|
|
332312
|
+
"price": {
|
|
332313
|
+
"type": "number"
|
|
332314
|
+
},
|
|
332315
|
+
"proratedPrice": {
|
|
332316
|
+
"type": "number"
|
|
332317
|
+
}
|
|
332318
|
+
},
|
|
332319
|
+
"required": [
|
|
332320
|
+
"quantity",
|
|
332321
|
+
"price"
|
|
332322
|
+
],
|
|
332323
|
+
"additionalProperties": false
|
|
332324
|
+
},
|
|
332325
|
+
"next": {
|
|
332326
|
+
"type": "object",
|
|
332327
|
+
"properties": {
|
|
332328
|
+
"quantity": {
|
|
332329
|
+
"type": "number"
|
|
332330
|
+
},
|
|
332331
|
+
"price": {
|
|
332332
|
+
"type": "number"
|
|
332333
|
+
},
|
|
332334
|
+
"effectiveDate": {
|
|
332335
|
+
"type": "string"
|
|
332336
|
+
}
|
|
332337
|
+
},
|
|
332338
|
+
"required": [
|
|
332339
|
+
"quantity",
|
|
332340
|
+
"price",
|
|
332341
|
+
"effectiveDate"
|
|
332342
|
+
],
|
|
332343
|
+
"nullable": true,
|
|
332344
|
+
"additionalProperties": false
|
|
332345
|
+
}
|
|
332346
|
+
},
|
|
332347
|
+
"required": [
|
|
332348
|
+
"current",
|
|
332349
|
+
"next"
|
|
332350
|
+
],
|
|
332351
|
+
"additionalProperties": false
|
|
332352
|
+
}
|
|
332353
|
+
}
|
|
332354
|
+
},
|
|
332355
|
+
"required": [
|
|
332356
|
+
"plan",
|
|
332357
|
+
"addons"
|
|
332358
|
+
],
|
|
332359
|
+
"description": "Subscription details including current plan, addons, and costs",
|
|
332360
|
+
"additionalProperties": false
|
|
332361
|
+
}
|
|
332362
|
+
},
|
|
332363
|
+
"SetPlanParams": {
|
|
332364
|
+
"section": "subscription",
|
|
332365
|
+
"schema": {
|
|
332366
|
+
"type": "object",
|
|
332367
|
+
"properties": {
|
|
332368
|
+
"planId": {
|
|
332369
|
+
"type": "string"
|
|
332370
|
+
},
|
|
332371
|
+
"interval": {
|
|
332372
|
+
"type": "string",
|
|
332373
|
+
"enum": [
|
|
332374
|
+
"month",
|
|
332375
|
+
"year"
|
|
332376
|
+
]
|
|
332377
|
+
},
|
|
332378
|
+
"testReferenceTime": {
|
|
332379
|
+
"type": "number"
|
|
332380
|
+
}
|
|
332381
|
+
},
|
|
332382
|
+
"required": [
|
|
332383
|
+
"planId",
|
|
332384
|
+
"interval"
|
|
332385
|
+
],
|
|
332386
|
+
"description": "Plan update parameters",
|
|
332387
|
+
"additionalProperties": false
|
|
332388
|
+
}
|
|
332389
|
+
},
|
|
332390
|
+
"SetAddonsParams": {
|
|
332391
|
+
"section": "subscription",
|
|
332392
|
+
"schema": {
|
|
332393
|
+
"type": "object",
|
|
332394
|
+
"properties": {
|
|
332395
|
+
"addons": {
|
|
332396
|
+
"type": "object",
|
|
332397
|
+
"additionalProperties": {
|
|
332398
|
+
"type": "number"
|
|
332399
|
+
}
|
|
332400
|
+
}
|
|
332401
|
+
},
|
|
332402
|
+
"required": [
|
|
332403
|
+
"addons"
|
|
332404
|
+
],
|
|
332405
|
+
"description": "Addons update parameters. Set quantity to 0 to remove an addon.",
|
|
330657
332406
|
"additionalProperties": false
|
|
330658
332407
|
}
|
|
330659
332408
|
}
|
|
@@ -330665,6 +332414,13 @@ var state6 = {
|
|
|
330665
332414
|
"name": "invoice",
|
|
330666
332415
|
"operations": [],
|
|
330667
332416
|
"schema": "Invoice"
|
|
332417
|
+
},
|
|
332418
|
+
{
|
|
332419
|
+
"description": "",
|
|
332420
|
+
"title": "Subscription",
|
|
332421
|
+
"name": "subscription",
|
|
332422
|
+
"operations": [],
|
|
332423
|
+
"schema": "Subscription"
|
|
330668
332424
|
}
|
|
330669
332425
|
],
|
|
330670
332426
|
"options": {
|