@meshery/schemas 0.8.127 → 0.8.129

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.
Files changed (159) hide show
  1. package/dist/{Core-vaTzd8cz.d.mts → Core-BiYtFM4v.d.mts} +1 -1
  2. package/dist/{Core-vaTzd8cz.d.ts → Core-BiYtFM4v.d.ts} +1 -1
  3. package/dist/cloudApi.d.mts +13676 -3825
  4. package/dist/cloudApi.d.ts +13676 -3825
  5. package/dist/cloudApi.js +1 -1
  6. package/dist/cloudApi.mjs +1 -1
  7. package/dist/constructs/v1alpha1/capability/CapabilitySchema.d.mts +1 -149
  8. package/dist/constructs/v1alpha1/capability/CapabilitySchema.d.ts +1 -149
  9. package/dist/constructs/v1alpha1/capability/CapabilitySchema.js +1 -1
  10. package/dist/constructs/v1alpha1/capability/CapabilitySchema.mjs +1 -1
  11. package/dist/constructs/v1alpha1/core/Core.d.mts +1 -1
  12. package/dist/constructs/v1alpha1/core/Core.d.ts +1 -1
  13. package/dist/constructs/v1alpha1/core/CoreSchema.d.mts +1 -1643
  14. package/dist/constructs/v1alpha1/core/CoreSchema.d.ts +1 -1643
  15. package/dist/constructs/v1alpha1/core/CoreSchema.js +1 -1
  16. package/dist/constructs/v1alpha1/core/CoreSchema.mjs +1 -1
  17. package/dist/constructs/v1alpha2/catalog/CatalogSchema.d.mts +1 -74
  18. package/dist/constructs/v1alpha2/catalog/CatalogSchema.d.ts +1 -74
  19. package/dist/constructs/v1alpha2/catalog/CatalogSchema.js +1 -1
  20. package/dist/constructs/v1alpha2/catalog/CatalogSchema.mjs +1 -1
  21. package/dist/constructs/v1alpha3/relationship/Relationship.d.mts +32 -128
  22. package/dist/constructs/v1alpha3/relationship/Relationship.d.ts +32 -128
  23. package/dist/constructs/v1alpha3/relationship/RelationshipSchema.d.mts +1 -6973
  24. package/dist/constructs/v1alpha3/relationship/RelationshipSchema.d.ts +1 -6973
  25. package/dist/constructs/v1alpha3/relationship/RelationshipSchema.js +15 -15
  26. package/dist/constructs/v1alpha3/relationship/RelationshipSchema.mjs +15 -15
  27. package/dist/constructs/v1beta1/academy/Academy.d.mts +749 -319
  28. package/dist/constructs/v1beta1/academy/Academy.d.ts +749 -319
  29. package/dist/constructs/v1beta1/academy/AcademySchema.d.mts +1 -11832
  30. package/dist/constructs/v1beta1/academy/AcademySchema.d.ts +1 -11832
  31. package/dist/constructs/v1beta1/academy/AcademySchema.js +1 -1
  32. package/dist/constructs/v1beta1/academy/AcademySchema.mjs +1 -1
  33. package/dist/constructs/v1beta1/badge/BadgeSchema.d.mts +1 -513
  34. package/dist/constructs/v1beta1/badge/BadgeSchema.d.ts +1 -513
  35. package/dist/constructs/v1beta1/badge/BadgeSchema.js +1 -1
  36. package/dist/constructs/v1beta1/badge/BadgeSchema.mjs +1 -1
  37. package/dist/constructs/v1beta1/category/CategorySchema.d.mts +1 -54
  38. package/dist/constructs/v1beta1/category/CategorySchema.d.ts +1 -54
  39. package/dist/constructs/v1beta1/category/CategorySchema.js +1 -1
  40. package/dist/constructs/v1beta1/category/CategorySchema.mjs +1 -1
  41. package/dist/constructs/v1beta1/component/Component.d.mts +6 -12
  42. package/dist/constructs/v1beta1/component/Component.d.ts +6 -12
  43. package/dist/constructs/v1beta1/component/ComponentSchema.d.mts +1 -1771
  44. package/dist/constructs/v1beta1/component/ComponentSchema.d.ts +1 -1771
  45. package/dist/constructs/v1beta1/component/ComponentSchema.js +3 -3
  46. package/dist/constructs/v1beta1/component/ComponentSchema.mjs +3 -3
  47. package/dist/constructs/v1beta1/connection/Connection.d.mts +12 -12
  48. package/dist/constructs/v1beta1/connection/Connection.d.ts +12 -12
  49. package/dist/constructs/v1beta1/connection/ConnectionSchema.d.mts +1 -2978
  50. package/dist/constructs/v1beta1/connection/ConnectionSchema.d.ts +1 -2978
  51. package/dist/constructs/v1beta1/connection/ConnectionSchema.js +1 -1
  52. package/dist/constructs/v1beta1/connection/ConnectionSchema.mjs +1 -1
  53. package/dist/constructs/v1beta1/credential/Credential.d.mts +517 -0
  54. package/dist/constructs/v1beta1/credential/Credential.d.ts +517 -0
  55. package/dist/constructs/v1beta1/credential/Credential.js +1 -0
  56. package/dist/constructs/v1beta1/credential/Credential.mjs +0 -0
  57. package/dist/constructs/v1beta1/credential/CredentialSchema.d.mts +7 -0
  58. package/dist/constructs/v1beta1/credential/CredentialSchema.d.ts +7 -0
  59. package/dist/constructs/v1beta1/credential/CredentialSchema.js +9 -0
  60. package/dist/constructs/v1beta1/credential/CredentialSchema.mjs +9 -0
  61. package/dist/constructs/v1beta1/environment/Environment.d.mts +4 -4
  62. package/dist/constructs/v1beta1/environment/Environment.d.ts +4 -4
  63. package/dist/constructs/v1beta1/environment/EnvironmentSchema.d.mts +1 -958
  64. package/dist/constructs/v1beta1/environment/EnvironmentSchema.d.ts +1 -958
  65. package/dist/constructs/v1beta1/environment/EnvironmentSchema.js +1 -1
  66. package/dist/constructs/v1beta1/environment/EnvironmentSchema.mjs +1 -1
  67. package/dist/constructs/v1beta1/evaluation/Evaluation.d.mts +68 -212
  68. package/dist/constructs/v1beta1/evaluation/Evaluation.d.ts +68 -212
  69. package/dist/constructs/v1beta1/evaluation/EvaluationSchema.d.mts +1 -16507
  70. package/dist/constructs/v1beta1/evaluation/EvaluationSchema.d.ts +1 -16507
  71. package/dist/constructs/v1beta1/evaluation/EvaluationSchema.js +25 -25
  72. package/dist/constructs/v1beta1/evaluation/EvaluationSchema.mjs +25 -25
  73. package/dist/constructs/v1beta1/event/EventSchema.d.mts +1 -354
  74. package/dist/constructs/v1beta1/event/EventSchema.d.ts +1 -354
  75. package/dist/constructs/v1beta1/event/EventSchema.js +2 -1
  76. package/dist/constructs/v1beta1/event/EventSchema.mjs +2 -1
  77. package/dist/constructs/v1beta1/feature/FeatureSchema.d.mts +1 -767
  78. package/dist/constructs/v1beta1/feature/FeatureSchema.d.ts +1 -767
  79. package/dist/constructs/v1beta1/feature/FeatureSchema.js +2 -1
  80. package/dist/constructs/v1beta1/feature/FeatureSchema.mjs +2 -1
  81. package/dist/constructs/v1beta1/invitation/InvitationSchema.d.mts +1 -1646
  82. package/dist/constructs/v1beta1/invitation/InvitationSchema.d.ts +1 -1646
  83. package/dist/constructs/v1beta1/invitation/InvitationSchema.js +2 -1
  84. package/dist/constructs/v1beta1/invitation/InvitationSchema.mjs +2 -1
  85. package/dist/constructs/v1beta1/key/KeySchema.d.mts +1 -1219
  86. package/dist/constructs/v1beta1/key/KeySchema.d.ts +1 -1219
  87. package/dist/constructs/v1beta1/key/KeySchema.js +2 -1
  88. package/dist/constructs/v1beta1/key/KeySchema.mjs +2 -1
  89. package/dist/constructs/v1beta1/keychain/KeychainSchema.d.mts +1 -1543
  90. package/dist/constructs/v1beta1/keychain/KeychainSchema.d.ts +1 -1543
  91. package/dist/constructs/v1beta1/keychain/KeychainSchema.js +2 -1
  92. package/dist/constructs/v1beta1/keychain/KeychainSchema.mjs +2 -1
  93. package/dist/constructs/v1beta1/model/Model.d.mts +7 -13
  94. package/dist/constructs/v1beta1/model/Model.d.ts +7 -13
  95. package/dist/constructs/v1beta1/model/ModelSchema.d.mts +1 -1301
  96. package/dist/constructs/v1beta1/model/ModelSchema.d.ts +1 -1301
  97. package/dist/constructs/v1beta1/model/ModelSchema.js +2 -2
  98. package/dist/constructs/v1beta1/model/ModelSchema.mjs +2 -2
  99. package/dist/constructs/v1beta1/organization/OrganizationSchema.d.mts +1 -1488
  100. package/dist/constructs/v1beta1/organization/OrganizationSchema.d.ts +1 -1488
  101. package/dist/constructs/v1beta1/organization/OrganizationSchema.js +2 -1
  102. package/dist/constructs/v1beta1/organization/OrganizationSchema.mjs +2 -1
  103. package/dist/constructs/v1beta1/pattern/Pattern.d.mts +7481 -212
  104. package/dist/constructs/v1beta1/pattern/Pattern.d.ts +7481 -212
  105. package/dist/constructs/v1beta1/pattern/PatternSchema.d.mts +1 -16703
  106. package/dist/constructs/v1beta1/pattern/PatternSchema.d.ts +1 -16703
  107. package/dist/constructs/v1beta1/pattern/PatternSchema.js +265 -25
  108. package/dist/constructs/v1beta1/pattern/PatternSchema.mjs +265 -25
  109. package/dist/constructs/v1beta1/plan/PlanSchema.d.mts +1 -316
  110. package/dist/constructs/v1beta1/plan/PlanSchema.d.ts +1 -316
  111. package/dist/constructs/v1beta1/plan/PlanSchema.js +2 -1
  112. package/dist/constructs/v1beta1/plan/PlanSchema.mjs +2 -1
  113. package/dist/constructs/v1beta1/role/Role.d.mts +614 -0
  114. package/dist/constructs/v1beta1/role/Role.d.ts +614 -0
  115. package/dist/constructs/v1beta1/role/Role.js +1 -0
  116. package/dist/constructs/v1beta1/role/Role.mjs +0 -0
  117. package/dist/constructs/v1beta1/role/RoleSchema.d.mts +7 -0
  118. package/dist/constructs/v1beta1/role/RoleSchema.d.ts +7 -0
  119. package/dist/constructs/v1beta1/role/RoleSchema.js +2 -0
  120. package/dist/constructs/v1beta1/role/RoleSchema.mjs +2 -0
  121. package/dist/constructs/v1beta1/schedule/Schedule.d.mts +371 -0
  122. package/dist/constructs/v1beta1/schedule/Schedule.d.ts +371 -0
  123. package/dist/constructs/v1beta1/schedule/Schedule.js +1 -0
  124. package/dist/constructs/v1beta1/schedule/Schedule.mjs +0 -0
  125. package/dist/constructs/v1beta1/schedule/ScheduleSchema.d.mts +7 -0
  126. package/dist/constructs/v1beta1/schedule/ScheduleSchema.d.ts +7 -0
  127. package/dist/constructs/v1beta1/schedule/ScheduleSchema.js +13 -0
  128. package/dist/constructs/v1beta1/schedule/ScheduleSchema.mjs +13 -0
  129. package/dist/constructs/v1beta1/subcategory/SubcategorySchema.d.mts +1 -27
  130. package/dist/constructs/v1beta1/subcategory/SubcategorySchema.d.ts +1 -27
  131. package/dist/constructs/v1beta1/subcategory/SubcategorySchema.js +1 -1
  132. package/dist/constructs/v1beta1/subcategory/SubcategorySchema.mjs +1 -1
  133. package/dist/constructs/v1beta1/subscription/SubscriptionSchema.d.mts +1 -1636
  134. package/dist/constructs/v1beta1/subscription/SubscriptionSchema.d.ts +1 -1636
  135. package/dist/constructs/v1beta1/subscription/SubscriptionSchema.js +1 -1
  136. package/dist/constructs/v1beta1/subscription/SubscriptionSchema.mjs +1 -1
  137. package/dist/constructs/v1beta1/team/Team.d.mts +46 -16
  138. package/dist/constructs/v1beta1/team/Team.d.ts +46 -16
  139. package/dist/constructs/v1beta1/team/TeamSchema.d.mts +1 -2016
  140. package/dist/constructs/v1beta1/team/TeamSchema.d.ts +1 -2016
  141. package/dist/constructs/v1beta1/team/TeamSchema.js +1 -1
  142. package/dist/constructs/v1beta1/team/TeamSchema.mjs +1 -1
  143. package/dist/constructs/v1beta1/user/UserSchema.d.mts +1 -1106
  144. package/dist/constructs/v1beta1/user/UserSchema.d.ts +1 -1106
  145. package/dist/constructs/v1beta1/user/UserSchema.js +2 -1
  146. package/dist/constructs/v1beta1/user/UserSchema.mjs +2 -1
  147. package/dist/constructs/v1beta1/workspace/WorkspaceSchema.d.mts +1 -958
  148. package/dist/constructs/v1beta1/workspace/WorkspaceSchema.d.ts +1 -958
  149. package/dist/constructs/v1beta1/workspace/WorkspaceSchema.js +1 -1
  150. package/dist/constructs/v1beta1/workspace/WorkspaceSchema.mjs +1 -1
  151. package/dist/index.d.mts +1 -1
  152. package/dist/index.d.ts +1 -1
  153. package/dist/index.js +283 -43
  154. package/dist/index.mjs +283 -43
  155. package/dist/mesheryApi.d.mts +2025 -183
  156. package/dist/mesheryApi.d.ts +2025 -183
  157. package/dist/mesheryApi.js +1 -1
  158. package/dist/mesheryApi.mjs +1 -1
  159. package/package.json +1 -1
