@paynow-gg/typescript-sdk 1.0.27 → 1.0.29
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/generate.js +1 -0
- package/dist/generate.js.map +1 -1
- package/dist/generated/management.d.ts +74 -6
- package/dist/generated/management.d.ts.map +1 -1
- package/dist/generated/management.js +4 -0
- package/dist/generated/management.js.map +1 -1
- package/dist/generated/storefront.d.ts +6 -0
- package/dist/generated/storefront.d.ts.map +1 -1
- package/dist/generated/storefront.js.map +1 -1
- package/dist/generated/webhooks.d.ts +2891 -0
- package/dist/generated/webhooks.d.ts.map +1 -0
- package/dist/generated/webhooks.js +5 -0
- package/dist/generated/webhooks.js.map +1 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js.map +1 -1
- package/dist/types.d.ts +12 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/types.js +3 -0
- package/dist/types.js.map +1 -0
- package/package.json +1 -1
|
@@ -0,0 +1,2891 @@
|
|
|
1
|
+
export type paths = Record<string, never>;
|
|
2
|
+
export interface webhooks {
|
|
3
|
+
OnSubscriptionRenewed: {
|
|
4
|
+
parameters: {
|
|
5
|
+
query?: never;
|
|
6
|
+
header?: never;
|
|
7
|
+
path?: never;
|
|
8
|
+
cookie?: never;
|
|
9
|
+
};
|
|
10
|
+
get?: never;
|
|
11
|
+
put?: never;
|
|
12
|
+
/**
|
|
13
|
+
* Triggered when a subscription is renewed
|
|
14
|
+
* @description Webhook for OnSubscriptionRenewed
|
|
15
|
+
*/
|
|
16
|
+
post: {
|
|
17
|
+
parameters: {
|
|
18
|
+
query?: never;
|
|
19
|
+
header?: never;
|
|
20
|
+
path?: never;
|
|
21
|
+
cookie?: never;
|
|
22
|
+
};
|
|
23
|
+
requestBody: {
|
|
24
|
+
content: {
|
|
25
|
+
"application/json": {
|
|
26
|
+
event_type: components["schemas"]["WebhookEventType"];
|
|
27
|
+
/**
|
|
28
|
+
* Format: flake-id
|
|
29
|
+
* @description The ID of the Webhook Event
|
|
30
|
+
* @example 411486491630370816
|
|
31
|
+
*/
|
|
32
|
+
event_id?: string;
|
|
33
|
+
body: {
|
|
34
|
+
/**
|
|
35
|
+
* Format: flake-id
|
|
36
|
+
* @description The Flake ID of the Subscription
|
|
37
|
+
* @example 411486491630370816
|
|
38
|
+
*/
|
|
39
|
+
id?: string;
|
|
40
|
+
/**
|
|
41
|
+
* Format: flake-id
|
|
42
|
+
* @description The Flake ID of the Store associated with the Subscription
|
|
43
|
+
* @example 411486491630370816
|
|
44
|
+
*/
|
|
45
|
+
store_id?: string;
|
|
46
|
+
/**
|
|
47
|
+
* Format: flake-id
|
|
48
|
+
* @description The Flake ID of the Customer associated with the Subscription
|
|
49
|
+
* @example 411486491630370816
|
|
50
|
+
*/
|
|
51
|
+
customer_id?: string;
|
|
52
|
+
customer?: components["schemas"]["CustomerDTO"];
|
|
53
|
+
/**
|
|
54
|
+
* @description The current billing cycle number
|
|
55
|
+
* @example 2
|
|
56
|
+
*/
|
|
57
|
+
billing_cycle_sequence?: number;
|
|
58
|
+
/**
|
|
59
|
+
* @description The billing email address of the customer associated with the Subscription
|
|
60
|
+
* @example john@doe.com
|
|
61
|
+
*/
|
|
62
|
+
billing_email?: string;
|
|
63
|
+
/**
|
|
64
|
+
* @description The subtotal amount of the Subscription represented in cents
|
|
65
|
+
* @example 8999
|
|
66
|
+
*/
|
|
67
|
+
subtotal_amount?: number;
|
|
68
|
+
/**
|
|
69
|
+
* @description The tax amount of the Subscription represented in cents
|
|
70
|
+
* @example 1350
|
|
71
|
+
*/
|
|
72
|
+
tax_amount?: number;
|
|
73
|
+
/**
|
|
74
|
+
* @description The discount amount applied to the Subscription represented in cents
|
|
75
|
+
* @example 0
|
|
76
|
+
*/
|
|
77
|
+
discount_amount?: number;
|
|
78
|
+
/**
|
|
79
|
+
* @description The total amount of the Subscription represented in cents
|
|
80
|
+
* @example 10349
|
|
81
|
+
*/
|
|
82
|
+
total_amount?: number;
|
|
83
|
+
/**
|
|
84
|
+
* @description The currency code of the Subscription
|
|
85
|
+
* @example USD
|
|
86
|
+
*/
|
|
87
|
+
currency?: string;
|
|
88
|
+
/**
|
|
89
|
+
* @description The interval value of the billing cycle
|
|
90
|
+
* @example 1
|
|
91
|
+
*/
|
|
92
|
+
interval_value?: number;
|
|
93
|
+
/**
|
|
94
|
+
* @description The interval scale of the billing cycle
|
|
95
|
+
* @example month
|
|
96
|
+
*/
|
|
97
|
+
interval_scale?: string;
|
|
98
|
+
/**
|
|
99
|
+
* Format: flake-id
|
|
100
|
+
* @description The Flake ID of the Product associated with the Subscription
|
|
101
|
+
* @example 411486491630370816
|
|
102
|
+
*/
|
|
103
|
+
product_id?: string;
|
|
104
|
+
/**
|
|
105
|
+
* Format: flake-id
|
|
106
|
+
* @description The Flake ID of the Product Version associated with the Subscription
|
|
107
|
+
* @example 411486491630370816
|
|
108
|
+
*/
|
|
109
|
+
product_version_id?: string;
|
|
110
|
+
/**
|
|
111
|
+
* @description The name of the Product associated with the Subscription
|
|
112
|
+
* @example Example Product
|
|
113
|
+
*/
|
|
114
|
+
product_name?: string;
|
|
115
|
+
/**
|
|
116
|
+
* @description The image URL of the Product associated with the Subscription
|
|
117
|
+
* @example https://example.com/biz.jpg
|
|
118
|
+
*/
|
|
119
|
+
product_image_url?: string;
|
|
120
|
+
product?: components["schemas"]["ProductDTO"];
|
|
121
|
+
/**
|
|
122
|
+
* @description The ISO-3166 country code of customer associated with the Subscription
|
|
123
|
+
* @example US
|
|
124
|
+
*/
|
|
125
|
+
billing_country?: string;
|
|
126
|
+
/**
|
|
127
|
+
* @description The initial subtotal amount of the Subscription represented in cents
|
|
128
|
+
* @example 8999
|
|
129
|
+
*/
|
|
130
|
+
initial_subtotal_amount?: number;
|
|
131
|
+
/**
|
|
132
|
+
* @description The initial tax amount of the Subscription represented in cents
|
|
133
|
+
* @example 1350
|
|
134
|
+
*/
|
|
135
|
+
initial_tax_amount?: number;
|
|
136
|
+
/**
|
|
137
|
+
* @description The initial discount amount applied to the Subscription represented in cents
|
|
138
|
+
* @example 1500
|
|
139
|
+
*/
|
|
140
|
+
initial_discount_amount?: number;
|
|
141
|
+
/**
|
|
142
|
+
* @description The initial gift card usage amount applied to the Subscription represented in cents
|
|
143
|
+
* @example 0
|
|
144
|
+
*/
|
|
145
|
+
initial_giftcard_usage_amount?: number;
|
|
146
|
+
/**
|
|
147
|
+
* @description The initial total amount of the Subscription represented in cents
|
|
148
|
+
* @example 8849
|
|
149
|
+
*/
|
|
150
|
+
initial_total_amount?: number;
|
|
151
|
+
/**
|
|
152
|
+
* @description The IP address of the Customer
|
|
153
|
+
* @example 127.0.0.1/24
|
|
154
|
+
*/
|
|
155
|
+
customer_ip?: string;
|
|
156
|
+
/**
|
|
157
|
+
* Format: date-time
|
|
158
|
+
* @description The start date of the current billing period
|
|
159
|
+
* @example 2024-03-01T00:00:00Z
|
|
160
|
+
*/
|
|
161
|
+
current_period_start?: string;
|
|
162
|
+
/**
|
|
163
|
+
* Format: date-time
|
|
164
|
+
* @description The end date of the current billing period
|
|
165
|
+
* @example 2024-06-01T00:00:00Z
|
|
166
|
+
*/
|
|
167
|
+
current_period_end?: string;
|
|
168
|
+
/**
|
|
169
|
+
* Format: date-time
|
|
170
|
+
* @description The date and time when the Subscription was created
|
|
171
|
+
* @example 2024-03-01T11:00:00Z
|
|
172
|
+
*/
|
|
173
|
+
created_at?: string;
|
|
174
|
+
/**
|
|
175
|
+
* Format: date-time
|
|
176
|
+
* @description Indicates when the subscription was active
|
|
177
|
+
* @example 2024-03-01T11:05:00Z
|
|
178
|
+
*/
|
|
179
|
+
active_at?: string;
|
|
180
|
+
/**
|
|
181
|
+
* Format: flake-id
|
|
182
|
+
* @description The Flake ID of the Checkout associated with the Subscription
|
|
183
|
+
* @example 411486491630370816
|
|
184
|
+
*/
|
|
185
|
+
checkout_id?: string;
|
|
186
|
+
/**
|
|
187
|
+
* Format: flake-id
|
|
188
|
+
* @description The Flake ID of the Checkout Line associated with the Subscription
|
|
189
|
+
* @example 411486491630370816
|
|
190
|
+
*/
|
|
191
|
+
checkout_line_id?: string;
|
|
192
|
+
/**
|
|
193
|
+
* @description The current status of the Subscription. Possible options: created, active, canceled
|
|
194
|
+
* @example created
|
|
195
|
+
*/
|
|
196
|
+
status?: string;
|
|
197
|
+
};
|
|
198
|
+
};
|
|
199
|
+
};
|
|
200
|
+
};
|
|
201
|
+
responses: {
|
|
202
|
+
/** @description Webhook processed successfully */
|
|
203
|
+
200: {
|
|
204
|
+
headers: {
|
|
205
|
+
[name: string]: unknown;
|
|
206
|
+
};
|
|
207
|
+
content?: never;
|
|
208
|
+
};
|
|
209
|
+
/** @description Bad request */
|
|
210
|
+
400: {
|
|
211
|
+
headers: {
|
|
212
|
+
[name: string]: unknown;
|
|
213
|
+
};
|
|
214
|
+
content?: never;
|
|
215
|
+
};
|
|
216
|
+
/** @description Internal server error */
|
|
217
|
+
500: {
|
|
218
|
+
headers: {
|
|
219
|
+
[name: string]: unknown;
|
|
220
|
+
};
|
|
221
|
+
content?: never;
|
|
222
|
+
};
|
|
223
|
+
};
|
|
224
|
+
};
|
|
225
|
+
delete?: never;
|
|
226
|
+
options?: never;
|
|
227
|
+
head?: never;
|
|
228
|
+
patch?: never;
|
|
229
|
+
trace?: never;
|
|
230
|
+
};
|
|
231
|
+
OnDiscordAccountLinkedToCheckout: {
|
|
232
|
+
parameters: {
|
|
233
|
+
query?: never;
|
|
234
|
+
header?: never;
|
|
235
|
+
path?: never;
|
|
236
|
+
cookie?: never;
|
|
237
|
+
};
|
|
238
|
+
get?: never;
|
|
239
|
+
put?: never;
|
|
240
|
+
/**
|
|
241
|
+
* Triggered when a Discord account is successfully linked to a checkout.
|
|
242
|
+
* @description Webhook for OnDiscordAccountLinkedToCheckout
|
|
243
|
+
*/
|
|
244
|
+
post: {
|
|
245
|
+
parameters: {
|
|
246
|
+
query?: never;
|
|
247
|
+
header?: never;
|
|
248
|
+
path?: never;
|
|
249
|
+
cookie?: never;
|
|
250
|
+
};
|
|
251
|
+
requestBody: {
|
|
252
|
+
content: {
|
|
253
|
+
"application/json": {
|
|
254
|
+
event_type: components["schemas"]["WebhookEventType"];
|
|
255
|
+
/**
|
|
256
|
+
* Format: flake-id
|
|
257
|
+
* @description The ID of the Webhook Event
|
|
258
|
+
* @example 411486491630370816
|
|
259
|
+
*/
|
|
260
|
+
event_id?: string;
|
|
261
|
+
body: {
|
|
262
|
+
/**
|
|
263
|
+
* Format: flake-id
|
|
264
|
+
* @description The Flake ID of the Store associated with the Checkout
|
|
265
|
+
* @example 411486491630370816
|
|
266
|
+
*/
|
|
267
|
+
store_id?: string;
|
|
268
|
+
/**
|
|
269
|
+
* Format: flake-id
|
|
270
|
+
* @description The Flake ID of the Customer associated with the Checkout
|
|
271
|
+
* @example 411486491630370816
|
|
272
|
+
*/
|
|
273
|
+
customer_id?: string;
|
|
274
|
+
customer?: components["schemas"]["CustomerDTO"];
|
|
275
|
+
/**
|
|
276
|
+
* Format: flake-id
|
|
277
|
+
* @description The Flake ID of the Checkout
|
|
278
|
+
* @example 411486491630370816
|
|
279
|
+
*/
|
|
280
|
+
checkout_id?: string;
|
|
281
|
+
/**
|
|
282
|
+
* Format: flake-id
|
|
283
|
+
* @description The Flake ID of the Checkout Line
|
|
284
|
+
* @example 411486491630370816
|
|
285
|
+
*/
|
|
286
|
+
checkout_line_id?: string;
|
|
287
|
+
/**
|
|
288
|
+
* Format: flake-id
|
|
289
|
+
* @description The Flake ID of the Order associated with the Checkout
|
|
290
|
+
* @example 411486491630370816
|
|
291
|
+
*/
|
|
292
|
+
order_id?: string;
|
|
293
|
+
order?: components["schemas"]["OrderDTO"];
|
|
294
|
+
/**
|
|
295
|
+
* @description The Discord User ID of the linked account
|
|
296
|
+
* @example 123456789012345678
|
|
297
|
+
*/
|
|
298
|
+
discord_user_id?: string;
|
|
299
|
+
/**
|
|
300
|
+
* @description The Discord username of the linked account
|
|
301
|
+
* @example john_doe
|
|
302
|
+
*/
|
|
303
|
+
discord_user_name?: string;
|
|
304
|
+
/**
|
|
305
|
+
* @description The Discord avatar hash of the linked account
|
|
306
|
+
* @example a1b2c3d4e5f6g7h8i9j0
|
|
307
|
+
*/
|
|
308
|
+
discord_user_avatar_hash?: string;
|
|
309
|
+
/**
|
|
310
|
+
* Format: flake-id
|
|
311
|
+
* @description The Flake ID of the Product associated with the Checkout
|
|
312
|
+
* @example 411486491630370816
|
|
313
|
+
*/
|
|
314
|
+
product_id?: string;
|
|
315
|
+
/**
|
|
316
|
+
* Format: flake-id
|
|
317
|
+
* @description The Flake ID of the Product Version associated with the Checkout
|
|
318
|
+
* @example 411486491630370816
|
|
319
|
+
*/
|
|
320
|
+
product_version_id?: string;
|
|
321
|
+
product?: components["schemas"]["ProductDTO"];
|
|
322
|
+
/**
|
|
323
|
+
* Format: date-time
|
|
324
|
+
* @description Indicates when the Discord account link was enqueued
|
|
325
|
+
* @example 2024-01-15T10:30:00Z
|
|
326
|
+
*/
|
|
327
|
+
enqueued_at?: string;
|
|
328
|
+
};
|
|
329
|
+
};
|
|
330
|
+
};
|
|
331
|
+
};
|
|
332
|
+
responses: {
|
|
333
|
+
/** @description Webhook processed successfully */
|
|
334
|
+
200: {
|
|
335
|
+
headers: {
|
|
336
|
+
[name: string]: unknown;
|
|
337
|
+
};
|
|
338
|
+
content?: never;
|
|
339
|
+
};
|
|
340
|
+
/** @description Bad request */
|
|
341
|
+
400: {
|
|
342
|
+
headers: {
|
|
343
|
+
[name: string]: unknown;
|
|
344
|
+
};
|
|
345
|
+
content?: never;
|
|
346
|
+
};
|
|
347
|
+
/** @description Internal server error */
|
|
348
|
+
500: {
|
|
349
|
+
headers: {
|
|
350
|
+
[name: string]: unknown;
|
|
351
|
+
};
|
|
352
|
+
content?: never;
|
|
353
|
+
};
|
|
354
|
+
};
|
|
355
|
+
};
|
|
356
|
+
delete?: never;
|
|
357
|
+
options?: never;
|
|
358
|
+
head?: never;
|
|
359
|
+
patch?: never;
|
|
360
|
+
trace?: never;
|
|
361
|
+
};
|
|
362
|
+
OnDeliveryItemAdded: {
|
|
363
|
+
parameters: {
|
|
364
|
+
query?: never;
|
|
365
|
+
header?: never;
|
|
366
|
+
path?: never;
|
|
367
|
+
cookie?: never;
|
|
368
|
+
};
|
|
369
|
+
get?: never;
|
|
370
|
+
put?: never;
|
|
371
|
+
/**
|
|
372
|
+
* Triggered when a delivery item is added to the customers inventory
|
|
373
|
+
* @description Webhook for OnDeliveryItemAdded
|
|
374
|
+
*/
|
|
375
|
+
post: {
|
|
376
|
+
parameters: {
|
|
377
|
+
query?: never;
|
|
378
|
+
header?: never;
|
|
379
|
+
path?: never;
|
|
380
|
+
cookie?: never;
|
|
381
|
+
};
|
|
382
|
+
requestBody: {
|
|
383
|
+
content: {
|
|
384
|
+
"application/json": {
|
|
385
|
+
event_type: components["schemas"]["WebhookEventType"];
|
|
386
|
+
/**
|
|
387
|
+
* Format: flake-id
|
|
388
|
+
* @description The ID of the Webhook Event
|
|
389
|
+
* @example 411486491630370816
|
|
390
|
+
*/
|
|
391
|
+
event_id?: string;
|
|
392
|
+
body: {
|
|
393
|
+
/**
|
|
394
|
+
* Format: flake-id
|
|
395
|
+
* @description The Flake ID of the Delivery Item
|
|
396
|
+
* @example 411486491630370816
|
|
397
|
+
*/
|
|
398
|
+
id?: string;
|
|
399
|
+
/**
|
|
400
|
+
* Format: flake-id
|
|
401
|
+
* @description The Flake ID of the Store associated with the Delivery Item
|
|
402
|
+
* @example 411486491630370816
|
|
403
|
+
*/
|
|
404
|
+
store_id?: string;
|
|
405
|
+
customer?: components["schemas"]["CustomerDTO"];
|
|
406
|
+
/**
|
|
407
|
+
* Format: flake-id
|
|
408
|
+
* @description The Flake ID of the customer who ordered the delivery item - which may differ to the customer because of gifting
|
|
409
|
+
* @example 411486491630370816
|
|
410
|
+
*/
|
|
411
|
+
order_customer_id?: string;
|
|
412
|
+
/**
|
|
413
|
+
* Format: flake-id
|
|
414
|
+
* @description The Flake ID of the Checkout associated with the Delivery Item
|
|
415
|
+
* @example 411486491630370816
|
|
416
|
+
*/
|
|
417
|
+
checkout_id?: string;
|
|
418
|
+
/**
|
|
419
|
+
* Format: flake-id
|
|
420
|
+
* @description The Flake ID of the Order ID associated with the Delivery Item
|
|
421
|
+
* @example 411486491630370816
|
|
422
|
+
*/
|
|
423
|
+
order_id?: string;
|
|
424
|
+
/**
|
|
425
|
+
* Format: flake-id
|
|
426
|
+
* @description The Flake Id of the Order Line ID associated with the Delivery Item
|
|
427
|
+
* @example 411486491630370816
|
|
428
|
+
*/
|
|
429
|
+
order_line_id?: string;
|
|
430
|
+
/**
|
|
431
|
+
* Format: flake-id
|
|
432
|
+
* @description The Flake ID of the Subscription associated with the Delivery Item
|
|
433
|
+
* @example 411486491630370816
|
|
434
|
+
*/
|
|
435
|
+
subscription_id?: string;
|
|
436
|
+
/**
|
|
437
|
+
* Format: flake-id
|
|
438
|
+
* @description The Flake ID of the Game Server the Delivery Item is associated with
|
|
439
|
+
* @example 411486491630370816
|
|
440
|
+
*/
|
|
441
|
+
execute_on_gameserver_id?: string;
|
|
442
|
+
execute_on_gameserver?: components["schemas"]["GameServerDTO"];
|
|
443
|
+
/**
|
|
444
|
+
* Format: flake-id
|
|
445
|
+
* @description The associated Product ID of the Delivery Item
|
|
446
|
+
* @example 411486491630370816
|
|
447
|
+
*/
|
|
448
|
+
product_id?: string;
|
|
449
|
+
/**
|
|
450
|
+
* Format: flake-id
|
|
451
|
+
* @description The associated Product Version ID of the Delivery Item
|
|
452
|
+
* @example 411486491630370816
|
|
453
|
+
*/
|
|
454
|
+
product_version_id?: string;
|
|
455
|
+
product?: components["schemas"]["ProductDTO"];
|
|
456
|
+
/**
|
|
457
|
+
* @description The state of the Delivery Item. Possible options: usable, active, used, revoked, renewed
|
|
458
|
+
* @example usable
|
|
459
|
+
*/
|
|
460
|
+
state?: string;
|
|
461
|
+
/**
|
|
462
|
+
* Format: date-time
|
|
463
|
+
* @description Indicates when the Delivery Item was added to the customers inventory
|
|
464
|
+
* @example 2024-01-10T08:00:00Z
|
|
465
|
+
*/
|
|
466
|
+
added_at?: string;
|
|
467
|
+
/**
|
|
468
|
+
* Format: date-time
|
|
469
|
+
* @description Indicates when the Delivery Item become active
|
|
470
|
+
* @example 2024-01-10T09:00:00Z
|
|
471
|
+
*/
|
|
472
|
+
active_at?: string;
|
|
473
|
+
/**
|
|
474
|
+
* Format: date-time
|
|
475
|
+
* @description Indicates when the Delivery Item expires
|
|
476
|
+
* @example 2024-12-31T23:59:59Z
|
|
477
|
+
*/
|
|
478
|
+
expires_at?: string;
|
|
479
|
+
/**
|
|
480
|
+
* Format: date-time
|
|
481
|
+
* @description Indicates when the Delivery Item was removed from the customers inventory
|
|
482
|
+
* @example 2024-02-01T10:00:00Z
|
|
483
|
+
*/
|
|
484
|
+
removed_at?: string;
|
|
485
|
+
/**
|
|
486
|
+
* Format: date-time
|
|
487
|
+
* @description Indicates when the Delivery Item was revoked from the customers inventory
|
|
488
|
+
* @example 2024-02-05T14:30:00Z
|
|
489
|
+
*/
|
|
490
|
+
revoked_at?: string;
|
|
491
|
+
/** @description Indicates the reason the delivery item was revoked from the customers inventory */
|
|
492
|
+
revoke_reason?: string;
|
|
493
|
+
};
|
|
494
|
+
};
|
|
495
|
+
};
|
|
496
|
+
};
|
|
497
|
+
responses: {
|
|
498
|
+
/** @description Webhook processed successfully */
|
|
499
|
+
200: {
|
|
500
|
+
headers: {
|
|
501
|
+
[name: string]: unknown;
|
|
502
|
+
};
|
|
503
|
+
content?: never;
|
|
504
|
+
};
|
|
505
|
+
/** @description Bad request */
|
|
506
|
+
400: {
|
|
507
|
+
headers: {
|
|
508
|
+
[name: string]: unknown;
|
|
509
|
+
};
|
|
510
|
+
content?: never;
|
|
511
|
+
};
|
|
512
|
+
/** @description Internal server error */
|
|
513
|
+
500: {
|
|
514
|
+
headers: {
|
|
515
|
+
[name: string]: unknown;
|
|
516
|
+
};
|
|
517
|
+
content?: never;
|
|
518
|
+
};
|
|
519
|
+
};
|
|
520
|
+
};
|
|
521
|
+
delete?: never;
|
|
522
|
+
options?: never;
|
|
523
|
+
head?: never;
|
|
524
|
+
patch?: never;
|
|
525
|
+
trace?: never;
|
|
526
|
+
};
|
|
527
|
+
OnDeliveryItemActivated: {
|
|
528
|
+
parameters: {
|
|
529
|
+
query?: never;
|
|
530
|
+
header?: never;
|
|
531
|
+
path?: never;
|
|
532
|
+
cookie?: never;
|
|
533
|
+
};
|
|
534
|
+
get?: never;
|
|
535
|
+
put?: never;
|
|
536
|
+
/**
|
|
537
|
+
* Triggered when a delivery item in the customers inventory activates
|
|
538
|
+
* @description Webhook for OnDeliveryItemActivated
|
|
539
|
+
*/
|
|
540
|
+
post: {
|
|
541
|
+
parameters: {
|
|
542
|
+
query?: never;
|
|
543
|
+
header?: never;
|
|
544
|
+
path?: never;
|
|
545
|
+
cookie?: never;
|
|
546
|
+
};
|
|
547
|
+
requestBody: {
|
|
548
|
+
content: {
|
|
549
|
+
"application/json": {
|
|
550
|
+
event_type: components["schemas"]["WebhookEventType"];
|
|
551
|
+
/**
|
|
552
|
+
* Format: flake-id
|
|
553
|
+
* @description The ID of the Webhook Event
|
|
554
|
+
* @example 411486491630370816
|
|
555
|
+
*/
|
|
556
|
+
event_id?: string;
|
|
557
|
+
body: {
|
|
558
|
+
/**
|
|
559
|
+
* Format: flake-id
|
|
560
|
+
* @description The Flake ID of the Delivery Item
|
|
561
|
+
* @example 411486491630370816
|
|
562
|
+
*/
|
|
563
|
+
id?: string;
|
|
564
|
+
/**
|
|
565
|
+
* Format: flake-id
|
|
566
|
+
* @description The Flake ID of the Store associated with the Delivery Item
|
|
567
|
+
* @example 411486491630370816
|
|
568
|
+
*/
|
|
569
|
+
store_id?: string;
|
|
570
|
+
customer?: components["schemas"]["CustomerDTO"];
|
|
571
|
+
/**
|
|
572
|
+
* Format: flake-id
|
|
573
|
+
* @description The Flake ID of the customer who ordered the delivery item - which may differ to the customer because of gifting
|
|
574
|
+
* @example 411486491630370816
|
|
575
|
+
*/
|
|
576
|
+
order_customer_id?: string;
|
|
577
|
+
/**
|
|
578
|
+
* Format: flake-id
|
|
579
|
+
* @description The Flake ID of the Checkout associated with the Delivery Item
|
|
580
|
+
* @example 411486491630370816
|
|
581
|
+
*/
|
|
582
|
+
checkout_id?: string;
|
|
583
|
+
/**
|
|
584
|
+
* Format: flake-id
|
|
585
|
+
* @description The Flake ID of the Order ID associated with the Delivery Item
|
|
586
|
+
* @example 411486491630370816
|
|
587
|
+
*/
|
|
588
|
+
order_id?: string;
|
|
589
|
+
/**
|
|
590
|
+
* Format: flake-id
|
|
591
|
+
* @description The Flake Id of the Order Line ID associated with the Delivery Item
|
|
592
|
+
* @example 411486491630370816
|
|
593
|
+
*/
|
|
594
|
+
order_line_id?: string;
|
|
595
|
+
/**
|
|
596
|
+
* Format: flake-id
|
|
597
|
+
* @description The Flake ID of the Subscription associated with the Delivery Item
|
|
598
|
+
* @example 411486491630370816
|
|
599
|
+
*/
|
|
600
|
+
subscription_id?: string;
|
|
601
|
+
/**
|
|
602
|
+
* Format: flake-id
|
|
603
|
+
* @description The Flake ID of the Game Server the Delivery Item is associated with
|
|
604
|
+
* @example 411486491630370816
|
|
605
|
+
*/
|
|
606
|
+
execute_on_gameserver_id?: string;
|
|
607
|
+
execute_on_gameserver?: components["schemas"]["GameServerDTO"];
|
|
608
|
+
/**
|
|
609
|
+
* Format: flake-id
|
|
610
|
+
* @description The associated Product ID of the Delivery Item
|
|
611
|
+
* @example 411486491630370816
|
|
612
|
+
*/
|
|
613
|
+
product_id?: string;
|
|
614
|
+
/**
|
|
615
|
+
* Format: flake-id
|
|
616
|
+
* @description The associated Product Version ID of the Delivery Item
|
|
617
|
+
* @example 411486491630370816
|
|
618
|
+
*/
|
|
619
|
+
product_version_id?: string;
|
|
620
|
+
product?: components["schemas"]["ProductDTO"];
|
|
621
|
+
/**
|
|
622
|
+
* @description The state of the Delivery Item. Possible options: usable, active, used, revoked, renewed
|
|
623
|
+
* @example usable
|
|
624
|
+
*/
|
|
625
|
+
state?: string;
|
|
626
|
+
/**
|
|
627
|
+
* Format: date-time
|
|
628
|
+
* @description Indicates when the Delivery Item was added to the customers inventory
|
|
629
|
+
* @example 2024-01-10T08:00:00Z
|
|
630
|
+
*/
|
|
631
|
+
added_at?: string;
|
|
632
|
+
/**
|
|
633
|
+
* Format: date-time
|
|
634
|
+
* @description Indicates when the Delivery Item become active
|
|
635
|
+
* @example 2024-01-10T09:00:00Z
|
|
636
|
+
*/
|
|
637
|
+
active_at?: string;
|
|
638
|
+
/**
|
|
639
|
+
* Format: date-time
|
|
640
|
+
* @description Indicates when the Delivery Item expires
|
|
641
|
+
* @example 2024-12-31T23:59:59Z
|
|
642
|
+
*/
|
|
643
|
+
expires_at?: string;
|
|
644
|
+
/**
|
|
645
|
+
* Format: date-time
|
|
646
|
+
* @description Indicates when the Delivery Item was removed from the customers inventory
|
|
647
|
+
* @example 2024-02-01T10:00:00Z
|
|
648
|
+
*/
|
|
649
|
+
removed_at?: string;
|
|
650
|
+
/**
|
|
651
|
+
* Format: date-time
|
|
652
|
+
* @description Indicates when the Delivery Item was revoked from the customers inventory
|
|
653
|
+
* @example 2024-02-05T14:30:00Z
|
|
654
|
+
*/
|
|
655
|
+
revoked_at?: string;
|
|
656
|
+
/** @description Indicates the reason the delivery item was revoked from the customers inventory */
|
|
657
|
+
revoke_reason?: string;
|
|
658
|
+
};
|
|
659
|
+
};
|
|
660
|
+
};
|
|
661
|
+
};
|
|
662
|
+
responses: {
|
|
663
|
+
/** @description Webhook processed successfully */
|
|
664
|
+
200: {
|
|
665
|
+
headers: {
|
|
666
|
+
[name: string]: unknown;
|
|
667
|
+
};
|
|
668
|
+
content?: never;
|
|
669
|
+
};
|
|
670
|
+
/** @description Bad request */
|
|
671
|
+
400: {
|
|
672
|
+
headers: {
|
|
673
|
+
[name: string]: unknown;
|
|
674
|
+
};
|
|
675
|
+
content?: never;
|
|
676
|
+
};
|
|
677
|
+
/** @description Internal server error */
|
|
678
|
+
500: {
|
|
679
|
+
headers: {
|
|
680
|
+
[name: string]: unknown;
|
|
681
|
+
};
|
|
682
|
+
content?: never;
|
|
683
|
+
};
|
|
684
|
+
};
|
|
685
|
+
};
|
|
686
|
+
delete?: never;
|
|
687
|
+
options?: never;
|
|
688
|
+
head?: never;
|
|
689
|
+
patch?: never;
|
|
690
|
+
trace?: never;
|
|
691
|
+
};
|
|
692
|
+
OnDeliveryItemUsed: {
|
|
693
|
+
parameters: {
|
|
694
|
+
query?: never;
|
|
695
|
+
header?: never;
|
|
696
|
+
path?: never;
|
|
697
|
+
cookie?: never;
|
|
698
|
+
};
|
|
699
|
+
get?: never;
|
|
700
|
+
put?: never;
|
|
701
|
+
/**
|
|
702
|
+
* Triggered when a delivery item in the customers inventory becomes used
|
|
703
|
+
* @description Webhook for OnDeliveryItemUsed
|
|
704
|
+
*/
|
|
705
|
+
post: {
|
|
706
|
+
parameters: {
|
|
707
|
+
query?: never;
|
|
708
|
+
header?: never;
|
|
709
|
+
path?: never;
|
|
710
|
+
cookie?: never;
|
|
711
|
+
};
|
|
712
|
+
requestBody: {
|
|
713
|
+
content: {
|
|
714
|
+
"application/json": {
|
|
715
|
+
event_type: components["schemas"]["WebhookEventType"];
|
|
716
|
+
/**
|
|
717
|
+
* Format: flake-id
|
|
718
|
+
* @description The ID of the Webhook Event
|
|
719
|
+
* @example 411486491630370816
|
|
720
|
+
*/
|
|
721
|
+
event_id?: string;
|
|
722
|
+
body: {
|
|
723
|
+
/**
|
|
724
|
+
* Format: flake-id
|
|
725
|
+
* @description The Flake ID of the Delivery Item
|
|
726
|
+
* @example 411486491630370816
|
|
727
|
+
*/
|
|
728
|
+
id?: string;
|
|
729
|
+
/**
|
|
730
|
+
* Format: flake-id
|
|
731
|
+
* @description The Flake ID of the Store associated with the Delivery Item
|
|
732
|
+
* @example 411486491630370816
|
|
733
|
+
*/
|
|
734
|
+
store_id?: string;
|
|
735
|
+
customer?: components["schemas"]["CustomerDTO"];
|
|
736
|
+
/**
|
|
737
|
+
* Format: flake-id
|
|
738
|
+
* @description The Flake ID of the customer who ordered the delivery item - which may differ to the customer because of gifting
|
|
739
|
+
* @example 411486491630370816
|
|
740
|
+
*/
|
|
741
|
+
order_customer_id?: string;
|
|
742
|
+
/**
|
|
743
|
+
* Format: flake-id
|
|
744
|
+
* @description The Flake ID of the Checkout associated with the Delivery Item
|
|
745
|
+
* @example 411486491630370816
|
|
746
|
+
*/
|
|
747
|
+
checkout_id?: string;
|
|
748
|
+
/**
|
|
749
|
+
* Format: flake-id
|
|
750
|
+
* @description The Flake ID of the Order ID associated with the Delivery Item
|
|
751
|
+
* @example 411486491630370816
|
|
752
|
+
*/
|
|
753
|
+
order_id?: string;
|
|
754
|
+
/**
|
|
755
|
+
* Format: flake-id
|
|
756
|
+
* @description The Flake Id of the Order Line ID associated with the Delivery Item
|
|
757
|
+
* @example 411486491630370816
|
|
758
|
+
*/
|
|
759
|
+
order_line_id?: string;
|
|
760
|
+
/**
|
|
761
|
+
* Format: flake-id
|
|
762
|
+
* @description The Flake ID of the Subscription associated with the Delivery Item
|
|
763
|
+
* @example 411486491630370816
|
|
764
|
+
*/
|
|
765
|
+
subscription_id?: string;
|
|
766
|
+
/**
|
|
767
|
+
* Format: flake-id
|
|
768
|
+
* @description The Flake ID of the Game Server the Delivery Item is associated with
|
|
769
|
+
* @example 411486491630370816
|
|
770
|
+
*/
|
|
771
|
+
execute_on_gameserver_id?: string;
|
|
772
|
+
execute_on_gameserver?: components["schemas"]["GameServerDTO"];
|
|
773
|
+
/**
|
|
774
|
+
* Format: flake-id
|
|
775
|
+
* @description The associated Product ID of the Delivery Item
|
|
776
|
+
* @example 411486491630370816
|
|
777
|
+
*/
|
|
778
|
+
product_id?: string;
|
|
779
|
+
/**
|
|
780
|
+
* Format: flake-id
|
|
781
|
+
* @description The associated Product Version ID of the Delivery Item
|
|
782
|
+
* @example 411486491630370816
|
|
783
|
+
*/
|
|
784
|
+
product_version_id?: string;
|
|
785
|
+
product?: components["schemas"]["ProductDTO"];
|
|
786
|
+
/**
|
|
787
|
+
* @description The state of the Delivery Item. Possible options: usable, active, used, revoked, renewed
|
|
788
|
+
* @example usable
|
|
789
|
+
*/
|
|
790
|
+
state?: string;
|
|
791
|
+
/**
|
|
792
|
+
* Format: date-time
|
|
793
|
+
* @description Indicates when the Delivery Item was added to the customers inventory
|
|
794
|
+
* @example 2024-01-10T08:00:00Z
|
|
795
|
+
*/
|
|
796
|
+
added_at?: string;
|
|
797
|
+
/**
|
|
798
|
+
* Format: date-time
|
|
799
|
+
* @description Indicates when the Delivery Item become active
|
|
800
|
+
* @example 2024-01-10T09:00:00Z
|
|
801
|
+
*/
|
|
802
|
+
active_at?: string;
|
|
803
|
+
/**
|
|
804
|
+
* Format: date-time
|
|
805
|
+
* @description Indicates when the Delivery Item expires
|
|
806
|
+
* @example 2024-12-31T23:59:59Z
|
|
807
|
+
*/
|
|
808
|
+
expires_at?: string;
|
|
809
|
+
/**
|
|
810
|
+
* Format: date-time
|
|
811
|
+
* @description Indicates when the Delivery Item was removed from the customers inventory
|
|
812
|
+
* @example 2024-02-01T10:00:00Z
|
|
813
|
+
*/
|
|
814
|
+
removed_at?: string;
|
|
815
|
+
/**
|
|
816
|
+
* Format: date-time
|
|
817
|
+
* @description Indicates when the Delivery Item was revoked from the customers inventory
|
|
818
|
+
* @example 2024-02-05T14:30:00Z
|
|
819
|
+
*/
|
|
820
|
+
revoked_at?: string;
|
|
821
|
+
/** @description Indicates the reason the delivery item was revoked from the customers inventory */
|
|
822
|
+
revoke_reason?: string;
|
|
823
|
+
};
|
|
824
|
+
};
|
|
825
|
+
};
|
|
826
|
+
};
|
|
827
|
+
responses: {
|
|
828
|
+
/** @description Webhook processed successfully */
|
|
829
|
+
200: {
|
|
830
|
+
headers: {
|
|
831
|
+
[name: string]: unknown;
|
|
832
|
+
};
|
|
833
|
+
content?: never;
|
|
834
|
+
};
|
|
835
|
+
/** @description Bad request */
|
|
836
|
+
400: {
|
|
837
|
+
headers: {
|
|
838
|
+
[name: string]: unknown;
|
|
839
|
+
};
|
|
840
|
+
content?: never;
|
|
841
|
+
};
|
|
842
|
+
/** @description Internal server error */
|
|
843
|
+
500: {
|
|
844
|
+
headers: {
|
|
845
|
+
[name: string]: unknown;
|
|
846
|
+
};
|
|
847
|
+
content?: never;
|
|
848
|
+
};
|
|
849
|
+
};
|
|
850
|
+
};
|
|
851
|
+
delete?: never;
|
|
852
|
+
options?: never;
|
|
853
|
+
head?: never;
|
|
854
|
+
patch?: never;
|
|
855
|
+
trace?: never;
|
|
856
|
+
};
|
|
857
|
+
OnDeliveryItemRevoked: {
|
|
858
|
+
parameters: {
|
|
859
|
+
query?: never;
|
|
860
|
+
header?: never;
|
|
861
|
+
path?: never;
|
|
862
|
+
cookie?: never;
|
|
863
|
+
};
|
|
864
|
+
get?: never;
|
|
865
|
+
put?: never;
|
|
866
|
+
/**
|
|
867
|
+
* Triggered when a delivery item is revoked from the customers inventory
|
|
868
|
+
* @description Webhook for OnDeliveryItemRevoked
|
|
869
|
+
*/
|
|
870
|
+
post: {
|
|
871
|
+
parameters: {
|
|
872
|
+
query?: never;
|
|
873
|
+
header?: never;
|
|
874
|
+
path?: never;
|
|
875
|
+
cookie?: never;
|
|
876
|
+
};
|
|
877
|
+
requestBody: {
|
|
878
|
+
content: {
|
|
879
|
+
"application/json": {
|
|
880
|
+
event_type: components["schemas"]["WebhookEventType"];
|
|
881
|
+
/**
|
|
882
|
+
* Format: flake-id
|
|
883
|
+
* @description The ID of the Webhook Event
|
|
884
|
+
* @example 411486491630370816
|
|
885
|
+
*/
|
|
886
|
+
event_id?: string;
|
|
887
|
+
body: {
|
|
888
|
+
/**
|
|
889
|
+
* Format: flake-id
|
|
890
|
+
* @description The Flake ID of the Delivery Item
|
|
891
|
+
* @example 411486491630370816
|
|
892
|
+
*/
|
|
893
|
+
id?: string;
|
|
894
|
+
/**
|
|
895
|
+
* Format: flake-id
|
|
896
|
+
* @description The Flake ID of the Store associated with the Delivery Item
|
|
897
|
+
* @example 411486491630370816
|
|
898
|
+
*/
|
|
899
|
+
store_id?: string;
|
|
900
|
+
customer?: components["schemas"]["CustomerDTO"];
|
|
901
|
+
/**
|
|
902
|
+
* Format: flake-id
|
|
903
|
+
* @description The Flake ID of the customer who ordered the delivery item - which may differ to the customer because of gifting
|
|
904
|
+
* @example 411486491630370816
|
|
905
|
+
*/
|
|
906
|
+
order_customer_id?: string;
|
|
907
|
+
/**
|
|
908
|
+
* Format: flake-id
|
|
909
|
+
* @description The Flake ID of the Checkout associated with the Delivery Item
|
|
910
|
+
* @example 411486491630370816
|
|
911
|
+
*/
|
|
912
|
+
checkout_id?: string;
|
|
913
|
+
/**
|
|
914
|
+
* Format: flake-id
|
|
915
|
+
* @description The Flake ID of the Order ID associated with the Delivery Item
|
|
916
|
+
* @example 411486491630370816
|
|
917
|
+
*/
|
|
918
|
+
order_id?: string;
|
|
919
|
+
/**
|
|
920
|
+
* Format: flake-id
|
|
921
|
+
* @description The Flake Id of the Order Line ID associated with the Delivery Item
|
|
922
|
+
* @example 411486491630370816
|
|
923
|
+
*/
|
|
924
|
+
order_line_id?: string;
|
|
925
|
+
/**
|
|
926
|
+
* Format: flake-id
|
|
927
|
+
* @description The Flake ID of the Subscription associated with the Delivery Item
|
|
928
|
+
* @example 411486491630370816
|
|
929
|
+
*/
|
|
930
|
+
subscription_id?: string;
|
|
931
|
+
/**
|
|
932
|
+
* Format: flake-id
|
|
933
|
+
* @description The Flake ID of the Game Server the Delivery Item is associated with
|
|
934
|
+
* @example 411486491630370816
|
|
935
|
+
*/
|
|
936
|
+
execute_on_gameserver_id?: string;
|
|
937
|
+
execute_on_gameserver?: components["schemas"]["GameServerDTO"];
|
|
938
|
+
/**
|
|
939
|
+
* Format: flake-id
|
|
940
|
+
* @description The associated Product ID of the Delivery Item
|
|
941
|
+
* @example 411486491630370816
|
|
942
|
+
*/
|
|
943
|
+
product_id?: string;
|
|
944
|
+
/**
|
|
945
|
+
* Format: flake-id
|
|
946
|
+
* @description The associated Product Version ID of the Delivery Item
|
|
947
|
+
* @example 411486491630370816
|
|
948
|
+
*/
|
|
949
|
+
product_version_id?: string;
|
|
950
|
+
product?: components["schemas"]["ProductDTO"];
|
|
951
|
+
/**
|
|
952
|
+
* @description The state of the Delivery Item. Possible options: usable, active, used, revoked, renewed
|
|
953
|
+
* @example usable
|
|
954
|
+
*/
|
|
955
|
+
state?: string;
|
|
956
|
+
/**
|
|
957
|
+
* Format: date-time
|
|
958
|
+
* @description Indicates when the Delivery Item was added to the customers inventory
|
|
959
|
+
* @example 2024-01-10T08:00:00Z
|
|
960
|
+
*/
|
|
961
|
+
added_at?: string;
|
|
962
|
+
/**
|
|
963
|
+
* Format: date-time
|
|
964
|
+
* @description Indicates when the Delivery Item become active
|
|
965
|
+
* @example 2024-01-10T09:00:00Z
|
|
966
|
+
*/
|
|
967
|
+
active_at?: string;
|
|
968
|
+
/**
|
|
969
|
+
* Format: date-time
|
|
970
|
+
* @description Indicates when the Delivery Item expires
|
|
971
|
+
* @example 2024-12-31T23:59:59Z
|
|
972
|
+
*/
|
|
973
|
+
expires_at?: string;
|
|
974
|
+
/**
|
|
975
|
+
* Format: date-time
|
|
976
|
+
* @description Indicates when the Delivery Item was removed from the customers inventory
|
|
977
|
+
* @example 2024-02-01T10:00:00Z
|
|
978
|
+
*/
|
|
979
|
+
removed_at?: string;
|
|
980
|
+
/**
|
|
981
|
+
* Format: date-time
|
|
982
|
+
* @description Indicates when the Delivery Item was revoked from the customers inventory
|
|
983
|
+
* @example 2024-02-05T14:30:00Z
|
|
984
|
+
*/
|
|
985
|
+
revoked_at?: string;
|
|
986
|
+
/** @description Indicates the reason the delivery item was revoked from the customers inventory */
|
|
987
|
+
revoke_reason?: string;
|
|
988
|
+
};
|
|
989
|
+
};
|
|
990
|
+
};
|
|
991
|
+
};
|
|
992
|
+
responses: {
|
|
993
|
+
/** @description Webhook processed successfully */
|
|
994
|
+
200: {
|
|
995
|
+
headers: {
|
|
996
|
+
[name: string]: unknown;
|
|
997
|
+
};
|
|
998
|
+
content?: never;
|
|
999
|
+
};
|
|
1000
|
+
/** @description Bad request */
|
|
1001
|
+
400: {
|
|
1002
|
+
headers: {
|
|
1003
|
+
[name: string]: unknown;
|
|
1004
|
+
};
|
|
1005
|
+
content?: never;
|
|
1006
|
+
};
|
|
1007
|
+
/** @description Internal server error */
|
|
1008
|
+
500: {
|
|
1009
|
+
headers: {
|
|
1010
|
+
[name: string]: unknown;
|
|
1011
|
+
};
|
|
1012
|
+
content?: never;
|
|
1013
|
+
};
|
|
1014
|
+
};
|
|
1015
|
+
};
|
|
1016
|
+
delete?: never;
|
|
1017
|
+
options?: never;
|
|
1018
|
+
head?: never;
|
|
1019
|
+
patch?: never;
|
|
1020
|
+
trace?: never;
|
|
1021
|
+
};
|
|
1022
|
+
OnOrderCompleted: {
|
|
1023
|
+
parameters: {
|
|
1024
|
+
query?: never;
|
|
1025
|
+
header?: never;
|
|
1026
|
+
path?: never;
|
|
1027
|
+
cookie?: never;
|
|
1028
|
+
};
|
|
1029
|
+
get?: never;
|
|
1030
|
+
put?: never;
|
|
1031
|
+
/**
|
|
1032
|
+
* Triggered when an order is completed
|
|
1033
|
+
* @description Webhook for OnOrderCompleted
|
|
1034
|
+
*/
|
|
1035
|
+
post: {
|
|
1036
|
+
parameters: {
|
|
1037
|
+
query?: never;
|
|
1038
|
+
header?: never;
|
|
1039
|
+
path?: never;
|
|
1040
|
+
cookie?: never;
|
|
1041
|
+
};
|
|
1042
|
+
requestBody: {
|
|
1043
|
+
content: {
|
|
1044
|
+
"application/json": {
|
|
1045
|
+
event_type: components["schemas"]["WebhookEventType"];
|
|
1046
|
+
/**
|
|
1047
|
+
* Format: flake-id
|
|
1048
|
+
* @description The ID of the Webhook Event
|
|
1049
|
+
* @example 411486491630370816
|
|
1050
|
+
*/
|
|
1051
|
+
event_id?: string;
|
|
1052
|
+
body: {
|
|
1053
|
+
/**
|
|
1054
|
+
* Format: flake-id
|
|
1055
|
+
* @description The Flake ID of the Order
|
|
1056
|
+
* @example 411486491630370816
|
|
1057
|
+
*/
|
|
1058
|
+
id?: string;
|
|
1059
|
+
/**
|
|
1060
|
+
* Format: flake-id
|
|
1061
|
+
* @description The Flake ID of the store associated with the order
|
|
1062
|
+
* @example 411486491630370816
|
|
1063
|
+
*/
|
|
1064
|
+
store_id?: string;
|
|
1065
|
+
customer?: components["schemas"]["CustomerDTO"];
|
|
1066
|
+
/**
|
|
1067
|
+
* Format: flake-id
|
|
1068
|
+
* @description The Flake ID of the Checkout associated with the order
|
|
1069
|
+
* @example 411486491630370816
|
|
1070
|
+
*/
|
|
1071
|
+
checkout_id?: string;
|
|
1072
|
+
checkout?: components["schemas"]["CheckoutDTO"];
|
|
1073
|
+
/**
|
|
1074
|
+
* Format: flake-id
|
|
1075
|
+
* @description The Flake ID of the Subscription associated with the order
|
|
1076
|
+
* @example 411486491630370816
|
|
1077
|
+
*/
|
|
1078
|
+
subscription_id?: string;
|
|
1079
|
+
/**
|
|
1080
|
+
* Format: flake-id
|
|
1081
|
+
* @description The Flake ID of the Coupon associated with the order
|
|
1082
|
+
* @example 411486491630370816
|
|
1083
|
+
*/
|
|
1084
|
+
coupon_id?: string;
|
|
1085
|
+
/**
|
|
1086
|
+
* @description The ISO-4217 Currency Code of the order
|
|
1087
|
+
* @example USD
|
|
1088
|
+
*/
|
|
1089
|
+
currency?: string;
|
|
1090
|
+
/**
|
|
1091
|
+
* @description Indicates if the order value was inclusive of tax
|
|
1092
|
+
* @example true
|
|
1093
|
+
*/
|
|
1094
|
+
tax_inclusive?: boolean;
|
|
1095
|
+
/**
|
|
1096
|
+
* @description The tax amount, represented as cents
|
|
1097
|
+
* @example 1500
|
|
1098
|
+
*/
|
|
1099
|
+
tax_amount?: number;
|
|
1100
|
+
/**
|
|
1101
|
+
* @description The discount amount, represented as cents
|
|
1102
|
+
* @example 500
|
|
1103
|
+
*/
|
|
1104
|
+
discount_amount?: number;
|
|
1105
|
+
/**
|
|
1106
|
+
* @description The subtotal amount, represented as cents
|
|
1107
|
+
* @example 10000
|
|
1108
|
+
*/
|
|
1109
|
+
subtotal_amount?: number;
|
|
1110
|
+
/**
|
|
1111
|
+
* @description The total amount, represented as cents
|
|
1112
|
+
* @example 11000
|
|
1113
|
+
*/
|
|
1114
|
+
total_amount?: number;
|
|
1115
|
+
/**
|
|
1116
|
+
* Format: date-time
|
|
1117
|
+
* @description Indicates when the order was created
|
|
1118
|
+
* @example 2024-01-15T10:30:00Z
|
|
1119
|
+
*/
|
|
1120
|
+
created_at?: string;
|
|
1121
|
+
/**
|
|
1122
|
+
* Format: date-time
|
|
1123
|
+
* @description Indicates when the order was completed
|
|
1124
|
+
* @example 2024-01-15T10:35:00Z
|
|
1125
|
+
*/
|
|
1126
|
+
completed_at?: string;
|
|
1127
|
+
/**
|
|
1128
|
+
* @description The billing name of the customer associated with the order
|
|
1129
|
+
* @example John Doe
|
|
1130
|
+
*/
|
|
1131
|
+
billing_name?: string;
|
|
1132
|
+
/**
|
|
1133
|
+
* @description The billing email address of the customer associated with the order
|
|
1134
|
+
* @example john@doe.com
|
|
1135
|
+
*/
|
|
1136
|
+
billing_email?: string;
|
|
1137
|
+
/**
|
|
1138
|
+
* @description The ISO-3316 Country Code of the customer associated with the order
|
|
1139
|
+
* @example US
|
|
1140
|
+
*/
|
|
1141
|
+
billing_address_country?: string;
|
|
1142
|
+
/**
|
|
1143
|
+
* @description The IPv4 or IPv6 Address of the associated customer when creating the order
|
|
1144
|
+
* @example 127.0.0.1/24
|
|
1145
|
+
*/
|
|
1146
|
+
customer_ip?: string;
|
|
1147
|
+
/**
|
|
1148
|
+
* @description The total amount of giftcard usage associated with the order, represented in cents
|
|
1149
|
+
* @example 0
|
|
1150
|
+
*/
|
|
1151
|
+
giftcard_usage_amount?: number;
|
|
1152
|
+
/** @description The order lines associated with the order */
|
|
1153
|
+
lines?: components["schemas"]["OrderLineDTO"][];
|
|
1154
|
+
/**
|
|
1155
|
+
* @description A comma-seperated string of the names of the product associated with the order
|
|
1156
|
+
* @example Product A, Product B
|
|
1157
|
+
*/
|
|
1158
|
+
product_names?: string;
|
|
1159
|
+
/**
|
|
1160
|
+
* @description A comma-seperated string of the tags of the products associated with the order
|
|
1161
|
+
* @example ranks, perks
|
|
1162
|
+
*/
|
|
1163
|
+
product_tags?: string;
|
|
1164
|
+
/**
|
|
1165
|
+
* @description A comma-seperated string of the gameservers of the product associated with the order
|
|
1166
|
+
* @example game server one, game server two
|
|
1167
|
+
*/
|
|
1168
|
+
product_gameservers?: string;
|
|
1169
|
+
/**
|
|
1170
|
+
* @description The status of the Order. Possbile options: created, completed, canceled
|
|
1171
|
+
* @example created
|
|
1172
|
+
*/
|
|
1173
|
+
status?: string;
|
|
1174
|
+
};
|
|
1175
|
+
};
|
|
1176
|
+
};
|
|
1177
|
+
};
|
|
1178
|
+
responses: {
|
|
1179
|
+
/** @description Webhook processed successfully */
|
|
1180
|
+
200: {
|
|
1181
|
+
headers: {
|
|
1182
|
+
[name: string]: unknown;
|
|
1183
|
+
};
|
|
1184
|
+
content?: never;
|
|
1185
|
+
};
|
|
1186
|
+
/** @description Bad request */
|
|
1187
|
+
400: {
|
|
1188
|
+
headers: {
|
|
1189
|
+
[name: string]: unknown;
|
|
1190
|
+
};
|
|
1191
|
+
content?: never;
|
|
1192
|
+
};
|
|
1193
|
+
/** @description Internal server error */
|
|
1194
|
+
500: {
|
|
1195
|
+
headers: {
|
|
1196
|
+
[name: string]: unknown;
|
|
1197
|
+
};
|
|
1198
|
+
content?: never;
|
|
1199
|
+
};
|
|
1200
|
+
};
|
|
1201
|
+
};
|
|
1202
|
+
delete?: never;
|
|
1203
|
+
options?: never;
|
|
1204
|
+
head?: never;
|
|
1205
|
+
patch?: never;
|
|
1206
|
+
trace?: never;
|
|
1207
|
+
};
|
|
1208
|
+
OnChargeback: {
|
|
1209
|
+
parameters: {
|
|
1210
|
+
query?: never;
|
|
1211
|
+
header?: never;
|
|
1212
|
+
path?: never;
|
|
1213
|
+
cookie?: never;
|
|
1214
|
+
};
|
|
1215
|
+
get?: never;
|
|
1216
|
+
put?: never;
|
|
1217
|
+
/**
|
|
1218
|
+
* Triggered when a chargeback is created
|
|
1219
|
+
* @description Webhook for OnChargeback
|
|
1220
|
+
*/
|
|
1221
|
+
post: {
|
|
1222
|
+
parameters: {
|
|
1223
|
+
query?: never;
|
|
1224
|
+
header?: never;
|
|
1225
|
+
path?: never;
|
|
1226
|
+
cookie?: never;
|
|
1227
|
+
};
|
|
1228
|
+
requestBody: {
|
|
1229
|
+
content: {
|
|
1230
|
+
"application/json": {
|
|
1231
|
+
event_type: components["schemas"]["WebhookEventType"];
|
|
1232
|
+
/**
|
|
1233
|
+
* Format: flake-id
|
|
1234
|
+
* @description The ID of the Webhook Event
|
|
1235
|
+
* @example 411486491630370816
|
|
1236
|
+
*/
|
|
1237
|
+
event_id?: string;
|
|
1238
|
+
body: {
|
|
1239
|
+
/**
|
|
1240
|
+
* Format: flake-id
|
|
1241
|
+
* @description The Flake ID of the Payment associated with the Payment
|
|
1242
|
+
* @example 411486491630370816
|
|
1243
|
+
*/
|
|
1244
|
+
id?: string;
|
|
1245
|
+
/**
|
|
1246
|
+
* Format: flake-id
|
|
1247
|
+
* @description The Flake ID of the Store associated with the Payment
|
|
1248
|
+
* @example 411486491630370816
|
|
1249
|
+
*/
|
|
1250
|
+
store_id?: string;
|
|
1251
|
+
/**
|
|
1252
|
+
* Format: flake-id
|
|
1253
|
+
* @description The Flake ID of the Order associated with Payment
|
|
1254
|
+
* @example 411486491630370816
|
|
1255
|
+
*/
|
|
1256
|
+
order_id?: string;
|
|
1257
|
+
customer?: components["schemas"]["CustomerDTO"];
|
|
1258
|
+
/**
|
|
1259
|
+
* @description The Payment Gateway of the Payment
|
|
1260
|
+
* @example stripe
|
|
1261
|
+
*/
|
|
1262
|
+
gateway?: string;
|
|
1263
|
+
/**
|
|
1264
|
+
* @description The ISO-4217 Currency Code of the Payment
|
|
1265
|
+
* @example USD
|
|
1266
|
+
*/
|
|
1267
|
+
currency?: string;
|
|
1268
|
+
/**
|
|
1269
|
+
* @description Indicates if the payment was Tax Inclusive
|
|
1270
|
+
* @example true
|
|
1271
|
+
*/
|
|
1272
|
+
tax_inclusive?: boolean;
|
|
1273
|
+
/**
|
|
1274
|
+
* @description The payment amount, represented in cents
|
|
1275
|
+
* @example 7500
|
|
1276
|
+
*/
|
|
1277
|
+
amount?: number;
|
|
1278
|
+
/**
|
|
1279
|
+
* @description The gateway fee amount, represented in cents
|
|
1280
|
+
* @example 200
|
|
1281
|
+
*/
|
|
1282
|
+
gateway_fee_amount?: number;
|
|
1283
|
+
/**
|
|
1284
|
+
* @description The tax amount, represented in cents
|
|
1285
|
+
* @example 1200
|
|
1286
|
+
*/
|
|
1287
|
+
tax_amount?: number;
|
|
1288
|
+
/**
|
|
1289
|
+
* @description The platform fee amount, represented in cents
|
|
1290
|
+
* @example 375
|
|
1291
|
+
*/
|
|
1292
|
+
platform_fee_amount?: number;
|
|
1293
|
+
/**
|
|
1294
|
+
* @description The net amount recieved by the associated store, represented in cents
|
|
1295
|
+
* @example 5925
|
|
1296
|
+
*/
|
|
1297
|
+
store_net_amount?: number;
|
|
1298
|
+
/** @description The status of the payment */
|
|
1299
|
+
status?: string;
|
|
1300
|
+
/**
|
|
1301
|
+
* Format: date-time
|
|
1302
|
+
* @description Indicated when a chargeback was opened for the payment
|
|
1303
|
+
* @example 2024-01-25T14:45:00Z
|
|
1304
|
+
*/
|
|
1305
|
+
chargeback_at?: string;
|
|
1306
|
+
};
|
|
1307
|
+
};
|
|
1308
|
+
};
|
|
1309
|
+
};
|
|
1310
|
+
responses: {
|
|
1311
|
+
/** @description Webhook processed successfully */
|
|
1312
|
+
200: {
|
|
1313
|
+
headers: {
|
|
1314
|
+
[name: string]: unknown;
|
|
1315
|
+
};
|
|
1316
|
+
content?: never;
|
|
1317
|
+
};
|
|
1318
|
+
/** @description Bad request */
|
|
1319
|
+
400: {
|
|
1320
|
+
headers: {
|
|
1321
|
+
[name: string]: unknown;
|
|
1322
|
+
};
|
|
1323
|
+
content?: never;
|
|
1324
|
+
};
|
|
1325
|
+
/** @description Internal server error */
|
|
1326
|
+
500: {
|
|
1327
|
+
headers: {
|
|
1328
|
+
[name: string]: unknown;
|
|
1329
|
+
};
|
|
1330
|
+
content?: never;
|
|
1331
|
+
};
|
|
1332
|
+
};
|
|
1333
|
+
};
|
|
1334
|
+
delete?: never;
|
|
1335
|
+
options?: never;
|
|
1336
|
+
head?: never;
|
|
1337
|
+
patch?: never;
|
|
1338
|
+
trace?: never;
|
|
1339
|
+
};
|
|
1340
|
+
OnRefund: {
|
|
1341
|
+
parameters: {
|
|
1342
|
+
query?: never;
|
|
1343
|
+
header?: never;
|
|
1344
|
+
path?: never;
|
|
1345
|
+
cookie?: never;
|
|
1346
|
+
};
|
|
1347
|
+
get?: never;
|
|
1348
|
+
put?: never;
|
|
1349
|
+
/**
|
|
1350
|
+
* Triggered when a refund is completed
|
|
1351
|
+
* @description Webhook for OnRefund
|
|
1352
|
+
*/
|
|
1353
|
+
post: {
|
|
1354
|
+
parameters: {
|
|
1355
|
+
query?: never;
|
|
1356
|
+
header?: never;
|
|
1357
|
+
path?: never;
|
|
1358
|
+
cookie?: never;
|
|
1359
|
+
};
|
|
1360
|
+
requestBody: {
|
|
1361
|
+
content: {
|
|
1362
|
+
"application/json": {
|
|
1363
|
+
event_type: components["schemas"]["WebhookEventType"];
|
|
1364
|
+
/**
|
|
1365
|
+
* Format: flake-id
|
|
1366
|
+
* @description The ID of the Webhook Event
|
|
1367
|
+
* @example 411486491630370816
|
|
1368
|
+
*/
|
|
1369
|
+
event_id?: string;
|
|
1370
|
+
body: {
|
|
1371
|
+
/**
|
|
1372
|
+
* Format: flake-id
|
|
1373
|
+
* @description The Flake ID of the Refund
|
|
1374
|
+
* @example 411486491630370816
|
|
1375
|
+
*/
|
|
1376
|
+
id?: string;
|
|
1377
|
+
/**
|
|
1378
|
+
* Format: flake-id
|
|
1379
|
+
* @description The Flake ID of the store associated with the Refund
|
|
1380
|
+
* @example 411486491630370816
|
|
1381
|
+
*/
|
|
1382
|
+
store_id?: string;
|
|
1383
|
+
/**
|
|
1384
|
+
* Format: flake-id
|
|
1385
|
+
* @description The Flake ID of Order associated with the refund
|
|
1386
|
+
* @example 411486491630370816
|
|
1387
|
+
*/
|
|
1388
|
+
order_id?: string;
|
|
1389
|
+
customer?: components["schemas"]["CustomerDTO"];
|
|
1390
|
+
/**
|
|
1391
|
+
* Format: flake-id
|
|
1392
|
+
* @description The Flake ID of the Payment associated with the refund
|
|
1393
|
+
* @example 411486491630370816
|
|
1394
|
+
*/
|
|
1395
|
+
payment_id?: string;
|
|
1396
|
+
/** @description The Payment Gateway associated with the refund */
|
|
1397
|
+
gateway?: string;
|
|
1398
|
+
/**
|
|
1399
|
+
* @description The ISO-4217 Currency Code of the Payment
|
|
1400
|
+
* @example USD
|
|
1401
|
+
*/
|
|
1402
|
+
currency?: string;
|
|
1403
|
+
/**
|
|
1404
|
+
* @description Indicates if taxes were inclusive in the associated payment
|
|
1405
|
+
* @example false
|
|
1406
|
+
*/
|
|
1407
|
+
tax_inclusive?: boolean;
|
|
1408
|
+
/**
|
|
1409
|
+
* @description The initial payment amount, represented in cents
|
|
1410
|
+
* @example 5000
|
|
1411
|
+
*/
|
|
1412
|
+
amount?: number;
|
|
1413
|
+
/**
|
|
1414
|
+
* @description The initial gateway fee amount, represented in cents
|
|
1415
|
+
* @example 150
|
|
1416
|
+
*/
|
|
1417
|
+
gateway_fee_amount?: number;
|
|
1418
|
+
/**
|
|
1419
|
+
* @description The initial tax amount, represented in cents
|
|
1420
|
+
* @example 800
|
|
1421
|
+
*/
|
|
1422
|
+
tax_amount?: number;
|
|
1423
|
+
/**
|
|
1424
|
+
* @description The initial platform fee amount, represented in cents
|
|
1425
|
+
* @example 250
|
|
1426
|
+
*/
|
|
1427
|
+
platform_fee_amount?: number;
|
|
1428
|
+
/**
|
|
1429
|
+
* @description The initial store net amount, represented in cents
|
|
1430
|
+
* @example 3800
|
|
1431
|
+
*/
|
|
1432
|
+
store_net_amount?: number;
|
|
1433
|
+
/**
|
|
1434
|
+
* @description The amount refunded to the store, represented in cents
|
|
1435
|
+
* @example 5000
|
|
1436
|
+
*/
|
|
1437
|
+
store_refund_amount?: number;
|
|
1438
|
+
/**
|
|
1439
|
+
* Format: date-time
|
|
1440
|
+
* @description Indicates when the refund was created
|
|
1441
|
+
* @example 2024-01-20T12:00:00Z
|
|
1442
|
+
*/
|
|
1443
|
+
created_at?: string;
|
|
1444
|
+
/**
|
|
1445
|
+
* Format: date-time
|
|
1446
|
+
* @description Indicates when the refund was approved
|
|
1447
|
+
* @example 2024-01-20T12:30:00Z
|
|
1448
|
+
*/
|
|
1449
|
+
approved_at?: string;
|
|
1450
|
+
/**
|
|
1451
|
+
* Format: date-time
|
|
1452
|
+
* @description Indicates when the refund was pending
|
|
1453
|
+
* @example 2024-01-20T12:15:00Z
|
|
1454
|
+
*/
|
|
1455
|
+
pending_at?: string;
|
|
1456
|
+
/**
|
|
1457
|
+
* Format: date-time
|
|
1458
|
+
* @description Indicates when the refund was completed
|
|
1459
|
+
* @example 2024-01-20T13:00:00Z
|
|
1460
|
+
*/
|
|
1461
|
+
completed_at?: string;
|
|
1462
|
+
/**
|
|
1463
|
+
* @description The email address of the intial payment customer
|
|
1464
|
+
* @example john@doe.com
|
|
1465
|
+
*/
|
|
1466
|
+
billing_email?: string;
|
|
1467
|
+
/**
|
|
1468
|
+
* @description The status of the refund. Possible options: created, approved, processing, completed, canceled, failed
|
|
1469
|
+
* @example created
|
|
1470
|
+
*/
|
|
1471
|
+
status?: string;
|
|
1472
|
+
};
|
|
1473
|
+
};
|
|
1474
|
+
};
|
|
1475
|
+
};
|
|
1476
|
+
responses: {
|
|
1477
|
+
/** @description Webhook processed successfully */
|
|
1478
|
+
200: {
|
|
1479
|
+
headers: {
|
|
1480
|
+
[name: string]: unknown;
|
|
1481
|
+
};
|
|
1482
|
+
content?: never;
|
|
1483
|
+
};
|
|
1484
|
+
/** @description Bad request */
|
|
1485
|
+
400: {
|
|
1486
|
+
headers: {
|
|
1487
|
+
[name: string]: unknown;
|
|
1488
|
+
};
|
|
1489
|
+
content?: never;
|
|
1490
|
+
};
|
|
1491
|
+
/** @description Internal server error */
|
|
1492
|
+
500: {
|
|
1493
|
+
headers: {
|
|
1494
|
+
[name: string]: unknown;
|
|
1495
|
+
};
|
|
1496
|
+
content?: never;
|
|
1497
|
+
};
|
|
1498
|
+
};
|
|
1499
|
+
};
|
|
1500
|
+
delete?: never;
|
|
1501
|
+
options?: never;
|
|
1502
|
+
head?: never;
|
|
1503
|
+
patch?: never;
|
|
1504
|
+
trace?: never;
|
|
1505
|
+
};
|
|
1506
|
+
OnSubscriptionActivated: {
|
|
1507
|
+
parameters: {
|
|
1508
|
+
query?: never;
|
|
1509
|
+
header?: never;
|
|
1510
|
+
path?: never;
|
|
1511
|
+
cookie?: never;
|
|
1512
|
+
};
|
|
1513
|
+
get?: never;
|
|
1514
|
+
put?: never;
|
|
1515
|
+
/**
|
|
1516
|
+
* Triggered when a subscription is activated
|
|
1517
|
+
* @description Webhook for OnSubscriptionActivated
|
|
1518
|
+
*/
|
|
1519
|
+
post: {
|
|
1520
|
+
parameters: {
|
|
1521
|
+
query?: never;
|
|
1522
|
+
header?: never;
|
|
1523
|
+
path?: never;
|
|
1524
|
+
cookie?: never;
|
|
1525
|
+
};
|
|
1526
|
+
requestBody: {
|
|
1527
|
+
content: {
|
|
1528
|
+
"application/json": {
|
|
1529
|
+
event_type: components["schemas"]["WebhookEventType"];
|
|
1530
|
+
/**
|
|
1531
|
+
* Format: flake-id
|
|
1532
|
+
* @description The ID of the Webhook Event
|
|
1533
|
+
* @example 411486491630370816
|
|
1534
|
+
*/
|
|
1535
|
+
event_id?: string;
|
|
1536
|
+
body: {
|
|
1537
|
+
/**
|
|
1538
|
+
* Format: flake-id
|
|
1539
|
+
* @description The Flake ID of the Subscription
|
|
1540
|
+
* @example 411486491630370816
|
|
1541
|
+
*/
|
|
1542
|
+
id?: string;
|
|
1543
|
+
/**
|
|
1544
|
+
* Format: flake-id
|
|
1545
|
+
* @description The Flake ID of the Store associated with the Subscription
|
|
1546
|
+
* @example 411486491630370816
|
|
1547
|
+
*/
|
|
1548
|
+
store_id?: string;
|
|
1549
|
+
/**
|
|
1550
|
+
* Format: flake-id
|
|
1551
|
+
* @description The Flake ID of the Customer associated with the Subscription
|
|
1552
|
+
* @example 411486491630370816
|
|
1553
|
+
*/
|
|
1554
|
+
customer_id?: string;
|
|
1555
|
+
customer?: components["schemas"]["CustomerDTO"];
|
|
1556
|
+
/**
|
|
1557
|
+
* @description The current billing cycle number
|
|
1558
|
+
* @example 1
|
|
1559
|
+
*/
|
|
1560
|
+
billing_cycle_sequence?: number;
|
|
1561
|
+
/**
|
|
1562
|
+
* @description The billing email address of the customer associated with the Subscription
|
|
1563
|
+
* @example john@doe.com
|
|
1564
|
+
*/
|
|
1565
|
+
billing_email?: string;
|
|
1566
|
+
/**
|
|
1567
|
+
* @description The subtotal amount of the Subscription represented in cents
|
|
1568
|
+
* @example 9999
|
|
1569
|
+
*/
|
|
1570
|
+
subtotal_amount?: number;
|
|
1571
|
+
/**
|
|
1572
|
+
* @description The tax amount of the Subscription represented in cents
|
|
1573
|
+
* @example 1500
|
|
1574
|
+
*/
|
|
1575
|
+
tax_amount?: number;
|
|
1576
|
+
/**
|
|
1577
|
+
* @description The discount amount applied to the Subscription represented in cents
|
|
1578
|
+
* @example 1000
|
|
1579
|
+
*/
|
|
1580
|
+
discount_amount?: number;
|
|
1581
|
+
/**
|
|
1582
|
+
* @description The total amount of the Subscription represented in cents
|
|
1583
|
+
* @example 10499
|
|
1584
|
+
*/
|
|
1585
|
+
total_amount?: number;
|
|
1586
|
+
/**
|
|
1587
|
+
* @description The currency code of the Subscription
|
|
1588
|
+
* @example USD
|
|
1589
|
+
*/
|
|
1590
|
+
currency?: string;
|
|
1591
|
+
/**
|
|
1592
|
+
* @description The interval value of the billing cycle
|
|
1593
|
+
* @example 1
|
|
1594
|
+
*/
|
|
1595
|
+
interval_value?: number;
|
|
1596
|
+
/**
|
|
1597
|
+
* @description The interval scale of the billing cycle
|
|
1598
|
+
* @example month
|
|
1599
|
+
*/
|
|
1600
|
+
interval_scale?: string;
|
|
1601
|
+
/**
|
|
1602
|
+
* Format: flake-id
|
|
1603
|
+
* @description The Flake ID of the Product associated with the Subscription
|
|
1604
|
+
* @example 411486491630370816
|
|
1605
|
+
*/
|
|
1606
|
+
product_id?: string;
|
|
1607
|
+
/**
|
|
1608
|
+
* Format: flake-id
|
|
1609
|
+
* @description The Flake ID of the Product Version associated with the Subscription
|
|
1610
|
+
* @example 411486491630370816
|
|
1611
|
+
*/
|
|
1612
|
+
product_version_id?: string;
|
|
1613
|
+
/**
|
|
1614
|
+
* @description The name of the Product associated with the Subscription
|
|
1615
|
+
* @example Example Product
|
|
1616
|
+
*/
|
|
1617
|
+
product_name?: string;
|
|
1618
|
+
/**
|
|
1619
|
+
* @description The image URL of the Product associated with the Subscription
|
|
1620
|
+
* @example https://example.com/image.jpg
|
|
1621
|
+
*/
|
|
1622
|
+
product_image_url?: string;
|
|
1623
|
+
product?: components["schemas"]["ProductDTO"];
|
|
1624
|
+
/**
|
|
1625
|
+
* @description The ISO-3166 Country Code of customer associated with the Subscription
|
|
1626
|
+
* @example US
|
|
1627
|
+
*/
|
|
1628
|
+
billing_country?: string;
|
|
1629
|
+
/**
|
|
1630
|
+
* @description The initial subtotal amount of the Subscription represented in cents
|
|
1631
|
+
* @example 9999
|
|
1632
|
+
*/
|
|
1633
|
+
initial_subtotal_amount?: number;
|
|
1634
|
+
/**
|
|
1635
|
+
* @description The initial tax amount of the Subscription represented in cents
|
|
1636
|
+
* @example 1500
|
|
1637
|
+
*/
|
|
1638
|
+
initial_tax_amount?: number;
|
|
1639
|
+
/**
|
|
1640
|
+
* @description The initial discount amount applied to the Subscription represented in cents
|
|
1641
|
+
* @example 2000
|
|
1642
|
+
*/
|
|
1643
|
+
initial_discount_amount?: number;
|
|
1644
|
+
/**
|
|
1645
|
+
* @description The initial gift card usage amount applied to the Subscription represented in cents
|
|
1646
|
+
* @example 0
|
|
1647
|
+
*/
|
|
1648
|
+
initial_giftcard_usage_amount?: number;
|
|
1649
|
+
/**
|
|
1650
|
+
* @description The initial total amount of the Subscription represented in cents
|
|
1651
|
+
* @example 9499
|
|
1652
|
+
*/
|
|
1653
|
+
initial_total_amount?: number;
|
|
1654
|
+
/**
|
|
1655
|
+
* @description The IP address of the Customer
|
|
1656
|
+
* @example 127.0.0.1/24
|
|
1657
|
+
*/
|
|
1658
|
+
customer_ip?: string;
|
|
1659
|
+
/**
|
|
1660
|
+
* Format: date-time
|
|
1661
|
+
* @description The start date of the current billing period
|
|
1662
|
+
* @example 2024-02-01T00:00:00Z
|
|
1663
|
+
*/
|
|
1664
|
+
current_period_start?: string;
|
|
1665
|
+
/**
|
|
1666
|
+
* Format: date-time
|
|
1667
|
+
* @description The end date of the current billing period
|
|
1668
|
+
* @example 2024-03-01T00:00:00Z
|
|
1669
|
+
*/
|
|
1670
|
+
current_period_end?: string;
|
|
1671
|
+
/**
|
|
1672
|
+
* Format: date-time
|
|
1673
|
+
* @description The date and time when the Subscription was created
|
|
1674
|
+
* @example 2024-02-01T10:15:00Z
|
|
1675
|
+
*/
|
|
1676
|
+
created_at?: string;
|
|
1677
|
+
/**
|
|
1678
|
+
* Format: date-time
|
|
1679
|
+
* @description Indicates when the subscription was active
|
|
1680
|
+
* @example 2024-02-01T10:20:00Z
|
|
1681
|
+
*/
|
|
1682
|
+
active_at?: string;
|
|
1683
|
+
/**
|
|
1684
|
+
* Format: flake-id
|
|
1685
|
+
* @description The Flake ID of the Checkout associated with the Subscription
|
|
1686
|
+
* @example 411486491630370816
|
|
1687
|
+
*/
|
|
1688
|
+
checkout_id?: string;
|
|
1689
|
+
/**
|
|
1690
|
+
* Format: flake-id
|
|
1691
|
+
* @description The Flake ID of the Checkout Line associated with the Subscription
|
|
1692
|
+
* @example 411486491630370816
|
|
1693
|
+
*/
|
|
1694
|
+
checkout_line_id?: string;
|
|
1695
|
+
/**
|
|
1696
|
+
* @description The current status of the Subscription. Possible options: created, active, canceled
|
|
1697
|
+
* @example created
|
|
1698
|
+
*/
|
|
1699
|
+
status?: string;
|
|
1700
|
+
};
|
|
1701
|
+
};
|
|
1702
|
+
};
|
|
1703
|
+
};
|
|
1704
|
+
responses: {
|
|
1705
|
+
/** @description Webhook processed successfully */
|
|
1706
|
+
200: {
|
|
1707
|
+
headers: {
|
|
1708
|
+
[name: string]: unknown;
|
|
1709
|
+
};
|
|
1710
|
+
content?: never;
|
|
1711
|
+
};
|
|
1712
|
+
/** @description Bad request */
|
|
1713
|
+
400: {
|
|
1714
|
+
headers: {
|
|
1715
|
+
[name: string]: unknown;
|
|
1716
|
+
};
|
|
1717
|
+
content?: never;
|
|
1718
|
+
};
|
|
1719
|
+
/** @description Internal server error */
|
|
1720
|
+
500: {
|
|
1721
|
+
headers: {
|
|
1722
|
+
[name: string]: unknown;
|
|
1723
|
+
};
|
|
1724
|
+
content?: never;
|
|
1725
|
+
};
|
|
1726
|
+
};
|
|
1727
|
+
};
|
|
1728
|
+
delete?: never;
|
|
1729
|
+
options?: never;
|
|
1730
|
+
head?: never;
|
|
1731
|
+
patch?: never;
|
|
1732
|
+
trace?: never;
|
|
1733
|
+
};
|
|
1734
|
+
OnSubscriptionCanceled: {
|
|
1735
|
+
parameters: {
|
|
1736
|
+
query?: never;
|
|
1737
|
+
header?: never;
|
|
1738
|
+
path?: never;
|
|
1739
|
+
cookie?: never;
|
|
1740
|
+
};
|
|
1741
|
+
get?: never;
|
|
1742
|
+
put?: never;
|
|
1743
|
+
/**
|
|
1744
|
+
* Triggered when a subscription is canceled
|
|
1745
|
+
* @description Webhook for OnSubscriptionCanceled
|
|
1746
|
+
*/
|
|
1747
|
+
post: {
|
|
1748
|
+
parameters: {
|
|
1749
|
+
query?: never;
|
|
1750
|
+
header?: never;
|
|
1751
|
+
path?: never;
|
|
1752
|
+
cookie?: never;
|
|
1753
|
+
};
|
|
1754
|
+
requestBody: {
|
|
1755
|
+
content: {
|
|
1756
|
+
"application/json": {
|
|
1757
|
+
event_type: components["schemas"]["WebhookEventType"];
|
|
1758
|
+
/**
|
|
1759
|
+
* Format: flake-id
|
|
1760
|
+
* @description The ID of the Webhook Event
|
|
1761
|
+
* @example 411486491630370816
|
|
1762
|
+
*/
|
|
1763
|
+
event_id?: string;
|
|
1764
|
+
body: {
|
|
1765
|
+
/**
|
|
1766
|
+
* Format: flake-id
|
|
1767
|
+
* @description The Flake ID of the Subscription
|
|
1768
|
+
* @example 411486491630370816
|
|
1769
|
+
*/
|
|
1770
|
+
id?: string;
|
|
1771
|
+
/**
|
|
1772
|
+
* Format: flake-id
|
|
1773
|
+
* @description The Flake ID of the Store associated with the Subscription
|
|
1774
|
+
* @example 411486491630370816
|
|
1775
|
+
*/
|
|
1776
|
+
store_id?: string;
|
|
1777
|
+
/**
|
|
1778
|
+
* Format: flake-id
|
|
1779
|
+
* @description The Flake ID of the Customer associated with the Subscription
|
|
1780
|
+
* @example 411486491630370816
|
|
1781
|
+
*/
|
|
1782
|
+
customer_id?: string;
|
|
1783
|
+
customer?: components["schemas"]["CustomerDTO"];
|
|
1784
|
+
/**
|
|
1785
|
+
* @description The current billing cycle number
|
|
1786
|
+
* @example 1
|
|
1787
|
+
*/
|
|
1788
|
+
billing_cycle_sequence?: number;
|
|
1789
|
+
/**
|
|
1790
|
+
* @description The billing email address of the customer associated with the Subscription
|
|
1791
|
+
* @example cancel@example.com
|
|
1792
|
+
*/
|
|
1793
|
+
billing_email?: string;
|
|
1794
|
+
/**
|
|
1795
|
+
* @description The subtotal amount of the Subscription represented in cents
|
|
1796
|
+
* @example 4999
|
|
1797
|
+
*/
|
|
1798
|
+
subtotal_amount?: number;
|
|
1799
|
+
/**
|
|
1800
|
+
* @description The tax amount of the Subscription represented in cents
|
|
1801
|
+
* @example 750
|
|
1802
|
+
*/
|
|
1803
|
+
tax_amount?: number;
|
|
1804
|
+
/**
|
|
1805
|
+
* @description The discount amount applied to the Subscription represented in cents
|
|
1806
|
+
* @example 0
|
|
1807
|
+
*/
|
|
1808
|
+
discount_amount?: number;
|
|
1809
|
+
/**
|
|
1810
|
+
* @description The total amount of the Subscription represented in cents
|
|
1811
|
+
* @example 5749
|
|
1812
|
+
*/
|
|
1813
|
+
total_amount?: number;
|
|
1814
|
+
/**
|
|
1815
|
+
* @description The currency code of the Subscription
|
|
1816
|
+
* @example USD
|
|
1817
|
+
*/
|
|
1818
|
+
currency?: string;
|
|
1819
|
+
/**
|
|
1820
|
+
* @description The interval value of the billing cycle
|
|
1821
|
+
* @example 1
|
|
1822
|
+
*/
|
|
1823
|
+
interval_value?: number;
|
|
1824
|
+
/**
|
|
1825
|
+
* @description The interval scale of the billing cycle
|
|
1826
|
+
* @example annually
|
|
1827
|
+
*/
|
|
1828
|
+
interval_scale?: string;
|
|
1829
|
+
/**
|
|
1830
|
+
* Format: flake-id
|
|
1831
|
+
* @description The Flake ID of the Product associated with the Subscription
|
|
1832
|
+
* @example 411486491630370816
|
|
1833
|
+
*/
|
|
1834
|
+
product_id?: string;
|
|
1835
|
+
/**
|
|
1836
|
+
* Format: flake-id
|
|
1837
|
+
* @description The Flake ID of the Product Version associated with the Subscription
|
|
1838
|
+
* @example 411486491630370816
|
|
1839
|
+
*/
|
|
1840
|
+
product_version_id?: string;
|
|
1841
|
+
/**
|
|
1842
|
+
* @description The name of the Product associated with the Subscription
|
|
1843
|
+
* @example Starter Plan
|
|
1844
|
+
*/
|
|
1845
|
+
product_name?: string;
|
|
1846
|
+
/**
|
|
1847
|
+
* @description The image URL of the Product associated with the Subscription
|
|
1848
|
+
* @example https://example.com/starter.jpg
|
|
1849
|
+
*/
|
|
1850
|
+
product_image_url?: string;
|
|
1851
|
+
product?: components["schemas"]["ProductDTO"];
|
|
1852
|
+
/**
|
|
1853
|
+
* @description The ISO-3166 country code of customer associated with the Subscription
|
|
1854
|
+
* @example US
|
|
1855
|
+
*/
|
|
1856
|
+
billing_country?: string;
|
|
1857
|
+
/**
|
|
1858
|
+
* @description The initial subtotal amount of the Subscription represented in cents
|
|
1859
|
+
* @example 4999
|
|
1860
|
+
*/
|
|
1861
|
+
initial_subtotal_amount?: number;
|
|
1862
|
+
/**
|
|
1863
|
+
* @description The initial tax amount of the Subscription represented in cents
|
|
1864
|
+
* @example 750
|
|
1865
|
+
*/
|
|
1866
|
+
initial_tax_amount?: number;
|
|
1867
|
+
/**
|
|
1868
|
+
* @description The initial discount amount applied to the Subscription represented in cents
|
|
1869
|
+
* @example 500
|
|
1870
|
+
*/
|
|
1871
|
+
initial_discount_amount?: number;
|
|
1872
|
+
/**
|
|
1873
|
+
* @description The initial gift card usage amount applied to the Subscription represented in cents
|
|
1874
|
+
* @example 0
|
|
1875
|
+
*/
|
|
1876
|
+
initial_giftcard_usage_amount?: number;
|
|
1877
|
+
/**
|
|
1878
|
+
* @description The initial total amount of the Subscription represented in cents
|
|
1879
|
+
* @example 5249
|
|
1880
|
+
*/
|
|
1881
|
+
initial_total_amount?: number;
|
|
1882
|
+
/**
|
|
1883
|
+
* @description The IP address of the Customer
|
|
1884
|
+
* @example 127.0.0.1/24
|
|
1885
|
+
*/
|
|
1886
|
+
customer_ip?: string;
|
|
1887
|
+
/**
|
|
1888
|
+
* Format: date-time
|
|
1889
|
+
* @description The start date of the current billing period
|
|
1890
|
+
* @example 2024-04-01T00:00:00Z
|
|
1891
|
+
*/
|
|
1892
|
+
current_period_start?: string;
|
|
1893
|
+
/**
|
|
1894
|
+
* Format: date-time
|
|
1895
|
+
* @description The end date of the current billing period
|
|
1896
|
+
* @example 2025-04-01T00:00:00Z
|
|
1897
|
+
*/
|
|
1898
|
+
current_period_end?: string;
|
|
1899
|
+
/**
|
|
1900
|
+
* Format: date-time
|
|
1901
|
+
* @description The date and time when the Subscription was created
|
|
1902
|
+
* @example 2024-04-01T09:30:00Z
|
|
1903
|
+
*/
|
|
1904
|
+
created_at?: string;
|
|
1905
|
+
/**
|
|
1906
|
+
* Format: date-time
|
|
1907
|
+
* @description Indicates when the subscription was active
|
|
1908
|
+
* @example 2024-04-01T09:35:00Z
|
|
1909
|
+
*/
|
|
1910
|
+
active_at?: string;
|
|
1911
|
+
/**
|
|
1912
|
+
* Format: date-time
|
|
1913
|
+
* @description Indicates when the subscription was canceled
|
|
1914
|
+
* @example 2024-05-15T14:20:00Z
|
|
1915
|
+
*/
|
|
1916
|
+
canceled_at?: string;
|
|
1917
|
+
/**
|
|
1918
|
+
* @description The reason for the subscription cancellation
|
|
1919
|
+
* @example customer_request
|
|
1920
|
+
*/
|
|
1921
|
+
cancel_reason?: string;
|
|
1922
|
+
/**
|
|
1923
|
+
* Format: flake-id
|
|
1924
|
+
* @description The Flake ID of the Checkout associated with the Subscription
|
|
1925
|
+
* @example 411486491630370816
|
|
1926
|
+
*/
|
|
1927
|
+
checkout_id?: string;
|
|
1928
|
+
/**
|
|
1929
|
+
* Format: flake-id
|
|
1930
|
+
* @description The Flake ID of the Checkout Line associated with the Subscription
|
|
1931
|
+
* @example 411486491630370816
|
|
1932
|
+
*/
|
|
1933
|
+
checkout_line_id?: string;
|
|
1934
|
+
/**
|
|
1935
|
+
* @description The current status of the Subscription. Possible options: created, active, canceled
|
|
1936
|
+
* @example created
|
|
1937
|
+
*/
|
|
1938
|
+
status?: string;
|
|
1939
|
+
};
|
|
1940
|
+
};
|
|
1941
|
+
};
|
|
1942
|
+
};
|
|
1943
|
+
responses: {
|
|
1944
|
+
/** @description Webhook processed successfully */
|
|
1945
|
+
200: {
|
|
1946
|
+
headers: {
|
|
1947
|
+
[name: string]: unknown;
|
|
1948
|
+
};
|
|
1949
|
+
content?: never;
|
|
1950
|
+
};
|
|
1951
|
+
/** @description Bad request */
|
|
1952
|
+
400: {
|
|
1953
|
+
headers: {
|
|
1954
|
+
[name: string]: unknown;
|
|
1955
|
+
};
|
|
1956
|
+
content?: never;
|
|
1957
|
+
};
|
|
1958
|
+
/** @description Internal server error */
|
|
1959
|
+
500: {
|
|
1960
|
+
headers: {
|
|
1961
|
+
[name: string]: unknown;
|
|
1962
|
+
};
|
|
1963
|
+
content?: never;
|
|
1964
|
+
};
|
|
1965
|
+
};
|
|
1966
|
+
};
|
|
1967
|
+
delete?: never;
|
|
1968
|
+
options?: never;
|
|
1969
|
+
head?: never;
|
|
1970
|
+
patch?: never;
|
|
1971
|
+
trace?: never;
|
|
1972
|
+
};
|
|
1973
|
+
OnTrialActivated: {
|
|
1974
|
+
parameters: {
|
|
1975
|
+
query?: never;
|
|
1976
|
+
header?: never;
|
|
1977
|
+
path?: never;
|
|
1978
|
+
cookie?: never;
|
|
1979
|
+
};
|
|
1980
|
+
get?: never;
|
|
1981
|
+
put?: never;
|
|
1982
|
+
/**
|
|
1983
|
+
* Triggered when a trial is activated
|
|
1984
|
+
* @description Webhook for OnTrialActivated
|
|
1985
|
+
*/
|
|
1986
|
+
post: {
|
|
1987
|
+
parameters: {
|
|
1988
|
+
query?: never;
|
|
1989
|
+
header?: never;
|
|
1990
|
+
path?: never;
|
|
1991
|
+
cookie?: never;
|
|
1992
|
+
};
|
|
1993
|
+
requestBody: {
|
|
1994
|
+
content: {
|
|
1995
|
+
"application/json": {
|
|
1996
|
+
event_type: components["schemas"]["WebhookEventType"];
|
|
1997
|
+
/**
|
|
1998
|
+
* Format: flake-id
|
|
1999
|
+
* @description The ID of the Webhook Event
|
|
2000
|
+
* @example 411486491630370816
|
|
2001
|
+
*/
|
|
2002
|
+
event_id?: string;
|
|
2003
|
+
body: {
|
|
2004
|
+
/**
|
|
2005
|
+
* Format: flake-id
|
|
2006
|
+
* @description The Flake ID of the Trial
|
|
2007
|
+
* @example 411486491630370816
|
|
2008
|
+
*/
|
|
2009
|
+
id?: string;
|
|
2010
|
+
/**
|
|
2011
|
+
* Format: flake-id
|
|
2012
|
+
* @description The Flake ID of the Store associated with the Trial
|
|
2013
|
+
* @example 411486491630370816
|
|
2014
|
+
*/
|
|
2015
|
+
store_id?: string;
|
|
2016
|
+
/**
|
|
2017
|
+
* Format: flake-id
|
|
2018
|
+
* @description The Flake ID of the Customer associated with the Trial
|
|
2019
|
+
* @example 411486491630370816
|
|
2020
|
+
*/
|
|
2021
|
+
customer_id?: string;
|
|
2022
|
+
customer?: components["schemas"]["CustomerDTO"];
|
|
2023
|
+
/**
|
|
2024
|
+
* Format: flake-id
|
|
2025
|
+
* @description The Flake ID of the Checkout associated with the Trial
|
|
2026
|
+
* @example 411486491630370816
|
|
2027
|
+
*/
|
|
2028
|
+
checkout_id?: string;
|
|
2029
|
+
/**
|
|
2030
|
+
* Format: flake-id
|
|
2031
|
+
* @description The Flake ID of the Checkout Line associated with the Trial
|
|
2032
|
+
* @example 411486491630370816
|
|
2033
|
+
*/
|
|
2034
|
+
checkout_line_id?: string;
|
|
2035
|
+
/**
|
|
2036
|
+
* Format: flake-id
|
|
2037
|
+
* @description The Flake ID of the Product associated with the Trial
|
|
2038
|
+
* @example 411486491630370816
|
|
2039
|
+
*/
|
|
2040
|
+
product_id?: string;
|
|
2041
|
+
/**
|
|
2042
|
+
* Format: flake-id
|
|
2043
|
+
* @description The Flake ID of the Product Version associated with the Trial
|
|
2044
|
+
* @example 411486491630370816
|
|
2045
|
+
*/
|
|
2046
|
+
product_version_id?: string;
|
|
2047
|
+
/**
|
|
2048
|
+
* @description The name of the Product associated with the Trial
|
|
2049
|
+
* @example Example Product
|
|
2050
|
+
*/
|
|
2051
|
+
product_name?: string;
|
|
2052
|
+
/**
|
|
2053
|
+
* @description The image URL of the Product associated with the Trial
|
|
2054
|
+
* @example https://example.com/image.jpg
|
|
2055
|
+
*/
|
|
2056
|
+
product_image_url?: string;
|
|
2057
|
+
/**
|
|
2058
|
+
* @description The period value of the Trial
|
|
2059
|
+
* @example 1
|
|
2060
|
+
*/
|
|
2061
|
+
period_value?: number;
|
|
2062
|
+
/**
|
|
2063
|
+
* @description The period scale of the Trial
|
|
2064
|
+
* @example month
|
|
2065
|
+
*/
|
|
2066
|
+
period_scale?: string;
|
|
2067
|
+
/**
|
|
2068
|
+
* Format: date-time
|
|
2069
|
+
* @description The start date of the Trial
|
|
2070
|
+
* @example 2024-06-10T00:00:00Z
|
|
2071
|
+
*/
|
|
2072
|
+
starts_at?: string;
|
|
2073
|
+
/**
|
|
2074
|
+
* Format: date-time
|
|
2075
|
+
* @description The end date of the Trial
|
|
2076
|
+
* @example 2024-06-17T23:59:59Z
|
|
2077
|
+
*/
|
|
2078
|
+
ends_at?: string;
|
|
2079
|
+
/**
|
|
2080
|
+
* @description The current status of the Trial. Possible options: created, active, canceled, completed
|
|
2081
|
+
* @example created
|
|
2082
|
+
*/
|
|
2083
|
+
status?: string;
|
|
2084
|
+
/**
|
|
2085
|
+
* Format: date-time
|
|
2086
|
+
* @description The date and time when the Trial was created
|
|
2087
|
+
* @example 2024-06-10T08:30:00Z
|
|
2088
|
+
*/
|
|
2089
|
+
created_at?: string;
|
|
2090
|
+
/**
|
|
2091
|
+
* Format: date-time
|
|
2092
|
+
* @description Indicates when the Trial was canceled
|
|
2093
|
+
* @example 2024-06-15T10:15:00Z
|
|
2094
|
+
*/
|
|
2095
|
+
canceled_at?: string;
|
|
2096
|
+
};
|
|
2097
|
+
};
|
|
2098
|
+
};
|
|
2099
|
+
};
|
|
2100
|
+
responses: {
|
|
2101
|
+
/** @description Webhook processed successfully */
|
|
2102
|
+
200: {
|
|
2103
|
+
headers: {
|
|
2104
|
+
[name: string]: unknown;
|
|
2105
|
+
};
|
|
2106
|
+
content?: never;
|
|
2107
|
+
};
|
|
2108
|
+
/** @description Bad request */
|
|
2109
|
+
400: {
|
|
2110
|
+
headers: {
|
|
2111
|
+
[name: string]: unknown;
|
|
2112
|
+
};
|
|
2113
|
+
content?: never;
|
|
2114
|
+
};
|
|
2115
|
+
/** @description Internal server error */
|
|
2116
|
+
500: {
|
|
2117
|
+
headers: {
|
|
2118
|
+
[name: string]: unknown;
|
|
2119
|
+
};
|
|
2120
|
+
content?: never;
|
|
2121
|
+
};
|
|
2122
|
+
};
|
|
2123
|
+
};
|
|
2124
|
+
delete?: never;
|
|
2125
|
+
options?: never;
|
|
2126
|
+
head?: never;
|
|
2127
|
+
patch?: never;
|
|
2128
|
+
trace?: never;
|
|
2129
|
+
};
|
|
2130
|
+
OnTrialCompleted: {
|
|
2131
|
+
parameters: {
|
|
2132
|
+
query?: never;
|
|
2133
|
+
header?: never;
|
|
2134
|
+
path?: never;
|
|
2135
|
+
cookie?: never;
|
|
2136
|
+
};
|
|
2137
|
+
get?: never;
|
|
2138
|
+
put?: never;
|
|
2139
|
+
/**
|
|
2140
|
+
* Triggered when a trial is completed
|
|
2141
|
+
* @description Webhook for OnTrialCompleted
|
|
2142
|
+
*/
|
|
2143
|
+
post: {
|
|
2144
|
+
parameters: {
|
|
2145
|
+
query?: never;
|
|
2146
|
+
header?: never;
|
|
2147
|
+
path?: never;
|
|
2148
|
+
cookie?: never;
|
|
2149
|
+
};
|
|
2150
|
+
requestBody: {
|
|
2151
|
+
content: {
|
|
2152
|
+
"application/json": {
|
|
2153
|
+
event_type: components["schemas"]["WebhookEventType"];
|
|
2154
|
+
/**
|
|
2155
|
+
* Format: flake-id
|
|
2156
|
+
* @description The ID of the Webhook Event
|
|
2157
|
+
* @example 411486491630370816
|
|
2158
|
+
*/
|
|
2159
|
+
event_id?: string;
|
|
2160
|
+
body: {
|
|
2161
|
+
/**
|
|
2162
|
+
* Format: flake-id
|
|
2163
|
+
* @description The Flake ID of the Trial
|
|
2164
|
+
* @example 411486491630370816
|
|
2165
|
+
*/
|
|
2166
|
+
id?: string;
|
|
2167
|
+
/**
|
|
2168
|
+
* Format: flake-id
|
|
2169
|
+
* @description The Flake ID of the Store associated with the Trial
|
|
2170
|
+
* @example 411486491630370816
|
|
2171
|
+
*/
|
|
2172
|
+
store_id?: string;
|
|
2173
|
+
/**
|
|
2174
|
+
* Format: flake-id
|
|
2175
|
+
* @description The Flake ID of the Customer associated with the Trial
|
|
2176
|
+
* @example 411486491630370816
|
|
2177
|
+
*/
|
|
2178
|
+
customer_id?: string;
|
|
2179
|
+
customer?: components["schemas"]["CustomerDTO"];
|
|
2180
|
+
/**
|
|
2181
|
+
* Format: flake-id
|
|
2182
|
+
* @description The Flake ID of the Checkout associated with the Trial
|
|
2183
|
+
* @example 411486491630370816
|
|
2184
|
+
*/
|
|
2185
|
+
checkout_id?: string;
|
|
2186
|
+
/**
|
|
2187
|
+
* Format: flake-id
|
|
2188
|
+
* @description The Flake ID of the Checkout Line associated with the Trial
|
|
2189
|
+
* @example 411486491630370816
|
|
2190
|
+
*/
|
|
2191
|
+
checkout_line_id?: string;
|
|
2192
|
+
/**
|
|
2193
|
+
* Format: flake-id
|
|
2194
|
+
* @description The Flake ID of the Product associated with the Trial
|
|
2195
|
+
* @example 411486491630370816
|
|
2196
|
+
*/
|
|
2197
|
+
product_id?: string;
|
|
2198
|
+
/**
|
|
2199
|
+
* Format: flake-id
|
|
2200
|
+
* @description The Flake ID of the Product Version associated with the Trial
|
|
2201
|
+
* @example 411486491630370816
|
|
2202
|
+
*/
|
|
2203
|
+
product_version_id?: string;
|
|
2204
|
+
/**
|
|
2205
|
+
* @description The name of the Product associated with the Trial
|
|
2206
|
+
* @example Example Product
|
|
2207
|
+
*/
|
|
2208
|
+
product_name?: string;
|
|
2209
|
+
/**
|
|
2210
|
+
* @description The image URL of the Product associated with the Trial
|
|
2211
|
+
* @example https://example.com/image.jpg
|
|
2212
|
+
*/
|
|
2213
|
+
product_image_url?: string;
|
|
2214
|
+
/**
|
|
2215
|
+
* @description The period value of the Trial
|
|
2216
|
+
* @example 1
|
|
2217
|
+
*/
|
|
2218
|
+
period_value?: number;
|
|
2219
|
+
/**
|
|
2220
|
+
* @description The period scale of the Trial
|
|
2221
|
+
* @example month
|
|
2222
|
+
*/
|
|
2223
|
+
period_scale?: string;
|
|
2224
|
+
/**
|
|
2225
|
+
* Format: date-time
|
|
2226
|
+
* @description The start date of the Trial
|
|
2227
|
+
* @example 2024-06-10T00:00:00Z
|
|
2228
|
+
*/
|
|
2229
|
+
starts_at?: string;
|
|
2230
|
+
/**
|
|
2231
|
+
* Format: date-time
|
|
2232
|
+
* @description The end date of the Trial
|
|
2233
|
+
* @example 2024-06-17T23:59:59Z
|
|
2234
|
+
*/
|
|
2235
|
+
ends_at?: string;
|
|
2236
|
+
/**
|
|
2237
|
+
* @description The current status of the Trial. Possible options: created, active, canceled, completed
|
|
2238
|
+
* @example created
|
|
2239
|
+
*/
|
|
2240
|
+
status?: string;
|
|
2241
|
+
/**
|
|
2242
|
+
* Format: date-time
|
|
2243
|
+
* @description The date and time when the Trial was created
|
|
2244
|
+
* @example 2024-06-10T08:30:00Z
|
|
2245
|
+
*/
|
|
2246
|
+
created_at?: string;
|
|
2247
|
+
/**
|
|
2248
|
+
* Format: date-time
|
|
2249
|
+
* @description Indicates when the Trial was canceled
|
|
2250
|
+
* @example 2024-06-15T10:15:00Z
|
|
2251
|
+
*/
|
|
2252
|
+
canceled_at?: string;
|
|
2253
|
+
};
|
|
2254
|
+
};
|
|
2255
|
+
};
|
|
2256
|
+
};
|
|
2257
|
+
responses: {
|
|
2258
|
+
/** @description Webhook processed successfully */
|
|
2259
|
+
200: {
|
|
2260
|
+
headers: {
|
|
2261
|
+
[name: string]: unknown;
|
|
2262
|
+
};
|
|
2263
|
+
content?: never;
|
|
2264
|
+
};
|
|
2265
|
+
/** @description Bad request */
|
|
2266
|
+
400: {
|
|
2267
|
+
headers: {
|
|
2268
|
+
[name: string]: unknown;
|
|
2269
|
+
};
|
|
2270
|
+
content?: never;
|
|
2271
|
+
};
|
|
2272
|
+
/** @description Internal server error */
|
|
2273
|
+
500: {
|
|
2274
|
+
headers: {
|
|
2275
|
+
[name: string]: unknown;
|
|
2276
|
+
};
|
|
2277
|
+
content?: never;
|
|
2278
|
+
};
|
|
2279
|
+
};
|
|
2280
|
+
};
|
|
2281
|
+
delete?: never;
|
|
2282
|
+
options?: never;
|
|
2283
|
+
head?: never;
|
|
2284
|
+
patch?: never;
|
|
2285
|
+
trace?: never;
|
|
2286
|
+
};
|
|
2287
|
+
OnTrialCanceled: {
|
|
2288
|
+
parameters: {
|
|
2289
|
+
query?: never;
|
|
2290
|
+
header?: never;
|
|
2291
|
+
path?: never;
|
|
2292
|
+
cookie?: never;
|
|
2293
|
+
};
|
|
2294
|
+
get?: never;
|
|
2295
|
+
put?: never;
|
|
2296
|
+
/**
|
|
2297
|
+
* Triggered when a trial is canceled
|
|
2298
|
+
* @description Webhook for OnTrialCanceled
|
|
2299
|
+
*/
|
|
2300
|
+
post: {
|
|
2301
|
+
parameters: {
|
|
2302
|
+
query?: never;
|
|
2303
|
+
header?: never;
|
|
2304
|
+
path?: never;
|
|
2305
|
+
cookie?: never;
|
|
2306
|
+
};
|
|
2307
|
+
requestBody: {
|
|
2308
|
+
content: {
|
|
2309
|
+
"application/json": {
|
|
2310
|
+
event_type: components["schemas"]["WebhookEventType"];
|
|
2311
|
+
/**
|
|
2312
|
+
* Format: flake-id
|
|
2313
|
+
* @description The ID of the Webhook Event
|
|
2314
|
+
* @example 411486491630370816
|
|
2315
|
+
*/
|
|
2316
|
+
event_id?: string;
|
|
2317
|
+
body: {
|
|
2318
|
+
/**
|
|
2319
|
+
* Format: flake-id
|
|
2320
|
+
* @description The Flake ID of the Trial
|
|
2321
|
+
* @example 411486491630370816
|
|
2322
|
+
*/
|
|
2323
|
+
id?: string;
|
|
2324
|
+
/**
|
|
2325
|
+
* Format: flake-id
|
|
2326
|
+
* @description The Flake ID of the Store associated with the Trial
|
|
2327
|
+
* @example 411486491630370816
|
|
2328
|
+
*/
|
|
2329
|
+
store_id?: string;
|
|
2330
|
+
/**
|
|
2331
|
+
* Format: flake-id
|
|
2332
|
+
* @description The Flake ID of the Customer associated with the Trial
|
|
2333
|
+
* @example 411486491630370816
|
|
2334
|
+
*/
|
|
2335
|
+
customer_id?: string;
|
|
2336
|
+
customer?: components["schemas"]["CustomerDTO"];
|
|
2337
|
+
/**
|
|
2338
|
+
* Format: flake-id
|
|
2339
|
+
* @description The Flake ID of the Checkout associated with the Trial
|
|
2340
|
+
* @example 411486491630370816
|
|
2341
|
+
*/
|
|
2342
|
+
checkout_id?: string;
|
|
2343
|
+
/**
|
|
2344
|
+
* Format: flake-id
|
|
2345
|
+
* @description The Flake ID of the Checkout Line associated with the Trial
|
|
2346
|
+
* @example 411486491630370816
|
|
2347
|
+
*/
|
|
2348
|
+
checkout_line_id?: string;
|
|
2349
|
+
/**
|
|
2350
|
+
* Format: flake-id
|
|
2351
|
+
* @description The Flake ID of the Product associated with the Trial
|
|
2352
|
+
* @example 411486491630370816
|
|
2353
|
+
*/
|
|
2354
|
+
product_id?: string;
|
|
2355
|
+
/**
|
|
2356
|
+
* Format: flake-id
|
|
2357
|
+
* @description The Flake ID of the Product Version associated with the Trial
|
|
2358
|
+
* @example 411486491630370816
|
|
2359
|
+
*/
|
|
2360
|
+
product_version_id?: string;
|
|
2361
|
+
/**
|
|
2362
|
+
* @description The name of the Product associated with the Trial
|
|
2363
|
+
* @example Example Product
|
|
2364
|
+
*/
|
|
2365
|
+
product_name?: string;
|
|
2366
|
+
/**
|
|
2367
|
+
* @description The image URL of the Product associated with the Trial
|
|
2368
|
+
* @example https://example.com/image.jpg
|
|
2369
|
+
*/
|
|
2370
|
+
product_image_url?: string;
|
|
2371
|
+
/**
|
|
2372
|
+
* @description The period value of the Trial
|
|
2373
|
+
* @example 1
|
|
2374
|
+
*/
|
|
2375
|
+
period_value?: number;
|
|
2376
|
+
/**
|
|
2377
|
+
* @description The period scale of the Trial
|
|
2378
|
+
* @example month
|
|
2379
|
+
*/
|
|
2380
|
+
period_scale?: string;
|
|
2381
|
+
/**
|
|
2382
|
+
* Format: date-time
|
|
2383
|
+
* @description The start date of the Trial
|
|
2384
|
+
* @example 2024-06-10T00:00:00Z
|
|
2385
|
+
*/
|
|
2386
|
+
starts_at?: string;
|
|
2387
|
+
/**
|
|
2388
|
+
* Format: date-time
|
|
2389
|
+
* @description The end date of the Trial
|
|
2390
|
+
* @example 2024-06-17T23:59:59Z
|
|
2391
|
+
*/
|
|
2392
|
+
ends_at?: string;
|
|
2393
|
+
/**
|
|
2394
|
+
* @description The current status of the Trial. Possible options: created, active, canceled, completed
|
|
2395
|
+
* @example created
|
|
2396
|
+
*/
|
|
2397
|
+
status?: string;
|
|
2398
|
+
/**
|
|
2399
|
+
* Format: date-time
|
|
2400
|
+
* @description The date and time when the Trial was created
|
|
2401
|
+
* @example 2024-06-10T08:30:00Z
|
|
2402
|
+
*/
|
|
2403
|
+
created_at?: string;
|
|
2404
|
+
/**
|
|
2405
|
+
* Format: date-time
|
|
2406
|
+
* @description Indicates when the Trial was canceled
|
|
2407
|
+
* @example 2024-06-15T10:15:00Z
|
|
2408
|
+
*/
|
|
2409
|
+
canceled_at?: string;
|
|
2410
|
+
};
|
|
2411
|
+
};
|
|
2412
|
+
};
|
|
2413
|
+
};
|
|
2414
|
+
responses: {
|
|
2415
|
+
/** @description Webhook processed successfully */
|
|
2416
|
+
200: {
|
|
2417
|
+
headers: {
|
|
2418
|
+
[name: string]: unknown;
|
|
2419
|
+
};
|
|
2420
|
+
content?: never;
|
|
2421
|
+
};
|
|
2422
|
+
/** @description Bad request */
|
|
2423
|
+
400: {
|
|
2424
|
+
headers: {
|
|
2425
|
+
[name: string]: unknown;
|
|
2426
|
+
};
|
|
2427
|
+
content?: never;
|
|
2428
|
+
};
|
|
2429
|
+
/** @description Internal server error */
|
|
2430
|
+
500: {
|
|
2431
|
+
headers: {
|
|
2432
|
+
[name: string]: unknown;
|
|
2433
|
+
};
|
|
2434
|
+
content?: never;
|
|
2435
|
+
};
|
|
2436
|
+
};
|
|
2437
|
+
};
|
|
2438
|
+
delete?: never;
|
|
2439
|
+
options?: never;
|
|
2440
|
+
head?: never;
|
|
2441
|
+
patch?: never;
|
|
2442
|
+
trace?: never;
|
|
2443
|
+
};
|
|
2444
|
+
}
|
|
2445
|
+
export interface components {
|
|
2446
|
+
schemas: {
|
|
2447
|
+
CheckoutDTO: {
|
|
2448
|
+
/**
|
|
2449
|
+
* Format: flake-id
|
|
2450
|
+
* @description The Flake ID of the Checkout
|
|
2451
|
+
* @example 411486491630370816
|
|
2452
|
+
*/
|
|
2453
|
+
id?: string;
|
|
2454
|
+
/** @description Metadata associated with the checkout */
|
|
2455
|
+
metadata?: {
|
|
2456
|
+
[key: string]: string;
|
|
2457
|
+
};
|
|
2458
|
+
/** @description The lines of the Checkout */
|
|
2459
|
+
lines?: components["schemas"]["CheckoutLineDTO"][];
|
|
2460
|
+
};
|
|
2461
|
+
CheckoutLineDTO: {
|
|
2462
|
+
/**
|
|
2463
|
+
* Format: flake-id
|
|
2464
|
+
* @description The ID of the Checkout line
|
|
2465
|
+
* @example 411486491630370816
|
|
2466
|
+
*/
|
|
2467
|
+
id?: string;
|
|
2468
|
+
/**
|
|
2469
|
+
* Format: flake-id
|
|
2470
|
+
* @description The Product Flake ID of the Checkout Line
|
|
2471
|
+
* @example 411486491630370816
|
|
2472
|
+
*/
|
|
2473
|
+
product_id?: string;
|
|
2474
|
+
/**
|
|
2475
|
+
* Format: flake-id
|
|
2476
|
+
* @description The Product Version Flake ID of the Checkout Line
|
|
2477
|
+
* @example 411486491630370816
|
|
2478
|
+
*/
|
|
2479
|
+
product_version_id?: string;
|
|
2480
|
+
/** @description Metadata associated with the Checkout Line */
|
|
2481
|
+
metadata?: {
|
|
2482
|
+
[key: string]: string;
|
|
2483
|
+
};
|
|
2484
|
+
};
|
|
2485
|
+
CustomerDTO: {
|
|
2486
|
+
/**
|
|
2487
|
+
* Format: flake-id
|
|
2488
|
+
* @description The Flake ID of the Customer
|
|
2489
|
+
* @example 411486491630370816
|
|
2490
|
+
*/
|
|
2491
|
+
id?: string;
|
|
2492
|
+
/** @example John */
|
|
2493
|
+
name?: string;
|
|
2494
|
+
steam?: components["schemas"]["SteamCustomerDTO"];
|
|
2495
|
+
minecraft?: components["schemas"]["MinecraftCustomerDTO"];
|
|
2496
|
+
profile?: components["schemas"]["GenericProfileDTO"];
|
|
2497
|
+
};
|
|
2498
|
+
GameServerDTO: {
|
|
2499
|
+
/**
|
|
2500
|
+
* Format: flake-id
|
|
2501
|
+
* @description The Flake ID of the Game Server
|
|
2502
|
+
* @example 411486491630370816
|
|
2503
|
+
*/
|
|
2504
|
+
id?: string;
|
|
2505
|
+
/**
|
|
2506
|
+
* @description The name of the Game Server
|
|
2507
|
+
* @example John
|
|
2508
|
+
*/
|
|
2509
|
+
name?: string;
|
|
2510
|
+
/** @description Indicates if the Game Server is enabled */
|
|
2511
|
+
enabled?: boolean;
|
|
2512
|
+
};
|
|
2513
|
+
GenericProfileDTO: {
|
|
2514
|
+
id?: string;
|
|
2515
|
+
platform?: string;
|
|
2516
|
+
/** @example John */
|
|
2517
|
+
name?: string;
|
|
2518
|
+
avatar_url?: string;
|
|
2519
|
+
};
|
|
2520
|
+
MinecraftCustomerDTO: {
|
|
2521
|
+
id?: string;
|
|
2522
|
+
/** @example Notch */
|
|
2523
|
+
name?: string;
|
|
2524
|
+
avatar_url?: string;
|
|
2525
|
+
};
|
|
2526
|
+
OrderDTO: {
|
|
2527
|
+
/**
|
|
2528
|
+
* Format: flake-id
|
|
2529
|
+
* @description The Flake ID of the Order
|
|
2530
|
+
* @example 411486491630370816
|
|
2531
|
+
*/
|
|
2532
|
+
id?: string;
|
|
2533
|
+
/**
|
|
2534
|
+
* Format: flake-id
|
|
2535
|
+
* @description The Flake ID of the store associated with the order
|
|
2536
|
+
* @example 411486491630370816
|
|
2537
|
+
*/
|
|
2538
|
+
store_id?: string;
|
|
2539
|
+
customer?: components["schemas"]["CustomerDTO"];
|
|
2540
|
+
/**
|
|
2541
|
+
* Format: flake-id
|
|
2542
|
+
* @description The Flake ID of the Checkout associated with the order
|
|
2543
|
+
* @example 411486491630370816
|
|
2544
|
+
*/
|
|
2545
|
+
checkout_id?: string;
|
|
2546
|
+
checkout?: components["schemas"]["CheckoutDTO"];
|
|
2547
|
+
/**
|
|
2548
|
+
* Format: flake-id
|
|
2549
|
+
* @description The Flake ID of the Subscription associated with the order
|
|
2550
|
+
* @example 411486491630370816
|
|
2551
|
+
*/
|
|
2552
|
+
subscription_id?: string;
|
|
2553
|
+
/**
|
|
2554
|
+
* Format: flake-id
|
|
2555
|
+
* @description The Flake ID of the Coupon associated with the order
|
|
2556
|
+
* @example 411486491630370816
|
|
2557
|
+
*/
|
|
2558
|
+
coupon_id?: string;
|
|
2559
|
+
/**
|
|
2560
|
+
* @description The ISO-4217 Currency Code of the order
|
|
2561
|
+
* @example USD
|
|
2562
|
+
*/
|
|
2563
|
+
currency?: string;
|
|
2564
|
+
/**
|
|
2565
|
+
* @description Indicates if the order value was inclusive of tax
|
|
2566
|
+
* @example true
|
|
2567
|
+
*/
|
|
2568
|
+
tax_inclusive?: boolean;
|
|
2569
|
+
/**
|
|
2570
|
+
* @description The tax amount, represented as cents
|
|
2571
|
+
* @example 1500
|
|
2572
|
+
*/
|
|
2573
|
+
tax_amount?: number;
|
|
2574
|
+
/**
|
|
2575
|
+
* @description The discount amount, represented as cents
|
|
2576
|
+
* @example 500
|
|
2577
|
+
*/
|
|
2578
|
+
discount_amount?: number;
|
|
2579
|
+
/**
|
|
2580
|
+
* @description The subtotal amount, represented as cents
|
|
2581
|
+
* @example 10000
|
|
2582
|
+
*/
|
|
2583
|
+
subtotal_amount?: number;
|
|
2584
|
+
/**
|
|
2585
|
+
* @description The total amount, represented as cents
|
|
2586
|
+
* @example 11000
|
|
2587
|
+
*/
|
|
2588
|
+
total_amount?: number;
|
|
2589
|
+
/**
|
|
2590
|
+
* Format: date-time
|
|
2591
|
+
* @description Indicates when the order was created
|
|
2592
|
+
* @example 2024-01-15T10:30:00Z
|
|
2593
|
+
*/
|
|
2594
|
+
created_at?: string;
|
|
2595
|
+
/**
|
|
2596
|
+
* Format: date-time
|
|
2597
|
+
* @description Indicates when the order was completed
|
|
2598
|
+
* @example 2024-01-15T10:35:00Z
|
|
2599
|
+
*/
|
|
2600
|
+
completed_at?: string;
|
|
2601
|
+
/**
|
|
2602
|
+
* @description The billing name of the customer associated with the order
|
|
2603
|
+
* @example John Doe
|
|
2604
|
+
*/
|
|
2605
|
+
billing_name?: string;
|
|
2606
|
+
/**
|
|
2607
|
+
* @description The billing email address of the customer associated with the order
|
|
2608
|
+
* @example john@doe.com
|
|
2609
|
+
*/
|
|
2610
|
+
billing_email?: string;
|
|
2611
|
+
/**
|
|
2612
|
+
* @description The ISO-3316 Country Code of the customer associated with the order
|
|
2613
|
+
* @example US
|
|
2614
|
+
*/
|
|
2615
|
+
billing_address_country?: string;
|
|
2616
|
+
/**
|
|
2617
|
+
* @description The IPv4 or IPv6 Address of the associated customer when creating the order
|
|
2618
|
+
* @example 127.0.0.1/24
|
|
2619
|
+
*/
|
|
2620
|
+
customer_ip?: string;
|
|
2621
|
+
/**
|
|
2622
|
+
* @description The total amount of giftcard usage associated with the order, represented in cents
|
|
2623
|
+
* @example 0
|
|
2624
|
+
*/
|
|
2625
|
+
giftcard_usage_amount?: number;
|
|
2626
|
+
/** @description The order lines associated with the order */
|
|
2627
|
+
lines?: components["schemas"]["OrderLineDTO"][];
|
|
2628
|
+
/**
|
|
2629
|
+
* @description A comma-seperated string of the names of the product associated with the order
|
|
2630
|
+
* @example Product A, Product B
|
|
2631
|
+
*/
|
|
2632
|
+
product_names?: string;
|
|
2633
|
+
/**
|
|
2634
|
+
* @description A comma-seperated string of the tags of the products associated with the order
|
|
2635
|
+
* @example ranks, perks
|
|
2636
|
+
*/
|
|
2637
|
+
product_tags?: string;
|
|
2638
|
+
/**
|
|
2639
|
+
* @description A comma-seperated string of the gameservers of the product associated with the order
|
|
2640
|
+
* @example game server one, game server two
|
|
2641
|
+
*/
|
|
2642
|
+
product_gameservers?: string;
|
|
2643
|
+
/**
|
|
2644
|
+
* @description The status of the Order. Possbile options: created, completed, canceled
|
|
2645
|
+
* @example created
|
|
2646
|
+
*/
|
|
2647
|
+
status?: string;
|
|
2648
|
+
};
|
|
2649
|
+
OrderLineDTO: {
|
|
2650
|
+
/**
|
|
2651
|
+
* Format: flake-id
|
|
2652
|
+
* @description The Flake ID of the Order Line
|
|
2653
|
+
* @example 411486491630370816
|
|
2654
|
+
*/
|
|
2655
|
+
id?: string;
|
|
2656
|
+
/**
|
|
2657
|
+
* Format: flake-id
|
|
2658
|
+
* @description The Flake ID of the Checkout Line associated with this Order Line
|
|
2659
|
+
* @example 411486491630370816
|
|
2660
|
+
*/
|
|
2661
|
+
checkout_line_id?: string;
|
|
2662
|
+
/**
|
|
2663
|
+
* Format: flake-id
|
|
2664
|
+
* @description The Flake ID of the Product ID associated with this Order Line
|
|
2665
|
+
* @example 411486491630370816
|
|
2666
|
+
*/
|
|
2667
|
+
product_id?: string;
|
|
2668
|
+
/**
|
|
2669
|
+
* Format: flake-id
|
|
2670
|
+
* @description The Flake ID of the Product Version ID associated with this Order Line
|
|
2671
|
+
* @example 411486491630370816
|
|
2672
|
+
*/
|
|
2673
|
+
product_version_id?: string;
|
|
2674
|
+
product?: components["schemas"]["ProductDTO"];
|
|
2675
|
+
/** @description The name of the product associated with this Order Line */
|
|
2676
|
+
product_name?: string;
|
|
2677
|
+
/** @description The Image URL of the Product associated with this Order Line */
|
|
2678
|
+
product_image_url?: string;
|
|
2679
|
+
/**
|
|
2680
|
+
* Format: flake-id
|
|
2681
|
+
* @description The Flake ID of the Subscription associated with this Order Line
|
|
2682
|
+
* @example 411486491630370816
|
|
2683
|
+
*/
|
|
2684
|
+
subscription_id?: string;
|
|
2685
|
+
/**
|
|
2686
|
+
* @description The value of the interval in which the subscription associated with this Order Line renews at
|
|
2687
|
+
* @example 1
|
|
2688
|
+
*/
|
|
2689
|
+
subscription_interval_value?: number;
|
|
2690
|
+
/**
|
|
2691
|
+
* @description The value of the scale in which the subscription associated with this Order Line renews at
|
|
2692
|
+
* @example month
|
|
2693
|
+
*/
|
|
2694
|
+
subscription_interval_scale?: string;
|
|
2695
|
+
/**
|
|
2696
|
+
* Format: flake-id
|
|
2697
|
+
* @description The Flake ID of the Trial associated with this Order Line
|
|
2698
|
+
* @example 411486491630370816
|
|
2699
|
+
*/
|
|
2700
|
+
trial_id?: string;
|
|
2701
|
+
gift_to_customer?: components["schemas"]["CustomerDTO"];
|
|
2702
|
+
/**
|
|
2703
|
+
* @description The price of the Order Line
|
|
2704
|
+
* @example 1000
|
|
2705
|
+
*/
|
|
2706
|
+
price?: number;
|
|
2707
|
+
/**
|
|
2708
|
+
* @description The quantity of the Order Line
|
|
2709
|
+
* @example 1
|
|
2710
|
+
*/
|
|
2711
|
+
quantity?: number;
|
|
2712
|
+
/**
|
|
2713
|
+
* @description The discount amount of the order line, represented in cents
|
|
2714
|
+
* @example 0
|
|
2715
|
+
*/
|
|
2716
|
+
discount_amount?: number;
|
|
2717
|
+
/**
|
|
2718
|
+
* @description The subtotal amount of the order line, represented in cents
|
|
2719
|
+
* @example 1000
|
|
2720
|
+
*/
|
|
2721
|
+
subtotal_amount?: number;
|
|
2722
|
+
/**
|
|
2723
|
+
* @description The tax amount of the order line, represented in cents
|
|
2724
|
+
* @example 100
|
|
2725
|
+
*/
|
|
2726
|
+
tax_amount?: number;
|
|
2727
|
+
/**
|
|
2728
|
+
* @description The total amount of the order line, represented in cents
|
|
2729
|
+
* @example 1100
|
|
2730
|
+
*/
|
|
2731
|
+
total_amount?: number;
|
|
2732
|
+
/**
|
|
2733
|
+
* Format: flake-id
|
|
2734
|
+
* @description The Flake ID of which was the selected Game Server ID for the Order Line
|
|
2735
|
+
* @example 411486491630370816
|
|
2736
|
+
*/
|
|
2737
|
+
selected_gameserver_id?: string;
|
|
2738
|
+
};
|
|
2739
|
+
ProductCommandDTO: {
|
|
2740
|
+
/**
|
|
2741
|
+
* @description The stage of which the Product Command should be executed. Possible options: on_purchase, on_expire, on_refund, on_renew, on_chargeback, on_trial_start, on_trial_expire
|
|
2742
|
+
* @example on_purchase
|
|
2743
|
+
*/
|
|
2744
|
+
stage?: string;
|
|
2745
|
+
/** @description The command to execute */
|
|
2746
|
+
content?: string;
|
|
2747
|
+
/** @description Indicated if the command should be executed only when the customer is online */
|
|
2748
|
+
online_only?: boolean;
|
|
2749
|
+
};
|
|
2750
|
+
ProductDTO: {
|
|
2751
|
+
/**
|
|
2752
|
+
* Format: flake-id
|
|
2753
|
+
* @description The Flake ID of the Product
|
|
2754
|
+
* @example 411486491630370816
|
|
2755
|
+
*/
|
|
2756
|
+
id?: string;
|
|
2757
|
+
/**
|
|
2758
|
+
* Format: flake-id
|
|
2759
|
+
* @description The Flake ID of the Store
|
|
2760
|
+
* @example 411486491630370816
|
|
2761
|
+
*/
|
|
2762
|
+
store_id?: string;
|
|
2763
|
+
/**
|
|
2764
|
+
* Format: flake-id
|
|
2765
|
+
* @description The Flake ID of the Version of the Product
|
|
2766
|
+
* @example 411486491630370816
|
|
2767
|
+
*/
|
|
2768
|
+
version_id?: string;
|
|
2769
|
+
/** @description The Image URL of the product */
|
|
2770
|
+
image_url?: string;
|
|
2771
|
+
/** @description The URL-Friendly Slug of the Product */
|
|
2772
|
+
slug?: string;
|
|
2773
|
+
/** @description The name of the Product */
|
|
2774
|
+
name?: string;
|
|
2775
|
+
/** @description The description of the product */
|
|
2776
|
+
description?: string;
|
|
2777
|
+
/** @description Indicates if the product is enabled. */
|
|
2778
|
+
enabled?: boolean;
|
|
2779
|
+
/** @description The label of the product */
|
|
2780
|
+
label?: string;
|
|
2781
|
+
/** @description The sort order of the product */
|
|
2782
|
+
sort_order?: number;
|
|
2783
|
+
/** @description The price of the product, represented in cents. */
|
|
2784
|
+
price?: number;
|
|
2785
|
+
/** @description Indicates if the customer must select a single game server when purchasing the product */
|
|
2786
|
+
single_game_server_only?: boolean;
|
|
2787
|
+
/** @description Indicates if one-time purchases are supported on the product */
|
|
2788
|
+
allow_one_time_purchase?: boolean;
|
|
2789
|
+
/** @description Indicates if subscriptions are supported on the product */
|
|
2790
|
+
allow_subscription?: boolean;
|
|
2791
|
+
/**
|
|
2792
|
+
* @description The value of the interval in which the product subscription renews at
|
|
2793
|
+
* @example 1
|
|
2794
|
+
*/
|
|
2795
|
+
subscription_interval_value?: number;
|
|
2796
|
+
/**
|
|
2797
|
+
* @description The value of the interval in which the product subscription renews at
|
|
2798
|
+
* @example month
|
|
2799
|
+
*/
|
|
2800
|
+
subscription_interval_scale?: string;
|
|
2801
|
+
/** @description Indicates whether automatic removal is enabled */
|
|
2802
|
+
remove_after_enabled?: boolean;
|
|
2803
|
+
/**
|
|
2804
|
+
* @description The value of the time in which this product should be removed
|
|
2805
|
+
* @example 1
|
|
2806
|
+
*/
|
|
2807
|
+
remove_after_time_value?: number;
|
|
2808
|
+
/**
|
|
2809
|
+
* @description The scale of the time in which this product should be removed
|
|
2810
|
+
* @example month
|
|
2811
|
+
*/
|
|
2812
|
+
remove_after_time_scale?: string;
|
|
2813
|
+
/** @description The tags associated with the product */
|
|
2814
|
+
tags?: components["schemas"]["ProductTagDTO"][];
|
|
2815
|
+
/** @description A comma-seperated string of all the tags associated with the product */
|
|
2816
|
+
tag_names?: string;
|
|
2817
|
+
/** @description The game servers associated with the product */
|
|
2818
|
+
gameservers?: components["schemas"]["ProductGameServerDTO"][];
|
|
2819
|
+
/** @description A comma-seperated string of all the game servers associated with the product */
|
|
2820
|
+
gameserver_names?: string;
|
|
2821
|
+
/** @description The commands associated with the product */
|
|
2822
|
+
commands?: components["schemas"]["ProductCommandDTO"][];
|
|
2823
|
+
/**
|
|
2824
|
+
* Format: date-time
|
|
2825
|
+
* @description When the product was created
|
|
2826
|
+
*/
|
|
2827
|
+
created_at?: string;
|
|
2828
|
+
/**
|
|
2829
|
+
* Format: date-time
|
|
2830
|
+
* @description When the product was last updated
|
|
2831
|
+
*/
|
|
2832
|
+
updated_at?: string;
|
|
2833
|
+
/** @description The metadata of the product */
|
|
2834
|
+
metadata?: {
|
|
2835
|
+
[key: string]: string;
|
|
2836
|
+
};
|
|
2837
|
+
};
|
|
2838
|
+
ProductGameServerDTO: {
|
|
2839
|
+
/**
|
|
2840
|
+
* Format: flake-id
|
|
2841
|
+
* @description The ID of the Game Server
|
|
2842
|
+
* @example 411486491630370816
|
|
2843
|
+
*/
|
|
2844
|
+
id?: string;
|
|
2845
|
+
/** @description The name of the Game Server */
|
|
2846
|
+
name?: string;
|
|
2847
|
+
/** @description Indicates if the Game Server is enabled */
|
|
2848
|
+
enabled?: boolean;
|
|
2849
|
+
};
|
|
2850
|
+
ProductTagDTO: {
|
|
2851
|
+
/**
|
|
2852
|
+
* Format: flake-id
|
|
2853
|
+
* @description The Flake ID of the Product Tag
|
|
2854
|
+
* @example 411486491630370816
|
|
2855
|
+
*/
|
|
2856
|
+
id?: string;
|
|
2857
|
+
/** @description The URL-Friendly slug of the Product Tag */
|
|
2858
|
+
slug?: string;
|
|
2859
|
+
/** @description The name of the Product Tag */
|
|
2860
|
+
name?: string;
|
|
2861
|
+
};
|
|
2862
|
+
SteamCustomerDTO: {
|
|
2863
|
+
/**
|
|
2864
|
+
* @description SteamID64
|
|
2865
|
+
* @example 76561197960287930
|
|
2866
|
+
*/
|
|
2867
|
+
id?: string;
|
|
2868
|
+
/**
|
|
2869
|
+
* @description The name on the Steam Profile
|
|
2870
|
+
* @example John
|
|
2871
|
+
*/
|
|
2872
|
+
name?: string;
|
|
2873
|
+
/** @description The Steam Avatar URL */
|
|
2874
|
+
avatar_url?: string;
|
|
2875
|
+
};
|
|
2876
|
+
/**
|
|
2877
|
+
* @description The type of webhook event
|
|
2878
|
+
* @enum {string}
|
|
2879
|
+
*/
|
|
2880
|
+
WebhookEventType: "OnOrderCompleted" | "OnRefund" | "OnChargeback" | "OnDeliveryItemAdded" | "OnDeliveryItemActivated" | "OnDeliveryItemUsed" | "OnDeliveryItemRevoked" | "OnSubscriptionActivated" | "OnSubscriptionRenewed" | "OnSubscriptionCanceled" | "OnDiscordAccountLinkedToCheckout" | "OnConnectedUserRegistered" | "OnConnectedUserBecamePayable" | "OnConnectedUserPayoutCreated" | "OnConnectedUserPayoutCompleted" | "OnConnectedUserTransactionInserted" | "OnConnectedUserBecameUnpayable" | "OnTrialActivated" | "OnTrialCompleted" | "OnTrialCanceled" | "OnPurchaseFollowUpAttemptEmailSent" | "OnPurchaseFollowUpAttemptSucceeded" | "OnAbandonedCheckoutRecoveryAttemptEmailSent" | "OnAbandonedCheckoutRecoveryAttemptSucceeded";
|
|
2881
|
+
};
|
|
2882
|
+
responses: never;
|
|
2883
|
+
parameters: never;
|
|
2884
|
+
requestBodies: never;
|
|
2885
|
+
headers: never;
|
|
2886
|
+
pathItems: never;
|
|
2887
|
+
}
|
|
2888
|
+
export type $defs = Record<string, never>;
|
|
2889
|
+
export type operations = Record<string, never>;
|
|
2890
|
+
export declare const operationMappings: {};
|
|
2891
|
+
//# sourceMappingURL=webhooks.d.ts.map
|