@paynow-gg/typescript-sdk 1.0.26 → 1.0.28

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