@@ -2,1641 +2,6 @@
2
2
  * This file was automatically generated from OpenAPI schema.
3
3
  * Do not manually modify this file.
4
4
  */
5
- declare const SubscriptionSchema: {
6
- readonly openapi: "3.0.0";
7
- readonly info: {
8
- readonly title: "subscription";
9
- readonly description: "API for managing subscriptions using various payment processors in a SaaS application.";
10
- readonly version: "1.0.0";
11
- };
12
- readonly servers: readonly [{
13
- readonly url: "http://localhost:8080";
14
- readonly description: "Local development server";
15
- }];
16
- readonly tags: readonly [{
17
- readonly name: "Subscriptions";
18
- readonly description: "Operations related to subscriptions";
19
- }, {
20
- readonly name: "Plans";
21
- readonly description: "Operations related to plans";
22
- }, {
23
- readonly name: "Payment Processors";
24
- readonly description: "Operations related to payment processors";
25
- }];
26
- readonly paths: {
27
- readonly "/api/entitlement/subscriptions": {
28
- readonly get: {
29
- readonly "x-internal": readonly ["cloud"];
30
- readonly tags: readonly ["subscription"];
31
- readonly description: "Returns all subscriptions for the organization";
32
- readonly operationId: "getSubscriptions";
33
- readonly summary: "Read subscriptions";
34
- readonly parameters: readonly [{
35
- readonly name: "page";
36
- readonly in: "query";
37
- readonly description: "Get responses by page";
38
- readonly schema: {
39
- readonly type: "string";
40
- };
41
- }, {
42
- readonly name: "pagesize";
43
- readonly in: "query";
44
- readonly description: "Get responses by pagesize";
45
- readonly schema: {
46
- readonly type: "string";
47
- };
48
- }, {
49
- readonly name: "order";
50
- readonly in: "query";
51
- readonly description: "Get ordered responses";
52
- readonly schema: {
53
- readonly type: "string";
54
- };
55
- }, {
56
- readonly name: "status";
57
- readonly in: "query";
58
- readonly description: "Filter subscriptions by status";
59
- readonly required: false;
60
- readonly schema: {
61
- readonly type: "array";
62
- readonly items: {
63
- readonly type: "string";
64
- };
65
- };
66
- readonly style: "form";
67
- readonly explode: true;
68
- }];
69
- readonly responses: {
70
- readonly "200": {
71
- readonly content: {
72
- readonly "application/json": {
73
- readonly schema: {
74
- readonly type: "object";
75
- readonly required: readonly ["page", "page_size", "total_count", "subscriptions"];
76
- readonly properties: {
77
- readonly page: {
78
- readonly type: "integer";
79
- };
80
- readonly page_size: {
81
- readonly type: "integer";
82
- };
83
- readonly total_count: {
84
- readonly type: "integer";
85
- };
86
- readonly subscriptions: {
87
- readonly type: "array";
88
- readonly items: {
89
- readonly "x-go-type": "Subscription";
90
- readonly type: "object";
91
- readonly properties: {
92
- readonly ID: {
93
- readonly "x-oapi-codegen-extra-tags": {
94
- readonly db: "id";
95
- };
96
- readonly type: "string";
97
- readonly format: "uuid";
98
- readonly description: "A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.";
99
- readonly "x-go-type": "uuid.UUID";
100
- readonly "x-go-type-import": {
101
- readonly path: "github.com/gofrs/uuid";
102
- };
103
- };
104
- readonly org_id: {
105
- readonly "x-oapi-codegen-extra-tags": {
106
- readonly db: "org_id";
107
- };
108
- readonly type: "string";
109
- readonly format: "uuid";
110
- readonly description: "A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.";
111
- readonly "x-go-type": "uuid.UUID";
112
- readonly "x-go-type-import": {
113
- readonly path: "github.com/gofrs/uuid";
114
- };
115
- };
116
- readonly plan_id: {
117
- readonly "x-oapi-codegen-extra-tags": {
118
- readonly db: "plan_id";
119
- };
120
- readonly type: "string";
121
- readonly format: "uuid";
122
- readonly description: "A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.";
123
- readonly "x-go-type": "uuid.UUID";
124
- readonly "x-go-type-import": {
125
- readonly path: "github.com/gofrs/uuid";
126
- };
127
- };
128
- readonly plan: {
129
- readonly "x-go-type": "plan.Plan";
130
- readonly "x-go-type-import": {
131
- readonly path: "github.com/meshery/schemas/models/v1beta1/plan";
132
- };
133
- readonly "x-oapi-codegen-extra-tags": {
134
- readonly belongs_to: "plans";
135
- readonly fk_id: "PlanId";
136
- readonly yaml: "plan,omitempty";
137
- readonly json: "plan,omitempty";
138
- };
139
- readonly type: "object";
140
- readonly properties: {
141
- readonly id: {
142
- readonly "x-oapi-codegen-extra-tags": {
143
- readonly db: "id";
144
- readonly json: "id";
145
- readonly csv: "id";
146
- };
147
- readonly type: "string";
148
- readonly format: "uuid";
149
- readonly description: "A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.";
150
- readonly "x-go-type": "uuid.UUID";
151
- readonly "x-go-type-import": {
152
- readonly path: "github.com/gofrs/uuid";
153
- };
154
- };
155
- readonly name: {
156
- readonly type: "string";
157
- readonly "x-go-type": "PlanName";
158
- readonly "x-oapi-codegen-extra-tags": {
159
- readonly db: "name";
160
- readonly json: "name";
161
- readonly csv: "name";
162
- };
163
- readonly description: "Name of the plan";
164
- readonly enum: readonly ["Free", "Team Designer", "Team Operator", "Enterprise"];
165
- };
166
- readonly cadence: {
167
- readonly "x-go-type": "PlanCadence";
168
- readonly "x-oapi-codegen-extra-tags": {
169
- readonly db: "cadence";
170
- readonly json: "cadence";
171
- readonly csv: "cadence";
172
- };
173
- readonly type: "string";
174
- readonly enum: readonly ["monthly", "yearly"];
175
- };
176
- readonly unit: {
177
- readonly "x-go-type": "PlanUnit";
178
- readonly "x-oapi-codegen-extra-tags": {
179
- readonly db: "unit";
180
- readonly json: "unit";
181
- readonly csv: "unit";
182
- };
183
- readonly type: "string";
184
- readonly enum: readonly ["user", "free"];
185
- };
186
- readonly minimum_units: {
187
- readonly type: "integer";
188
- readonly description: "Minimum number of units required for the plan";
189
- readonly "x-oapi-codegen-extra-tags": {
190
- readonly db: "minimum_units";
191
- readonly json: "minimum_units";
192
- readonly csv: "minimum_units";
193
- };
194
- };
195
- readonly price_per_unit: {
196
- readonly type: "number";
197
- readonly description: "Price per unit of the plan";
198
- readonly "x-oapi-codegen-extra-tags": {
199
- readonly db: "price_per_unit";
200
- readonly json: "price_per_unit";
201
- readonly csv: "price_per_unit";
202
- };
203
- };
204
- readonly currency: {
205
- readonly "x-go-type": "Currency";
206
- readonly "x-oapi-codegen-extra-tags": {
207
- readonly db: "currency";
208
- readonly json: "currency";
209
- readonly csv: "currency";
210
- };
211
- readonly type: "string";
212
- readonly enum: readonly ["usd"];
213
- };
214
- };
215
- readonly required: readonly ["id", "name", "cadence", "unit", "price_per_unit", "minimum_units", "price_id", "currency"];
216
- };
217
- readonly quantity: {
218
- readonly decscription: "number of units subscribed (eg number of users)";
219
- readonly type: "integer";
220
- readonly "x-oapi-codegen-extra-tags": {
221
- readonly db: "quantity";
222
- };
223
- };
224
- readonly start_date: {
225
- readonly "x-oapi-codegen-extra-tags": {
226
- readonly db: "start_date";
227
- };
228
- readonly type: "string";
229
- readonly format: "date-time";
230
- readonly "x-go-type-skip-optional-pointer": true;
231
- };
232
- readonly end_date: {
233
- readonly "x-oapi-codegen-extra-tags": {
234
- readonly db: "end_date";
235
- };
236
- readonly type: "string";
237
- readonly format: "date-time";
238
- readonly "x-go-type-skip-optional-pointer": true;
239
- };
240
- readonly status: {
241
- readonly "x-go-type": "SubscriptionStatus";
242
- readonly "x-oapi-codegen-extra-tags": {
243
- readonly db: "status";
244
- };
245
- readonly type: "string";
246
- readonly description: "Possible statuses of a Stripe subscription.";
247
- readonly enum: readonly ["incomplete", "incomplete_expired", "trialing", "active", "past_due", "canceled", "unpaid"];
248
- readonly "x-enumDescriptions": {
249
- readonly incomplete: "The subscription has been created, but the initial payment is pending. It may transition to 'active' or 'incomplete_expired'.";
250
- readonly incomplete_expired: "The subscription was created but never activated due to failed initial payment. It is now expired.";
251
- readonly trialing: "The subscription is currently in a trial period before the first payment is due.";
252
- readonly active: "The subscription is active, and billing is functioning normally.";
253
- readonly past_due: "The latest payment attempt failed, but the subscription remains active. Stripe may retry the charge.";
254
- readonly canceled: "The subscription has been canceled and will no longer generate invoices.";
255
- readonly unpaid: "The subscription is still technically active but has unpaid invoices and is no longer generating new invoices.";
256
- };
257
- };
258
- readonly created_at: {
259
- readonly "x-oapi-codegen-extra-tags": {
260
- readonly db: "created_at";
261
- };
262
- readonly type: "string";
263
- readonly format: "date-time";
264
- readonly "x-go-type-skip-optional-pointer": true;
265
- };
266
- readonly updated_at: {
267
- readonly "x-oapi-codegen-extra-tags": {
268
- readonly db: "updated_at";
269
- };
270
- readonly type: "string";
271
- readonly format: "date-time";
272
- readonly "x-go-type-skip-optional-pointer": true;
273
- };
274
- readonly deleted_at: {
275
- readonly "x-oapi-codegen-extra-tags": {
276
- readonly db: "deleted_at";
277
- };
278
- readonly type: "string";
279
- readonly format: "date-time";
280
- readonly "x-go-type": "sql.NullTime";
281
- readonly "x-go-type-import": {
282
- readonly path: "database/sql";
283
- };
284
- readonly "x-go-type-skip-optional-pointer": true;
285
- };
286
- readonly billing_id: {
287
- readonly type: "string";
288
- readonly description: "Billing ID of the subscription. This is the ID of the subscription in the billing system. eg Stripe";
289
- readonly "x-oapi-codegen-extra-tags": {
290
- readonly db: "billing_id";
291
- };
292
- };
293
- };
294
- readonly required: readonly ["ID", "org_id", "plan_id", "billing_id", "status", "quantity"];
295
- };
296
- };
297
- };
298
- };
299
- };
300
- };
301
- readonly description: "Get subscription response";
302
- };
303
- readonly "400": {
304
- readonly description: "Invalid request body or request param";
305
- readonly content: {
306
- readonly "text/plain": {
307
- readonly schema: {
308
- readonly type: "string";
309
- };
310
- };
311
- };
312
- };
313
- readonly "401": {
314
- readonly description: "Expired JWT token used or insufficient privilege";
315
- readonly content: {
316
- readonly "text/plain": {
317
- readonly schema: {
318
- readonly type: "string";
319
- };
320
- };
321
- };
322
- };
323
- readonly "500": {
324
- readonly description: "Internal server error";
325
- readonly content: {
326
- readonly "text/plain": {
327
- readonly schema: {
328
- readonly type: "string";
329
- };
330
- };
331
- };
332
- };
333
- };
334
- };
335
- };
336
- readonly "/api/entitlement/subscriptions/{subscriptionId}/cancel": {
337
- readonly post: {
338
- readonly "x-internal": readonly ["cloud"];
339
- readonly summary: "Cancel an existing subscription . The subscription will remain active until the end of the billing period and then it will be canceled.";
340
- readonly parameters: readonly [{
341
- readonly name: "subscriptionId";
342
- readonly in: "path";
343
- readonly required: true;
344
- readonly description: "Subscription ID";
345
- readonly schema: {
346
- readonly type: "string";
347
- };
348
- }];
349
- readonly responses: {
350
- readonly "200": {
351
- readonly content: {
352
- readonly "application/json": {
353
- readonly schema: {
354
- readonly type: "object";
355
- readonly required: readonly ["page", "page_size", "total_count", "subscriptions"];
356
- readonly properties: {
357
- readonly page: {
358
- readonly type: "integer";
359
- };
360
- readonly page_size: {
361
- readonly type: "integer";
362
- };
363
- readonly total_count: {
364
- readonly type: "integer";
365
- };
366
- readonly subscriptions: {
367
- readonly type: "array";
368
- readonly items: {
369
- readonly "x-go-type": "Subscription";
370
- readonly type: "object";
371
- readonly properties: {
372
- readonly ID: {
373
- readonly "x-oapi-codegen-extra-tags": {
374
- readonly db: "id";
375
- };
376
- readonly type: "string";
377
- readonly format: "uuid";
378
- readonly description: "A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.";
379
- readonly "x-go-type": "uuid.UUID";
380
- readonly "x-go-type-import": {
381
- readonly path: "github.com/gofrs/uuid";
382
- };
383
- };
384
- readonly org_id: {
385
- readonly "x-oapi-codegen-extra-tags": {
386
- readonly db: "org_id";
387
- };
388
- readonly type: "string";
389
- readonly format: "uuid";
390
- readonly description: "A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.";
391
- readonly "x-go-type": "uuid.UUID";
392
- readonly "x-go-type-import": {
393
- readonly path: "github.com/gofrs/uuid";
394
- };
395
- };
396
- readonly plan_id: {
397
- readonly "x-oapi-codegen-extra-tags": {
398
- readonly db: "plan_id";
399
- };
400
- readonly type: "string";
401
- readonly format: "uuid";
402
- readonly description: "A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.";
403
- readonly "x-go-type": "uuid.UUID";
404
- readonly "x-go-type-import": {
405
- readonly path: "github.com/gofrs/uuid";
406
- };
407
- };
408
- readonly plan: {
409
- readonly "x-go-type": "plan.Plan";
410
- readonly "x-go-type-import": {
411
- readonly path: "github.com/meshery/schemas/models/v1beta1/plan";
412
- };
413
- readonly "x-oapi-codegen-extra-tags": {
414
- readonly belongs_to: "plans";
415
- readonly fk_id: "PlanId";
416
- readonly yaml: "plan,omitempty";
417
- readonly json: "plan,omitempty";
418
- };
419
- readonly type: "object";
420
- readonly properties: {
421
- readonly id: {
422
- readonly "x-oapi-codegen-extra-tags": {
423
- readonly db: "id";
424
- readonly json: "id";
425
- readonly csv: "id";
426
- };
427
- readonly type: "string";
428
- readonly format: "uuid";
429
- readonly description: "A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.";
430
- readonly "x-go-type": "uuid.UUID";
431
- readonly "x-go-type-import": {
432
- readonly path: "github.com/gofrs/uuid";
433
- };
434
- };
435
- readonly name: {
436
- readonly type: "string";
437
- readonly "x-go-type": "PlanName";
438
- readonly "x-oapi-codegen-extra-tags": {
439
- readonly db: "name";
440
- readonly json: "name";
441
- readonly csv: "name";
442
- };
443
- readonly description: "Name of the plan";
444
- readonly enum: readonly ["Free", "Team Designer", "Team Operator", "Enterprise"];
445
- };
446
- readonly cadence: {
447
- readonly "x-go-type": "PlanCadence";
448
- readonly "x-oapi-codegen-extra-tags": {
449
- readonly db: "cadence";
450
- readonly json: "cadence";
451
- readonly csv: "cadence";
452
- };
453
- readonly type: "string";
454
- readonly enum: readonly ["monthly", "yearly"];
455
- };
456
- readonly unit: {
457
- readonly "x-go-type": "PlanUnit";
458
- readonly "x-oapi-codegen-extra-tags": {
459
- readonly db: "unit";
460
- readonly json: "unit";
461
- readonly csv: "unit";
462
- };
463
- readonly type: "string";
464
- readonly enum: readonly ["user", "free"];
465
- };
466
- readonly minimum_units: {
467
- readonly type: "integer";
468
- readonly description: "Minimum number of units required for the plan";
469
- readonly "x-oapi-codegen-extra-tags": {
470
- readonly db: "minimum_units";
471
- readonly json: "minimum_units";
472
- readonly csv: "minimum_units";
473
- };
474
- };
475
- readonly price_per_unit: {
476
- readonly type: "number";
477
- readonly description: "Price per unit of the plan";
478
- readonly "x-oapi-codegen-extra-tags": {
479
- readonly db: "price_per_unit";
480
- readonly json: "price_per_unit";
481
- readonly csv: "price_per_unit";
482
- };
483
- };
484
- readonly currency: {
485
- readonly "x-go-type": "Currency";
486
- readonly "x-oapi-codegen-extra-tags": {
487
- readonly db: "currency";
488
- readonly json: "currency";
489
- readonly csv: "currency";
490
- };
491
- readonly type: "string";
492
- readonly enum: readonly ["usd"];
493
- };
494
- };
495
- readonly required: readonly ["id", "name", "cadence", "unit", "price_per_unit", "minimum_units", "price_id", "currency"];
496
- };
497
- readonly quantity: {
498
- readonly decscription: "number of units subscribed (eg number of users)";
499
- readonly type: "integer";
500
- readonly "x-oapi-codegen-extra-tags": {
501
- readonly db: "quantity";
502
- };
503
- };
504
- readonly start_date: {
505
- readonly "x-oapi-codegen-extra-tags": {
506
- readonly db: "start_date";
507
- };
508
- readonly type: "string";
509
- readonly format: "date-time";
510
- readonly "x-go-type-skip-optional-pointer": true;
511
- };
512
- readonly end_date: {
513
- readonly "x-oapi-codegen-extra-tags": {
514
- readonly db: "end_date";
515
- };
516
- readonly type: "string";
517
- readonly format: "date-time";
518
- readonly "x-go-type-skip-optional-pointer": true;
519
- };
520
- readonly status: {
521
- readonly "x-go-type": "SubscriptionStatus";
522
- readonly "x-oapi-codegen-extra-tags": {
523
- readonly db: "status";
524
- };
525
- readonly type: "string";
526
- readonly description: "Possible statuses of a Stripe subscription.";
527
- readonly enum: readonly ["incomplete", "incomplete_expired", "trialing", "active", "past_due", "canceled", "unpaid"];
528
- readonly "x-enumDescriptions": {
529
- readonly incomplete: "The subscription has been created, but the initial payment is pending. It may transition to 'active' or 'incomplete_expired'.";
530
- readonly incomplete_expired: "The subscription was created but never activated due to failed initial payment. It is now expired.";
531
- readonly trialing: "The subscription is currently in a trial period before the first payment is due.";
532
- readonly active: "The subscription is active, and billing is functioning normally.";
533
- readonly past_due: "The latest payment attempt failed, but the subscription remains active. Stripe may retry the charge.";
534
- readonly canceled: "The subscription has been canceled and will no longer generate invoices.";
535
- readonly unpaid: "The subscription is still technically active but has unpaid invoices and is no longer generating new invoices.";
536
- };
537
- };
538
- readonly created_at: {
539
- readonly "x-oapi-codegen-extra-tags": {
540
- readonly db: "created_at";
541
- };
542
- readonly type: "string";
543
- readonly format: "date-time";
544
- readonly "x-go-type-skip-optional-pointer": true;
545
- };
546
- readonly updated_at: {
547
- readonly "x-oapi-codegen-extra-tags": {
548
- readonly db: "updated_at";
549
- };
550
- readonly type: "string";
551
- readonly format: "date-time";
552
- readonly "x-go-type-skip-optional-pointer": true;
553
- };
554
- readonly deleted_at: {
555
- readonly "x-oapi-codegen-extra-tags": {
556
- readonly db: "deleted_at";
557
- };
558
- readonly type: "string";
559
- readonly format: "date-time";
560
- readonly "x-go-type": "sql.NullTime";
561
- readonly "x-go-type-import": {
562
- readonly path: "database/sql";
563
- };
564
- readonly "x-go-type-skip-optional-pointer": true;
565
- };
566
- readonly billing_id: {
567
- readonly type: "string";
568
- readonly description: "Billing ID of the subscription. This is the ID of the subscription in the billing system. eg Stripe";
569
- readonly "x-oapi-codegen-extra-tags": {
570
- readonly db: "billing_id";
571
- };
572
- };
573
- };
574
- readonly required: readonly ["ID", "org_id", "plan_id", "billing_id", "status", "quantity"];
575
- };
576
- };
577
- };
578
- };
579
- };
580
- };
581
- };
582
- readonly "400": {
583
- readonly description: "Invalid request";
584
- };
585
- readonly "500": {
586
- readonly description: "Internal server error";
587
- };
588
- };
589
- };
590
- };
591
- readonly "/api/entitlement/subscriptions/create": {
592
- readonly post: {
593
- readonly "x-internal": readonly ["cloud"];
594
- readonly summary: "Create a new subscription for an organization";
595
- readonly requestBody: {
596
- readonly required: true;
597
- readonly content: {
598
- readonly "application/json": {
599
- readonly schema: {
600
- readonly type: "object";
601
- readonly properties: {
602
- readonly org_id: {
603
- readonly type: "string";
604
- readonly description: "Organization ID";
605
- };
606
- readonly plan_id: {
607
- readonly type: "string";
608
- readonly description: "Price ID from the payment processor";
609
- };
610
- readonly coupon_id: {
611
- readonly type: "string";
612
- readonly description: "Coupon ID to apply";
613
- };
614
- readonly user_count: {
615
- readonly type: "integer";
616
- readonly description: "Number of users in the organization";
617
- };
618
- readonly email: {
619
- readonly type: "string";
620
- readonly format: "email";
621
- readonly description: "Email of the customer";
622
- };
623
- readonly payment_processor: {
624
- readonly type: "string";
625
- readonly enum: readonly ["stripe", "paypal", "braintree"];
626
- readonly description: "Supported payment processors";
627
- };
628
- };
629
- };
630
- };
631
- };
632
- };
633
- readonly responses: {
634
- readonly "200": {
635
- readonly description: "A new subscription has been created";
636
- readonly content: {
637
- readonly "application/json": {
638
- readonly schema: {
639
- readonly type: "object";
640
- readonly properties: {
641
- readonly subscription_id: {
642
- readonly type: "string";
643
- };
644
- readonly clientSecret: {
645
- readonly type: "string";
646
- };
647
- };
648
- };
649
- };
650
- };
651
- };
652
- readonly "400": {
653
- readonly description: "Invalid request";
654
- };
655
- readonly "500": {
656
- readonly description: "Internal server error";
657
- };
658
- };
659
- };
660
- };
661
- readonly "/api/entitlement/subscriptions/{subscriptionId}/upgrade": {
662
- readonly post: {
663
- readonly "x-internal": readonly ["cloud"];
664
- readonly summary: "Upgrade or downgrade an existing subscription by changing one of the plans in the subscription";
665
- readonly parameters: readonly [{
666
- readonly name: "subscriptionId";
667
- readonly in: "path";
668
- readonly required: true;
669
- readonly description: "Subscription ID";
670
- readonly schema: {
671
- readonly type: "string";
672
- };
673
- }];
674
- readonly requestBody: {
675
- readonly required: true;
676
- readonly content: {
677
- readonly "application/json": {
678
- readonly schema: {
679
- readonly type: "object";
680
- readonly properties: {
681
- readonly old_plan_id: {
682
- readonly description: "Old Plan id that is being changed";
683
- readonly type: "string";
684
- readonly format: "uuid";
685
- readonly "x-go-type": "uuid.UUID";
686
- readonly "x-go-type-import": {
687
- readonly path: "github.com/gofrs/uuid";
688
- };
689
- };
690
- readonly new_plan_id: {
691
- readonly description: "New Plan id that is being changed to";
692
- readonly type: "string";
693
- readonly format: "uuid";
694
- readonly "x-go-type": "uuid.UUID";
695
- readonly "x-go-type-import": {
696
- readonly path: "github.com/gofrs/uuid";
697
- };
698
- };
699
- };
700
- };
701
- };
702
- };
703
- };
704
- readonly responses: {
705
- readonly "200": {
706
- readonly content: {
707
- readonly "application/json": {
708
- readonly schema: {
709
- readonly type: "object";
710
- readonly properties: {
711
- readonly ID: {
712
- readonly "x-oapi-codegen-extra-tags": {
713
- readonly db: "id";
714
- };
715
- readonly type: "string";
716
- readonly format: "uuid";
717
- readonly description: "A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.";
718
- readonly "x-go-type": "uuid.UUID";
719
- readonly "x-go-type-import": {
720
- readonly path: "github.com/gofrs/uuid";
721
- };
722
- };
723
- readonly org_id: {
724
- readonly "x-oapi-codegen-extra-tags": {
725
- readonly db: "org_id";
726
- };
727
- readonly type: "string";
728
- readonly format: "uuid";
729
- readonly description: "A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.";
730
- readonly "x-go-type": "uuid.UUID";
731
- readonly "x-go-type-import": {
732
- readonly path: "github.com/gofrs/uuid";
733
- };
734
- };
735
- readonly plan_id: {
736
- readonly "x-oapi-codegen-extra-tags": {
737
- readonly db: "plan_id";
738
- };
739
- readonly type: "string";
740
- readonly format: "uuid";
741
- readonly description: "A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.";
742
- readonly "x-go-type": "uuid.UUID";
743
- readonly "x-go-type-import": {
744
- readonly path: "github.com/gofrs/uuid";
745
- };
746
- };
747
- readonly plan: {
748
- readonly "x-go-type": "plan.Plan";
749
- readonly "x-go-type-import": {
750
- readonly path: "github.com/meshery/schemas/models/v1beta1/plan";
751
- };
752
- readonly "x-oapi-codegen-extra-tags": {
753
- readonly belongs_to: "plans";
754
- readonly fk_id: "PlanId";
755
- readonly yaml: "plan,omitempty";
756
- readonly json: "plan,omitempty";
757
- };
758
- readonly type: "object";
759
- readonly properties: {
760
- readonly id: {
761
- readonly "x-oapi-codegen-extra-tags": {
762
- readonly db: "id";
763
- readonly json: "id";
764
- readonly csv: "id";
765
- };
766
- readonly type: "string";
767
- readonly format: "uuid";
768
- readonly description: "A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.";
769
- readonly "x-go-type": "uuid.UUID";
770
- readonly "x-go-type-import": {
771
- readonly path: "github.com/gofrs/uuid";
772
- };
773
- };
774
- readonly name: {
775
- readonly type: "string";
776
- readonly "x-go-type": "PlanName";
777
- readonly "x-oapi-codegen-extra-tags": {
778
- readonly db: "name";
779
- readonly json: "name";
780
- readonly csv: "name";
781
- };
782
- readonly description: "Name of the plan";
783
- readonly enum: readonly ["Free", "Team Designer", "Team Operator", "Enterprise"];
784
- };
785
- readonly cadence: {
786
- readonly "x-go-type": "PlanCadence";
787
- readonly "x-oapi-codegen-extra-tags": {
788
- readonly db: "cadence";
789
- readonly json: "cadence";
790
- readonly csv: "cadence";
791
- };
792
- readonly type: "string";
793
- readonly enum: readonly ["monthly", "yearly"];
794
- };
795
- readonly unit: {
796
- readonly "x-go-type": "PlanUnit";
797
- readonly "x-oapi-codegen-extra-tags": {
798
- readonly db: "unit";
799
- readonly json: "unit";
800
- readonly csv: "unit";
801
- };
802
- readonly type: "string";
803
- readonly enum: readonly ["user", "free"];
804
- };
805
- readonly minimum_units: {
806
- readonly type: "integer";
807
- readonly description: "Minimum number of units required for the plan";
808
- readonly "x-oapi-codegen-extra-tags": {
809
- readonly db: "minimum_units";
810
- readonly json: "minimum_units";
811
- readonly csv: "minimum_units";
812
- };
813
- };
814
- readonly price_per_unit: {
815
- readonly type: "number";
816
- readonly description: "Price per unit of the plan";
817
- readonly "x-oapi-codegen-extra-tags": {
818
- readonly db: "price_per_unit";
819
- readonly json: "price_per_unit";
820
- readonly csv: "price_per_unit";
821
- };
822
- };
823
- readonly currency: {
824
- readonly "x-go-type": "Currency";
825
- readonly "x-oapi-codegen-extra-tags": {
826
- readonly db: "currency";
827
- readonly json: "currency";
828
- readonly csv: "currency";
829
- };
830
- readonly type: "string";
831
- readonly enum: readonly ["usd"];
832
- };
833
- };
834
- readonly required: readonly ["id", "name", "cadence", "unit", "price_per_unit", "minimum_units", "price_id", "currency"];
835
- };
836
- readonly quantity: {
837
- readonly decscription: "number of units subscribed (eg number of users)";
838
- readonly type: "integer";
839
- readonly "x-oapi-codegen-extra-tags": {
840
- readonly db: "quantity";
841
- };
842
- };
843
- readonly start_date: {
844
- readonly "x-oapi-codegen-extra-tags": {
845
- readonly db: "start_date";
846
- };
847
- readonly type: "string";
848
- readonly format: "date-time";
849
- readonly "x-go-type-skip-optional-pointer": true;
850
- };
851
- readonly end_date: {
852
- readonly "x-oapi-codegen-extra-tags": {
853
- readonly db: "end_date";
854
- };
855
- readonly type: "string";
856
- readonly format: "date-time";
857
- readonly "x-go-type-skip-optional-pointer": true;
858
- };
859
- readonly status: {
860
- readonly "x-go-type": "SubscriptionStatus";
861
- readonly "x-oapi-codegen-extra-tags": {
862
- readonly db: "status";
863
- };
864
- readonly type: "string";
865
- readonly description: "Possible statuses of a Stripe subscription.";
866
- readonly enum: readonly ["incomplete", "incomplete_expired", "trialing", "active", "past_due", "canceled", "unpaid"];
867
- readonly "x-enumDescriptions": {
868
- readonly incomplete: "The subscription has been created, but the initial payment is pending. It may transition to 'active' or 'incomplete_expired'.";
869
- readonly incomplete_expired: "The subscription was created but never activated due to failed initial payment. It is now expired.";
870
- readonly trialing: "The subscription is currently in a trial period before the first payment is due.";
871
- readonly active: "The subscription is active, and billing is functioning normally.";
872
- readonly past_due: "The latest payment attempt failed, but the subscription remains active. Stripe may retry the charge.";
873
- readonly canceled: "The subscription has been canceled and will no longer generate invoices.";
874
- readonly unpaid: "The subscription is still technically active but has unpaid invoices and is no longer generating new invoices.";
875
- };
876
- };
877
- readonly created_at: {
878
- readonly "x-oapi-codegen-extra-tags": {
879
- readonly db: "created_at";
880
- };
881
- readonly type: "string";
882
- readonly format: "date-time";
883
- readonly "x-go-type-skip-optional-pointer": true;
884
- };
885
- readonly updated_at: {
886
- readonly "x-oapi-codegen-extra-tags": {
887
- readonly db: "updated_at";
888
- };
889
- readonly type: "string";
890
- readonly format: "date-time";
891
- readonly "x-go-type-skip-optional-pointer": true;
892
- };
893
- readonly deleted_at: {
894
- readonly "x-oapi-codegen-extra-tags": {
895
- readonly db: "deleted_at";
896
- };
897
- readonly type: "string";
898
- readonly format: "date-time";
899
- readonly "x-go-type": "sql.NullTime";
900
- readonly "x-go-type-import": {
901
- readonly path: "database/sql";
902
- };
903
- readonly "x-go-type-skip-optional-pointer": true;
904
- };
905
- readonly billing_id: {
906
- readonly type: "string";
907
- readonly description: "Billing ID of the subscription. This is the ID of the subscription in the billing system. eg Stripe";
908
- readonly "x-oapi-codegen-extra-tags": {
909
- readonly db: "billing_id";
910
- };
911
- };
912
- };
913
- readonly required: readonly ["ID", "org_id", "plan_id", "billing_id", "status", "quantity"];
914
- };
915
- };
916
- };
917
- };
918
- readonly "400": {
919
- readonly description: "Invalid request";
920
- };
921
- readonly "500": {
922
- readonly description: "Internal server error";
923
- };
924
- };
925
- };
926
- };
927
- readonly "/api/entitlement/subscriptions/{subscriptionId}/upgradePreview": {
928
- readonly post: {
929
- readonly "x-internal": readonly ["cloud"];
930
- readonly summary: "Preview the invoice for upgrading or downgrading an existing subscription by changing one of the plans in the subscription";
931
- readonly parameters: readonly [{
932
- readonly name: "subscriptionId";
933
- readonly in: "path";
934
- readonly required: true;
935
- readonly description: "Subscription ID";
936
- readonly schema: {
937
- readonly type: "string";
938
- };
939
- }];
940
- readonly requestBody: {
941
- readonly required: true;
942
- readonly content: {
943
- readonly "application/json": {
944
- readonly schema: {
945
- readonly type: "object";
946
- readonly properties: {
947
- readonly old_plan_id: {
948
- readonly description: "Old Plan id that is being changed";
949
- readonly type: "string";
950
- readonly format: "uuid";
951
- readonly "x-go-type": "uuid.UUID";
952
- readonly "x-go-type-import": {
953
- readonly path: "github.com/gofrs/uuid";
954
- };
955
- };
956
- readonly new_plan_id: {
957
- readonly description: "New Plan id that is being changed to";
958
- readonly type: "string";
959
- readonly format: "uuid";
960
- readonly "x-go-type": "uuid.UUID";
961
- readonly "x-go-type-import": {
962
- readonly path: "github.com/gofrs/uuid";
963
- };
964
- };
965
- };
966
- };
967
- };
968
- };
969
- };
970
- readonly responses: {
971
- readonly "200": {
972
- readonly description: "Preview of the upgraded subscription invoice";
973
- readonly content: {
974
- readonly "application/json": {
975
- readonly schema: {
976
- readonly type: "object";
977
- };
978
- };
979
- };
980
- };
981
- readonly "400": {
982
- readonly description: "Invalid request";
983
- };
984
- readonly "500": {
985
- readonly description: "Internal server error";
986
- };
987
- };
988
- };
989
- };
990
- readonly "/api/entitlement/subscriptions/webhooks": {
991
- readonly post: {
992
- readonly "x-internal": readonly ["cloud"];
993
- readonly summary: "Handle webhook events from payment processors";
994
- readonly requestBody: {
995
- readonly required: true;
996
- readonly content: {
997
- readonly "application/json": {
998
- readonly schema: {
999
- readonly type: "object";
1000
- readonly description: "Payload for webhook events from payment processors";
1001
- };
1002
- };
1003
- };
1004
- };
1005
- readonly responses: {
1006
- readonly "200": {
1007
- readonly description: "Webhook processed successfully";
1008
- };
1009
- readonly "400": {
1010
- readonly description: "Invalid webhook event";
1011
- };
1012
- };
1013
- };
1014
- };
1015
- };
1016
- readonly components: {
1017
- readonly responses: {
1018
- readonly "400": {
1019
- readonly description: "Invalid request body or request param";
1020
- readonly content: {
1021
- readonly "text/plain": {
1022
- readonly schema: {
1023
- readonly type: "string";
1024
- };
1025
- };
1026
- };
1027
- };
1028
- readonly "401": {
1029
- readonly description: "Expired JWT token used or insufficient privilege";
1030
- readonly content: {
1031
- readonly "text/plain": {
1032
- readonly schema: {
1033
- readonly type: "string";
1034
- };
1035
- };
1036
- };
1037
- };
1038
- readonly "500": {
1039
- readonly description: "Internal server error";
1040
- readonly content: {
1041
- readonly "text/plain": {
1042
- readonly schema: {
1043
- readonly type: "string";
1044
- };
1045
- };
1046
- };
1047
- };
1048
- };
1049
- readonly parameters: {
1050
- readonly subscriptionId: {
1051
- readonly name: "subscriptionId";
1052
- readonly in: "path";
1053
- readonly required: true;
1054
- readonly description: "Subscription ID";
1055
- readonly schema: {
1056
- readonly type: "string";
1057
- };
1058
- };
1059
- readonly page: {
1060
- readonly name: "page";
1061
- readonly in: "query";
1062
- readonly description: "Get responses by page";
1063
- readonly schema: {
1064
- readonly type: "string";
1065
- };
1066
- };
1067
- readonly pagesize: {
1068
- readonly name: "pagesize";
1069
- readonly in: "query";
1070
- readonly description: "Get responses by pagesize";
1071
- readonly schema: {
1072
- readonly type: "string";
1073
- };
1074
- };
1075
- readonly pagesizeWithAll: {
1076
- readonly name: "pagesize";
1077
- readonly in: "query";
1078
- readonly description: "Get responses by pagesize (pass all to get all responses)";
1079
- readonly schema: {
1080
- readonly type: "string";
1081
- };
1082
- };
1083
- readonly order: {
1084
- readonly name: "order";
1085
- readonly in: "query";
1086
- readonly description: "Get ordered responses";
1087
- readonly schema: {
1088
- readonly type: "string";
1089
- };
1090
- };
1091
- };
1092
- readonly schemas: {
1093
- readonly PaymentProcessor: {
1094
- readonly type: "string";
1095
- readonly enum: readonly ["stripe", "paypal", "braintree"];
1096
- readonly description: "Supported payment processors";
1097
- };
1098
- readonly CreateSubscriptionRequest: {
1099
- readonly type: "object";
1100
- readonly properties: {
1101
- readonly org_id: {
1102
- readonly type: "string";
1103
- readonly description: "Organization ID";
1104
- };
1105
- readonly plan_id: {
1106
- readonly type: "string";
1107
- readonly description: "Price ID from the payment processor";
1108
- };
1109
- readonly coupon_id: {
1110
- readonly type: "string";
1111
- readonly description: "Coupon ID to apply";
1112
- };
1113
- readonly user_count: {
1114
- readonly type: "integer";
1115
- readonly description: "Number of users in the organization";
1116
- };
1117
- readonly email: {
1118
- readonly type: "string";
1119
- readonly format: "email";
1120
- readonly description: "Email of the customer";
1121
- };
1122
- readonly payment_processor: {
1123
- readonly type: "string";
1124
- readonly enum: readonly ["stripe", "paypal", "braintree"];
1125
- readonly description: "Supported payment processors";
1126
- };
1127
- };
1128
- };
1129
- readonly UpgradeSubscriptionRequest: {
1130
- readonly type: "object";
1131
- readonly properties: {
1132
- readonly old_plan_id: {
1133
- readonly description: "Old Plan id that is being changed";
1134
- readonly type: "string";
1135
- readonly format: "uuid";
1136
- readonly "x-go-type": "uuid.UUID";
1137
- readonly "x-go-type-import": {
1138
- readonly path: "github.com/gofrs/uuid";
1139
- };
1140
- };
1141
- readonly new_plan_id: {
1142
- readonly description: "New Plan id that is being changed to";
1143
- readonly type: "string";
1144
- readonly format: "uuid";
1145
- readonly "x-go-type": "uuid.UUID";
1146
- readonly "x-go-type-import": {
1147
- readonly path: "github.com/gofrs/uuid";
1148
- };
1149
- };
1150
- };
1151
- };
1152
- readonly CreateSubscriptionResponse: {
1153
- readonly type: "object";
1154
- readonly properties: {
1155
- readonly subscription_id: {
1156
- readonly type: "string";
1157
- };
1158
- readonly clientSecret: {
1159
- readonly type: "string";
1160
- };
1161
- };
1162
- };
1163
- readonly UpdateUsersRequest: {
1164
- readonly type: "object";
1165
- readonly properties: {
1166
- readonly payment_processor: {
1167
- readonly type: "string";
1168
- readonly enum: readonly ["stripe", "paypal", "braintree"];
1169
- readonly description: "Supported payment processors";
1170
- };
1171
- };
1172
- };
1173
- readonly CancelSubscriptionRequest: {
1174
- readonly type: "object";
1175
- readonly properties: {
1176
- readonly subscription_id: {
1177
- readonly type: "string";
1178
- readonly description: "Subscription ID from the payment processor";
1179
- };
1180
- readonly payment_processor: {
1181
- readonly type: "string";
1182
- readonly enum: readonly ["stripe", "paypal", "braintree"];
1183
- readonly description: "Supported payment processors";
1184
- };
1185
- };
1186
- };
1187
- readonly WebhookEvent: {
1188
- readonly type: "object";
1189
- readonly description: "Payload for webhook events from payment processors";
1190
- };
1191
- readonly SubscriptionPage: {
1192
- readonly type: "object";
1193
- readonly required: readonly ["page", "page_size", "total_count", "subscriptions"];
1194
- readonly properties: {
1195
- readonly page: {
1196
- readonly type: "integer";
1197
- };
1198
- readonly page_size: {
1199
- readonly type: "integer";
1200
- };
1201
- readonly total_count: {
1202
- readonly type: "integer";
1203
- };
1204
- readonly subscriptions: {
1205
- readonly type: "array";
1206
- readonly items: {
1207
- readonly "x-go-type": "Subscription";
1208
- readonly type: "object";
1209
- readonly properties: {
1210
- readonly ID: {
1211
- readonly "x-oapi-codegen-extra-tags": {
1212
- readonly db: "id";
1213
- };
1214
- readonly type: "string";
1215
- readonly format: "uuid";
1216
- readonly description: "A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.";
1217
- readonly "x-go-type": "uuid.UUID";
1218
- readonly "x-go-type-import": {
1219
- readonly path: "github.com/gofrs/uuid";
1220
- };
1221
- };
1222
- readonly org_id: {
1223
- readonly "x-oapi-codegen-extra-tags": {
1224
- readonly db: "org_id";
1225
- };
1226
- readonly type: "string";
1227
- readonly format: "uuid";
1228
- readonly description: "A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.";
1229
- readonly "x-go-type": "uuid.UUID";
1230
- readonly "x-go-type-import": {
1231
- readonly path: "github.com/gofrs/uuid";
1232
- };
1233
- };
1234
- readonly plan_id: {
1235
- readonly "x-oapi-codegen-extra-tags": {
1236
- readonly db: "plan_id";
1237
- };
1238
- readonly type: "string";
1239
- readonly format: "uuid";
1240
- readonly description: "A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.";
1241
- readonly "x-go-type": "uuid.UUID";
1242
- readonly "x-go-type-import": {
1243
- readonly path: "github.com/gofrs/uuid";
1244
- };
1245
- };
1246
- readonly plan: {
1247
- readonly "x-go-type": "plan.Plan";
1248
- readonly "x-go-type-import": {
1249
- readonly path: "github.com/meshery/schemas/models/v1beta1/plan";
1250
- };
1251
- readonly "x-oapi-codegen-extra-tags": {
1252
- readonly belongs_to: "plans";
1253
- readonly fk_id: "PlanId";
1254
- readonly yaml: "plan,omitempty";
1255
- readonly json: "plan,omitempty";
1256
- };
1257
- readonly type: "object";
1258
- readonly properties: {
1259
- readonly id: {
1260
- readonly "x-oapi-codegen-extra-tags": {
1261
- readonly db: "id";
1262
- readonly json: "id";
1263
- readonly csv: "id";
1264
- };
1265
- readonly type: "string";
1266
- readonly format: "uuid";
1267
- readonly description: "A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.";
1268
- readonly "x-go-type": "uuid.UUID";
1269
- readonly "x-go-type-import": {
1270
- readonly path: "github.com/gofrs/uuid";
1271
- };
1272
- };
1273
- readonly name: {
1274
- readonly type: "string";
1275
- readonly "x-go-type": "PlanName";
1276
- readonly "x-oapi-codegen-extra-tags": {
1277
- readonly db: "name";
1278
- readonly json: "name";
1279
- readonly csv: "name";
1280
- };
1281
- readonly description: "Name of the plan";
1282
- readonly enum: readonly ["Free", "Team Designer", "Team Operator", "Enterprise"];
1283
- };
1284
- readonly cadence: {
1285
- readonly "x-go-type": "PlanCadence";
1286
- readonly "x-oapi-codegen-extra-tags": {
1287
- readonly db: "cadence";
1288
- readonly json: "cadence";
1289
- readonly csv: "cadence";
1290
- };
1291
- readonly type: "string";
1292
- readonly enum: readonly ["monthly", "yearly"];
1293
- };
1294
- readonly unit: {
1295
- readonly "x-go-type": "PlanUnit";
1296
- readonly "x-oapi-codegen-extra-tags": {
1297
- readonly db: "unit";
1298
- readonly json: "unit";
1299
- readonly csv: "unit";
1300
- };
1301
- readonly type: "string";
1302
- readonly enum: readonly ["user", "free"];
1303
- };
1304
- readonly minimum_units: {
1305
- readonly type: "integer";
1306
- readonly description: "Minimum number of units required for the plan";
1307
- readonly "x-oapi-codegen-extra-tags": {
1308
- readonly db: "minimum_units";
1309
- readonly json: "minimum_units";
1310
- readonly csv: "minimum_units";
1311
- };
1312
- };
1313
- readonly price_per_unit: {
1314
- readonly type: "number";
1315
- readonly description: "Price per unit of the plan";
1316
- readonly "x-oapi-codegen-extra-tags": {
1317
- readonly db: "price_per_unit";
1318
- readonly json: "price_per_unit";
1319
- readonly csv: "price_per_unit";
1320
- };
1321
- };
1322
- readonly currency: {
1323
- readonly "x-go-type": "Currency";
1324
- readonly "x-oapi-codegen-extra-tags": {
1325
- readonly db: "currency";
1326
- readonly json: "currency";
1327
- readonly csv: "currency";
1328
- };
1329
- readonly type: "string";
1330
- readonly enum: readonly ["usd"];
1331
- };
1332
- };
1333
- readonly required: readonly ["id", "name", "cadence", "unit", "price_per_unit", "minimum_units", "price_id", "currency"];
1334
- };
1335
- readonly quantity: {
1336
- readonly decscription: "number of units subscribed (eg number of users)";
1337
- readonly type: "integer";
1338
- readonly "x-oapi-codegen-extra-tags": {
1339
- readonly db: "quantity";
1340
- };
1341
- };
1342
- readonly start_date: {
1343
- readonly "x-oapi-codegen-extra-tags": {
1344
- readonly db: "start_date";
1345
- };
1346
- readonly type: "string";
1347
- readonly format: "date-time";
1348
- readonly "x-go-type-skip-optional-pointer": true;
1349
- };
1350
- readonly end_date: {
1351
- readonly "x-oapi-codegen-extra-tags": {
1352
- readonly db: "end_date";
1353
- };
1354
- readonly type: "string";
1355
- readonly format: "date-time";
1356
- readonly "x-go-type-skip-optional-pointer": true;
1357
- };
1358
- readonly status: {
1359
- readonly "x-go-type": "SubscriptionStatus";
1360
- readonly "x-oapi-codegen-extra-tags": {
1361
- readonly db: "status";
1362
- };
1363
- readonly type: "string";
1364
- readonly description: "Possible statuses of a Stripe subscription.";
1365
- readonly enum: readonly ["incomplete", "incomplete_expired", "trialing", "active", "past_due", "canceled", "unpaid"];
1366
- readonly "x-enumDescriptions": {
1367
- readonly incomplete: "The subscription has been created, but the initial payment is pending. It may transition to 'active' or 'incomplete_expired'.";
1368
- readonly incomplete_expired: "The subscription was created but never activated due to failed initial payment. It is now expired.";
1369
- readonly trialing: "The subscription is currently in a trial period before the first payment is due.";
1370
- readonly active: "The subscription is active, and billing is functioning normally.";
1371
- readonly past_due: "The latest payment attempt failed, but the subscription remains active. Stripe may retry the charge.";
1372
- readonly canceled: "The subscription has been canceled and will no longer generate invoices.";
1373
- readonly unpaid: "The subscription is still technically active but has unpaid invoices and is no longer generating new invoices.";
1374
- };
1375
- };
1376
- readonly created_at: {
1377
- readonly "x-oapi-codegen-extra-tags": {
1378
- readonly db: "created_at";
1379
- };
1380
- readonly type: "string";
1381
- readonly format: "date-time";
1382
- readonly "x-go-type-skip-optional-pointer": true;
1383
- };
1384
- readonly updated_at: {
1385
- readonly "x-oapi-codegen-extra-tags": {
1386
- readonly db: "updated_at";
1387
- };
1388
- readonly type: "string";
1389
- readonly format: "date-time";
1390
- readonly "x-go-type-skip-optional-pointer": true;
1391
- };
1392
- readonly deleted_at: {
1393
- readonly "x-oapi-codegen-extra-tags": {
1394
- readonly db: "deleted_at";
1395
- };
1396
- readonly type: "string";
1397
- readonly format: "date-time";
1398
- readonly "x-go-type": "sql.NullTime";
1399
- readonly "x-go-type-import": {
1400
- readonly path: "database/sql";
1401
- };
1402
- readonly "x-go-type-skip-optional-pointer": true;
1403
- };
1404
- readonly billing_id: {
1405
- readonly type: "string";
1406
- readonly description: "Billing ID of the subscription. This is the ID of the subscription in the billing system. eg Stripe";
1407
- readonly "x-oapi-codegen-extra-tags": {
1408
- readonly db: "billing_id";
1409
- };
1410
- };
1411
- };
1412
- readonly required: readonly ["ID", "org_id", "plan_id", "billing_id", "status", "quantity"];
1413
- };
1414
- };
1415
- };
1416
- };
1417
- readonly Subscription: {
1418
- readonly type: "object";
1419
- readonly properties: {
1420
- readonly ID: {
1421
- readonly "x-oapi-codegen-extra-tags": {
1422
- readonly db: "id";
1423
- };
1424
- readonly type: "string";
1425
- readonly format: "uuid";
1426
- readonly description: "A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.";
1427
- readonly "x-go-type": "uuid.UUID";
1428
- readonly "x-go-type-import": {
1429
- readonly path: "github.com/gofrs/uuid";
1430
- };
1431
- };
1432
- readonly org_id: {
1433
- readonly "x-oapi-codegen-extra-tags": {
1434
- readonly db: "org_id";
1435
- };
1436
- readonly type: "string";
1437
- readonly format: "uuid";
1438
- readonly description: "A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.";
1439
- readonly "x-go-type": "uuid.UUID";
1440
- readonly "x-go-type-import": {
1441
- readonly path: "github.com/gofrs/uuid";
1442
- };
1443
- };
1444
- readonly plan_id: {
1445
- readonly "x-oapi-codegen-extra-tags": {
1446
- readonly db: "plan_id";
1447
- };
1448
- readonly type: "string";
1449
- readonly format: "uuid";
1450
- readonly description: "A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.";
1451
- readonly "x-go-type": "uuid.UUID";
1452
- readonly "x-go-type-import": {
1453
- readonly path: "github.com/gofrs/uuid";
1454
- };
1455
- };
1456
- readonly plan: {
1457
- readonly "x-go-type": "plan.Plan";
1458
- readonly "x-go-type-import": {
1459
- readonly path: "github.com/meshery/schemas/models/v1beta1/plan";
1460
- };
1461
- readonly "x-oapi-codegen-extra-tags": {
1462
- readonly belongs_to: "plans";
1463
- readonly fk_id: "PlanId";
1464
- readonly yaml: "plan,omitempty";
1465
- readonly json: "plan,omitempty";
1466
- };
1467
- readonly type: "object";
1468
- readonly properties: {
1469
- readonly id: {
1470
- readonly "x-oapi-codegen-extra-tags": {
1471
- readonly db: "id";
1472
- readonly json: "id";
1473
- readonly csv: "id";
1474
- };
1475
- readonly type: "string";
1476
- readonly format: "uuid";
1477
- readonly description: "A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.";
1478
- readonly "x-go-type": "uuid.UUID";
1479
- readonly "x-go-type-import": {
1480
- readonly path: "github.com/gofrs/uuid";
1481
- };
1482
- };
1483
- readonly name: {
1484
- readonly type: "string";
1485
- readonly "x-go-type": "PlanName";
1486
- readonly "x-oapi-codegen-extra-tags": {
1487
- readonly db: "name";
1488
- readonly json: "name";
1489
- readonly csv: "name";
1490
- };
1491
- readonly description: "Name of the plan";
1492
- readonly enum: readonly ["Free", "Team Designer", "Team Operator", "Enterprise"];
1493
- };
1494
- readonly cadence: {
1495
- readonly "x-go-type": "PlanCadence";
1496
- readonly "x-oapi-codegen-extra-tags": {
1497
- readonly db: "cadence";
1498
- readonly json: "cadence";
1499
- readonly csv: "cadence";
1500
- };
1501
- readonly type: "string";
1502
- readonly enum: readonly ["monthly", "yearly"];
1503
- };
1504
- readonly unit: {
1505
- readonly "x-go-type": "PlanUnit";
1506
- readonly "x-oapi-codegen-extra-tags": {
1507
- readonly db: "unit";
1508
- readonly json: "unit";
1509
- readonly csv: "unit";
1510
- };
1511
- readonly type: "string";
1512
- readonly enum: readonly ["user", "free"];
1513
- };
1514
- readonly minimum_units: {
1515
- readonly type: "integer";
1516
- readonly description: "Minimum number of units required for the plan";
1517
- readonly "x-oapi-codegen-extra-tags": {
1518
- readonly db: "minimum_units";
1519
- readonly json: "minimum_units";
1520
- readonly csv: "minimum_units";
1521
- };
1522
- };
1523
- readonly price_per_unit: {
1524
- readonly type: "number";
1525
- readonly description: "Price per unit of the plan";
1526
- readonly "x-oapi-codegen-extra-tags": {
1527
- readonly db: "price_per_unit";
1528
- readonly json: "price_per_unit";
1529
- readonly csv: "price_per_unit";
1530
- };
1531
- };
1532
- readonly currency: {
1533
- readonly "x-go-type": "Currency";
1534
- readonly "x-oapi-codegen-extra-tags": {
1535
- readonly db: "currency";
1536
- readonly json: "currency";
1537
- readonly csv: "currency";
1538
- };
1539
- readonly type: "string";
1540
- readonly enum: readonly ["usd"];
1541
- };
1542
- };
1543
- readonly required: readonly ["id", "name", "cadence", "unit", "price_per_unit", "minimum_units", "price_id", "currency"];
1544
- };
1545
- readonly quantity: {
1546
- readonly decscription: "number of units subscribed (eg number of users)";
1547
- readonly type: "integer";
1548
- readonly "x-oapi-codegen-extra-tags": {
1549
- readonly db: "quantity";
1550
- };
1551
- };
1552
- readonly start_date: {
1553
- readonly "x-oapi-codegen-extra-tags": {
1554
- readonly db: "start_date";
1555
- };
1556
- readonly type: "string";
1557
- readonly format: "date-time";
1558
- readonly "x-go-type-skip-optional-pointer": true;
1559
- };
1560
- readonly end_date: {
1561
- readonly "x-oapi-codegen-extra-tags": {
1562
- readonly db: "end_date";
1563
- };
1564
- readonly type: "string";
1565
- readonly format: "date-time";
1566
- readonly "x-go-type-skip-optional-pointer": true;
1567
- };
1568
- readonly status: {
1569
- readonly "x-go-type": "SubscriptionStatus";
1570
- readonly "x-oapi-codegen-extra-tags": {
1571
- readonly db: "status";
1572
- };
1573
- readonly type: "string";
1574
- readonly description: "Possible statuses of a Stripe subscription.";
1575
- readonly enum: readonly ["incomplete", "incomplete_expired", "trialing", "active", "past_due", "canceled", "unpaid"];
1576
- readonly "x-enumDescriptions": {
1577
- readonly incomplete: "The subscription has been created, but the initial payment is pending. It may transition to 'active' or 'incomplete_expired'.";
1578
- readonly incomplete_expired: "The subscription was created but never activated due to failed initial payment. It is now expired.";
1579
- readonly trialing: "The subscription is currently in a trial period before the first payment is due.";
1580
- readonly active: "The subscription is active, and billing is functioning normally.";
1581
- readonly past_due: "The latest payment attempt failed, but the subscription remains active. Stripe may retry the charge.";
1582
- readonly canceled: "The subscription has been canceled and will no longer generate invoices.";
1583
- readonly unpaid: "The subscription is still technically active but has unpaid invoices and is no longer generating new invoices.";
1584
- };
1585
- };
1586
- readonly created_at: {
1587
- readonly "x-oapi-codegen-extra-tags": {
1588
- readonly db: "created_at";
1589
- };
1590
- readonly type: "string";
1591
- readonly format: "date-time";
1592
- readonly "x-go-type-skip-optional-pointer": true;
1593
- };
1594
- readonly updated_at: {
1595
- readonly "x-oapi-codegen-extra-tags": {
1596
- readonly db: "updated_at";
1597
- };
1598
- readonly type: "string";
1599
- readonly format: "date-time";
1600
- readonly "x-go-type-skip-optional-pointer": true;
1601
- };
1602
- readonly deleted_at: {
1603
- readonly "x-oapi-codegen-extra-tags": {
1604
- readonly db: "deleted_at";
1605
- };
1606
- readonly type: "string";
1607
- readonly format: "date-time";
1608
- readonly "x-go-type": "sql.NullTime";
1609
- readonly "x-go-type-import": {
1610
- readonly path: "database/sql";
1611
- };
1612
- readonly "x-go-type-skip-optional-pointer": true;
1613
- };
1614
- readonly billing_id: {
1615
- readonly type: "string";
1616
- readonly description: "Billing ID of the subscription. This is the ID of the subscription in the billing system. eg Stripe";
1617
- readonly "x-oapi-codegen-extra-tags": {
1618
- readonly db: "billing_id";
1619
- };
1620
- };
1621
- };
1622
- readonly required: readonly ["ID", "org_id", "plan_id", "billing_id", "status", "quantity"];
1623
- };
1624
- readonly SubscriptionStatus: {
1625
- readonly type: "string";
1626
- readonly description: "Possible statuses of a Stripe subscription.";
1627
- readonly enum: readonly ["incomplete", "incomplete_expired", "trialing", "active", "past_due", "canceled", "unpaid"];
1628
- readonly "x-enumDescriptions": {
1629
- readonly incomplete: "The subscription has been created, but the initial payment is pending. It may transition to 'active' or 'incomplete_expired'.";
1630
- readonly incomplete_expired: "The subscription was created but never activated due to failed initial payment. It is now expired.";
1631
- readonly trialing: "The subscription is currently in a trial period before the first payment is due.";
1632
- readonly active: "The subscription is active, and billing is functioning normally.";
1633
- readonly past_due: "The latest payment attempt failed, but the subscription remains active. Stripe may retry the charge.";
1634
- readonly canceled: "The subscription has been canceled and will no longer generate invoices.";
1635
- readonly unpaid: "The subscription is still technically active but has unpaid invoices and is no longer generating new invoices.";
1636
- };
1637
- };
1638
- };
1639
- };
1640
- };
5
+ declare const SubscriptionSchema: Record<string, unknown>;
1641
6
 
1642
7
  export { SubscriptionSchema as default };