@paynow-gg/typescript-sdk 1.0.30 → 1.0.32
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.
|
@@ -33,130 +33,130 @@ export interface webhooks {
|
|
|
33
33
|
* @description The ID of the Webhook Event
|
|
34
34
|
* @example 411486491630370816
|
|
35
35
|
*/
|
|
36
|
-
event_id
|
|
36
|
+
event_id: string;
|
|
37
37
|
body: {
|
|
38
38
|
/**
|
|
39
39
|
* Format: flake-id
|
|
40
40
|
* @description The Flake ID of the Subscription
|
|
41
41
|
* @example 411486491630370816
|
|
42
42
|
*/
|
|
43
|
-
id
|
|
43
|
+
id: string;
|
|
44
44
|
/**
|
|
45
45
|
* Format: flake-id
|
|
46
46
|
* @description The Flake ID of the Store associated with the Subscription
|
|
47
47
|
* @example 411486491630370816
|
|
48
48
|
*/
|
|
49
|
-
store_id
|
|
49
|
+
store_id: string;
|
|
50
50
|
/**
|
|
51
51
|
* Format: flake-id
|
|
52
52
|
* @description The Flake ID of the Customer associated with the Subscription
|
|
53
53
|
* @example 411486491630370816
|
|
54
54
|
*/
|
|
55
|
-
customer_id
|
|
56
|
-
customer
|
|
55
|
+
customer_id: string;
|
|
56
|
+
customer: components["schemas"]["CustomerDTO"];
|
|
57
57
|
/**
|
|
58
58
|
* @description The current billing cycle number
|
|
59
59
|
* @example 2
|
|
60
60
|
*/
|
|
61
|
-
billing_cycle_sequence
|
|
61
|
+
billing_cycle_sequence: number;
|
|
62
62
|
/**
|
|
63
63
|
* @description The billing email address of the customer associated with the Subscription
|
|
64
64
|
* @example john@doe.com
|
|
65
65
|
*/
|
|
66
|
-
billing_email
|
|
66
|
+
billing_email: string;
|
|
67
67
|
/**
|
|
68
68
|
* @description The subtotal amount of the Subscription represented in cents
|
|
69
69
|
* @example 8999
|
|
70
70
|
*/
|
|
71
|
-
subtotal_amount
|
|
71
|
+
subtotal_amount: number;
|
|
72
72
|
/**
|
|
73
73
|
* @description The tax amount of the Subscription represented in cents
|
|
74
74
|
* @example 1350
|
|
75
75
|
*/
|
|
76
|
-
tax_amount
|
|
76
|
+
tax_amount: number;
|
|
77
77
|
/**
|
|
78
78
|
* @description The discount amount applied to the Subscription represented in cents
|
|
79
79
|
* @example 0
|
|
80
80
|
*/
|
|
81
|
-
discount_amount
|
|
81
|
+
discount_amount: number;
|
|
82
82
|
/**
|
|
83
83
|
* @description The total amount of the Subscription represented in cents
|
|
84
84
|
* @example 10349
|
|
85
85
|
*/
|
|
86
|
-
total_amount
|
|
86
|
+
total_amount: number;
|
|
87
87
|
/**
|
|
88
88
|
* @description The currency code of the Subscription
|
|
89
89
|
* @example USD
|
|
90
90
|
*/
|
|
91
|
-
currency
|
|
91
|
+
currency: string;
|
|
92
92
|
/**
|
|
93
93
|
* @description The interval value of the billing cycle
|
|
94
94
|
* @example 1
|
|
95
95
|
*/
|
|
96
|
-
interval_value
|
|
96
|
+
interval_value: number;
|
|
97
97
|
/**
|
|
98
98
|
* @description The interval scale of the billing cycle
|
|
99
99
|
* @example month
|
|
100
100
|
*/
|
|
101
|
-
interval_scale
|
|
101
|
+
interval_scale: string;
|
|
102
102
|
/**
|
|
103
103
|
* Format: flake-id
|
|
104
104
|
* @description The Flake ID of the Product associated with the Subscription
|
|
105
105
|
* @example 411486491630370816
|
|
106
106
|
*/
|
|
107
|
-
product_id
|
|
107
|
+
product_id: string;
|
|
108
108
|
/**
|
|
109
109
|
* Format: flake-id
|
|
110
110
|
* @description The Flake ID of the Product Version associated with the Subscription
|
|
111
111
|
* @example 411486491630370816
|
|
112
112
|
*/
|
|
113
|
-
product_version_id
|
|
113
|
+
product_version_id: string;
|
|
114
114
|
/**
|
|
115
115
|
* @description The name of the Product associated with the Subscription
|
|
116
116
|
* @example Example Product
|
|
117
117
|
*/
|
|
118
|
-
product_name
|
|
118
|
+
product_name: string;
|
|
119
119
|
/**
|
|
120
120
|
* @description The image URL of the Product associated with the Subscription
|
|
121
121
|
* @example https://example.com/biz.jpg
|
|
122
122
|
*/
|
|
123
123
|
product_image_url?: null | string;
|
|
124
|
-
product
|
|
124
|
+
product: components["schemas"]["ProductDTO"];
|
|
125
125
|
/**
|
|
126
126
|
* @description The ISO-3166 country code of customer associated with the Subscription
|
|
127
127
|
* @example US
|
|
128
128
|
*/
|
|
129
|
-
billing_country
|
|
129
|
+
billing_country: string;
|
|
130
130
|
/**
|
|
131
131
|
* @description The initial subtotal amount of the Subscription represented in cents
|
|
132
132
|
* @example 8999
|
|
133
133
|
*/
|
|
134
|
-
initial_subtotal_amount
|
|
134
|
+
initial_subtotal_amount: number;
|
|
135
135
|
/**
|
|
136
136
|
* @description The initial tax amount of the Subscription represented in cents
|
|
137
137
|
* @example 1350
|
|
138
138
|
*/
|
|
139
|
-
initial_tax_amount
|
|
139
|
+
initial_tax_amount: number;
|
|
140
140
|
/**
|
|
141
141
|
* @description The initial discount amount applied to the Subscription represented in cents
|
|
142
142
|
* @example 1500
|
|
143
143
|
*/
|
|
144
|
-
initial_discount_amount
|
|
144
|
+
initial_discount_amount: number;
|
|
145
145
|
/**
|
|
146
146
|
* @description The initial gift card usage amount applied to the Subscription represented in cents
|
|
147
147
|
* @example 0
|
|
148
148
|
*/
|
|
149
|
-
initial_giftcard_usage_amount
|
|
149
|
+
initial_giftcard_usage_amount: number;
|
|
150
150
|
/**
|
|
151
151
|
* @description The initial total amount of the Subscription represented in cents
|
|
152
152
|
* @example 8849
|
|
153
153
|
*/
|
|
154
|
-
initial_total_amount
|
|
154
|
+
initial_total_amount: number;
|
|
155
155
|
/**
|
|
156
156
|
* @description The IP address of the Customer
|
|
157
157
|
* @example 127.0.0.1/24
|
|
158
158
|
*/
|
|
159
|
-
customer_ip
|
|
159
|
+
customer_ip: string;
|
|
160
160
|
/**
|
|
161
161
|
* Format: date-time
|
|
162
162
|
* @description The start date of the current billing period
|
|
@@ -186,18 +186,18 @@ export interface webhooks {
|
|
|
186
186
|
* @description The Flake ID of the Checkout associated with the Subscription
|
|
187
187
|
* @example 411486491630370816
|
|
188
188
|
*/
|
|
189
|
-
checkout_id
|
|
189
|
+
checkout_id: string;
|
|
190
190
|
/**
|
|
191
191
|
* Format: flake-id
|
|
192
192
|
* @description The Flake ID of the Checkout Line associated with the Subscription
|
|
193
193
|
* @example 411486491630370816
|
|
194
194
|
*/
|
|
195
|
-
checkout_line_id
|
|
195
|
+
checkout_line_id: string;
|
|
196
196
|
/**
|
|
197
197
|
* @description The current status of the Subscription. Possible options: created, active, canceled
|
|
198
198
|
* @example created
|
|
199
199
|
*/
|
|
200
|
-
status
|
|
200
|
+
status: string;
|
|
201
201
|
};
|
|
202
202
|
};
|
|
203
203
|
};
|
|
@@ -265,68 +265,68 @@ export interface webhooks {
|
|
|
265
265
|
* @description The ID of the Webhook Event
|
|
266
266
|
* @example 411486491630370816
|
|
267
267
|
*/
|
|
268
|
-
event_id
|
|
268
|
+
event_id: string;
|
|
269
269
|
body: {
|
|
270
270
|
/**
|
|
271
271
|
* Format: flake-id
|
|
272
272
|
* @description The Flake ID of the Store associated with the Checkout
|
|
273
273
|
* @example 411486491630370816
|
|
274
274
|
*/
|
|
275
|
-
store_id
|
|
275
|
+
store_id: string;
|
|
276
276
|
/**
|
|
277
277
|
* Format: flake-id
|
|
278
278
|
* @description The Flake ID of the Customer associated with the Checkout
|
|
279
279
|
* @example 411486491630370816
|
|
280
280
|
*/
|
|
281
|
-
customer_id
|
|
282
|
-
customer
|
|
281
|
+
customer_id: string;
|
|
282
|
+
customer: components["schemas"]["CustomerDTO"];
|
|
283
283
|
/**
|
|
284
284
|
* Format: flake-id
|
|
285
285
|
* @description The Flake ID of the Checkout
|
|
286
286
|
* @example 411486491630370816
|
|
287
287
|
*/
|
|
288
|
-
checkout_id
|
|
288
|
+
checkout_id: string;
|
|
289
289
|
/**
|
|
290
290
|
* Format: flake-id
|
|
291
291
|
* @description The Flake ID of the Checkout Line
|
|
292
292
|
* @example 411486491630370816
|
|
293
293
|
*/
|
|
294
|
-
checkout_line_id
|
|
294
|
+
checkout_line_id: string;
|
|
295
295
|
/**
|
|
296
296
|
* Format: flake-id
|
|
297
297
|
* @description The Flake ID of the Order associated with the Checkout
|
|
298
298
|
* @example 411486491630370816
|
|
299
299
|
*/
|
|
300
|
-
order_id
|
|
301
|
-
order
|
|
300
|
+
order_id: string;
|
|
301
|
+
order: components["schemas"]["OrderDTO"];
|
|
302
302
|
/**
|
|
303
303
|
* @description The Discord User ID of the linked account
|
|
304
304
|
* @example 123456789012345678
|
|
305
305
|
*/
|
|
306
|
-
discord_user_id
|
|
306
|
+
discord_user_id: string;
|
|
307
307
|
/**
|
|
308
308
|
* @description The Discord username of the linked account
|
|
309
309
|
* @example john_doe
|
|
310
310
|
*/
|
|
311
|
-
discord_user_name
|
|
311
|
+
discord_user_name: string;
|
|
312
312
|
/**
|
|
313
313
|
* @description The Discord avatar hash of the linked account
|
|
314
314
|
* @example a1b2c3d4e5f6g7h8i9j0
|
|
315
315
|
*/
|
|
316
|
-
discord_user_avatar_hash
|
|
316
|
+
discord_user_avatar_hash: string;
|
|
317
317
|
/**
|
|
318
318
|
* Format: flake-id
|
|
319
319
|
* @description The Flake ID of the Product associated with the Checkout
|
|
320
320
|
* @example 411486491630370816
|
|
321
321
|
*/
|
|
322
|
-
product_id
|
|
322
|
+
product_id: string;
|
|
323
323
|
/**
|
|
324
324
|
* Format: flake-id
|
|
325
325
|
* @description The Flake ID of the Product Version associated with the Checkout
|
|
326
326
|
* @example 411486491630370816
|
|
327
327
|
*/
|
|
328
|
-
product_version_id
|
|
329
|
-
product
|
|
328
|
+
product_version_id: string;
|
|
329
|
+
product: components["schemas"]["ProductDTO"];
|
|
330
330
|
/**
|
|
331
331
|
* Format: date-time
|
|
332
332
|
* @description Indicates when the Discord account link was enqueued
|
|
@@ -400,20 +400,20 @@ export interface webhooks {
|
|
|
400
400
|
* @description The ID of the Webhook Event
|
|
401
401
|
* @example 411486491630370816
|
|
402
402
|
*/
|
|
403
|
-
event_id
|
|
403
|
+
event_id: string;
|
|
404
404
|
body: {
|
|
405
405
|
/**
|
|
406
406
|
* Format: flake-id
|
|
407
407
|
* @description The Flake ID of the Delivery Item
|
|
408
408
|
* @example 411486491630370816
|
|
409
409
|
*/
|
|
410
|
-
id
|
|
410
|
+
id: string;
|
|
411
411
|
/**
|
|
412
412
|
* Format: flake-id
|
|
413
413
|
* @description The Flake ID of the Store associated with the Delivery Item
|
|
414
414
|
* @example 411486491630370816
|
|
415
415
|
*/
|
|
416
|
-
store_id
|
|
416
|
+
store_id: string;
|
|
417
417
|
customer?: components["schemas"]["CustomerDTO"] | null;
|
|
418
418
|
/**
|
|
419
419
|
* Format: flake-id
|
|
@@ -457,25 +457,25 @@ export interface webhooks {
|
|
|
457
457
|
* @description The associated Product ID of the Delivery Item
|
|
458
458
|
* @example 411486491630370816
|
|
459
459
|
*/
|
|
460
|
-
product_id
|
|
460
|
+
product_id: string;
|
|
461
461
|
/**
|
|
462
462
|
* Format: flake-id
|
|
463
463
|
* @description The associated Product Version ID of the Delivery Item
|
|
464
464
|
* @example 411486491630370816
|
|
465
465
|
*/
|
|
466
|
-
product_version_id
|
|
467
|
-
product
|
|
466
|
+
product_version_id: string;
|
|
467
|
+
product: components["schemas"]["ProductDTO"];
|
|
468
468
|
/**
|
|
469
469
|
* @description The state of the Delivery Item. Possible options: usable, active, used, revoked, renewed
|
|
470
470
|
* @example usable
|
|
471
471
|
*/
|
|
472
|
-
state
|
|
472
|
+
state: string;
|
|
473
473
|
/**
|
|
474
474
|
* Format: date-time
|
|
475
475
|
* @description Indicates when the Delivery Item was added to the customers inventory
|
|
476
476
|
* @example 2024-01-10T08:00:00Z
|
|
477
477
|
*/
|
|
478
|
-
added_at
|
|
478
|
+
added_at: string;
|
|
479
479
|
/**
|
|
480
480
|
* Format: date-time
|
|
481
481
|
* @description Indicates when the Delivery Item become active
|
|
@@ -569,20 +569,20 @@ export interface webhooks {
|
|
|
569
569
|
* @description The ID of the Webhook Event
|
|
570
570
|
* @example 411486491630370816
|
|
571
571
|
*/
|
|
572
|
-
event_id
|
|
572
|
+
event_id: string;
|
|
573
573
|
body: {
|
|
574
574
|
/**
|
|
575
575
|
* Format: flake-id
|
|
576
576
|
* @description The Flake ID of the Delivery Item
|
|
577
577
|
* @example 411486491630370816
|
|
578
578
|
*/
|
|
579
|
-
id
|
|
579
|
+
id: string;
|
|
580
580
|
/**
|
|
581
581
|
* Format: flake-id
|
|
582
582
|
* @description The Flake ID of the Store associated with the Delivery Item
|
|
583
583
|
* @example 411486491630370816
|
|
584
584
|
*/
|
|
585
|
-
store_id
|
|
585
|
+
store_id: string;
|
|
586
586
|
customer?: components["schemas"]["CustomerDTO"] | null;
|
|
587
587
|
/**
|
|
588
588
|
* Format: flake-id
|
|
@@ -626,25 +626,25 @@ export interface webhooks {
|
|
|
626
626
|
* @description The associated Product ID of the Delivery Item
|
|
627
627
|
* @example 411486491630370816
|
|
628
628
|
*/
|
|
629
|
-
product_id
|
|
629
|
+
product_id: string;
|
|
630
630
|
/**
|
|
631
631
|
* Format: flake-id
|
|
632
632
|
* @description The associated Product Version ID of the Delivery Item
|
|
633
633
|
* @example 411486491630370816
|
|
634
634
|
*/
|
|
635
|
-
product_version_id
|
|
636
|
-
product
|
|
635
|
+
product_version_id: string;
|
|
636
|
+
product: components["schemas"]["ProductDTO"];
|
|
637
637
|
/**
|
|
638
638
|
* @description The state of the Delivery Item. Possible options: usable, active, used, revoked, renewed
|
|
639
639
|
* @example usable
|
|
640
640
|
*/
|
|
641
|
-
state
|
|
641
|
+
state: string;
|
|
642
642
|
/**
|
|
643
643
|
* Format: date-time
|
|
644
644
|
* @description Indicates when the Delivery Item was added to the customers inventory
|
|
645
645
|
* @example 2024-01-10T08:00:00Z
|
|
646
646
|
*/
|
|
647
|
-
added_at
|
|
647
|
+
added_at: string;
|
|
648
648
|
/**
|
|
649
649
|
* Format: date-time
|
|
650
650
|
* @description Indicates when the Delivery Item become active
|
|
@@ -738,20 +738,20 @@ export interface webhooks {
|
|
|
738
738
|
* @description The ID of the Webhook Event
|
|
739
739
|
* @example 411486491630370816
|
|
740
740
|
*/
|
|
741
|
-
event_id
|
|
741
|
+
event_id: string;
|
|
742
742
|
body: {
|
|
743
743
|
/**
|
|
744
744
|
* Format: flake-id
|
|
745
745
|
* @description The Flake ID of the Delivery Item
|
|
746
746
|
* @example 411486491630370816
|
|
747
747
|
*/
|
|
748
|
-
id
|
|
748
|
+
id: string;
|
|
749
749
|
/**
|
|
750
750
|
* Format: flake-id
|
|
751
751
|
* @description The Flake ID of the Store associated with the Delivery Item
|
|
752
752
|
* @example 411486491630370816
|
|
753
753
|
*/
|
|
754
|
-
store_id
|
|
754
|
+
store_id: string;
|
|
755
755
|
customer?: components["schemas"]["CustomerDTO"] | null;
|
|
756
756
|
/**
|
|
757
757
|
* Format: flake-id
|
|
@@ -795,25 +795,25 @@ export interface webhooks {
|
|
|
795
795
|
* @description The associated Product ID of the Delivery Item
|
|
796
796
|
* @example 411486491630370816
|
|
797
797
|
*/
|
|
798
|
-
product_id
|
|
798
|
+
product_id: string;
|
|
799
799
|
/**
|
|
800
800
|
* Format: flake-id
|
|
801
801
|
* @description The associated Product Version ID of the Delivery Item
|
|
802
802
|
* @example 411486491630370816
|
|
803
803
|
*/
|
|
804
|
-
product_version_id
|
|
805
|
-
product
|
|
804
|
+
product_version_id: string;
|
|
805
|
+
product: components["schemas"]["ProductDTO"];
|
|
806
806
|
/**
|
|
807
807
|
* @description The state of the Delivery Item. Possible options: usable, active, used, revoked, renewed
|
|
808
808
|
* @example usable
|
|
809
809
|
*/
|
|
810
|
-
state
|
|
810
|
+
state: string;
|
|
811
811
|
/**
|
|
812
812
|
* Format: date-time
|
|
813
813
|
* @description Indicates when the Delivery Item was added to the customers inventory
|
|
814
814
|
* @example 2024-01-10T08:00:00Z
|
|
815
815
|
*/
|
|
816
|
-
added_at
|
|
816
|
+
added_at: string;
|
|
817
817
|
/**
|
|
818
818
|
* Format: date-time
|
|
819
819
|
* @description Indicates when the Delivery Item become active
|
|
@@ -907,20 +907,20 @@ export interface webhooks {
|
|
|
907
907
|
* @description The ID of the Webhook Event
|
|
908
908
|
* @example 411486491630370816
|
|
909
909
|
*/
|
|
910
|
-
event_id
|
|
910
|
+
event_id: string;
|
|
911
911
|
body: {
|
|
912
912
|
/**
|
|
913
913
|
* Format: flake-id
|
|
914
914
|
* @description The Flake ID of the Delivery Item
|
|
915
915
|
* @example 411486491630370816
|
|
916
916
|
*/
|
|
917
|
-
id
|
|
917
|
+
id: string;
|
|
918
918
|
/**
|
|
919
919
|
* Format: flake-id
|
|
920
920
|
* @description The Flake ID of the Store associated with the Delivery Item
|
|
921
921
|
* @example 411486491630370816
|
|
922
922
|
*/
|
|
923
|
-
store_id
|
|
923
|
+
store_id: string;
|
|
924
924
|
customer?: components["schemas"]["CustomerDTO"] | null;
|
|
925
925
|
/**
|
|
926
926
|
* Format: flake-id
|
|
@@ -964,25 +964,25 @@ export interface webhooks {
|
|
|
964
964
|
* @description The associated Product ID of the Delivery Item
|
|
965
965
|
* @example 411486491630370816
|
|
966
966
|
*/
|
|
967
|
-
product_id
|
|
967
|
+
product_id: string;
|
|
968
968
|
/**
|
|
969
969
|
* Format: flake-id
|
|
970
970
|
* @description The associated Product Version ID of the Delivery Item
|
|
971
971
|
* @example 411486491630370816
|
|
972
972
|
*/
|
|
973
|
-
product_version_id
|
|
974
|
-
product
|
|
973
|
+
product_version_id: string;
|
|
974
|
+
product: components["schemas"]["ProductDTO"];
|
|
975
975
|
/**
|
|
976
976
|
* @description The state of the Delivery Item. Possible options: usable, active, used, revoked, renewed
|
|
977
977
|
* @example usable
|
|
978
978
|
*/
|
|
979
|
-
state
|
|
979
|
+
state: string;
|
|
980
980
|
/**
|
|
981
981
|
* Format: date-time
|
|
982
982
|
* @description Indicates when the Delivery Item was added to the customers inventory
|
|
983
983
|
* @example 2024-01-10T08:00:00Z
|
|
984
984
|
*/
|
|
985
|
-
added_at
|
|
985
|
+
added_at: string;
|
|
986
986
|
/**
|
|
987
987
|
* Format: date-time
|
|
988
988
|
* @description Indicates when the Delivery Item become active
|
|
@@ -1076,28 +1076,28 @@ export interface webhooks {
|
|
|
1076
1076
|
* @description The ID of the Webhook Event
|
|
1077
1077
|
* @example 411486491630370816
|
|
1078
1078
|
*/
|
|
1079
|
-
event_id
|
|
1079
|
+
event_id: string;
|
|
1080
1080
|
body: {
|
|
1081
1081
|
/**
|
|
1082
1082
|
* Format: flake-id
|
|
1083
1083
|
* @description The Flake ID of the Order
|
|
1084
1084
|
* @example 411486491630370816
|
|
1085
1085
|
*/
|
|
1086
|
-
id
|
|
1086
|
+
id: string;
|
|
1087
1087
|
/**
|
|
1088
1088
|
* Format: flake-id
|
|
1089
1089
|
* @description The Flake ID of the store associated with the order
|
|
1090
1090
|
* @example 411486491630370816
|
|
1091
1091
|
*/
|
|
1092
|
-
store_id
|
|
1093
|
-
customer
|
|
1092
|
+
store_id: string;
|
|
1093
|
+
customer: components["schemas"]["CustomerDTO"];
|
|
1094
1094
|
/**
|
|
1095
1095
|
* Format: flake-id
|
|
1096
1096
|
* @description The Flake ID of the Checkout associated with the order
|
|
1097
1097
|
* @example 411486491630370816
|
|
1098
1098
|
*/
|
|
1099
|
-
checkout_id
|
|
1100
|
-
checkout
|
|
1099
|
+
checkout_id: string;
|
|
1100
|
+
checkout: components["schemas"]["CheckoutDTO"];
|
|
1101
1101
|
/**
|
|
1102
1102
|
* Format: flake-id
|
|
1103
1103
|
* @description The Flake ID of the Subscription associated with the order
|
|
@@ -1114,91 +1114,91 @@ export interface webhooks {
|
|
|
1114
1114
|
* @description The ISO-4217 Currency Code of the order
|
|
1115
1115
|
* @example USD
|
|
1116
1116
|
*/
|
|
1117
|
-
currency
|
|
1117
|
+
currency: string;
|
|
1118
1118
|
/**
|
|
1119
1119
|
* @description Indicates if the order value was inclusive of tax
|
|
1120
1120
|
* @example true
|
|
1121
1121
|
*/
|
|
1122
|
-
tax_inclusive
|
|
1122
|
+
tax_inclusive: boolean;
|
|
1123
1123
|
/**
|
|
1124
1124
|
* @description The tax amount, represented as cents
|
|
1125
1125
|
* @example 1500
|
|
1126
1126
|
*/
|
|
1127
|
-
tax_amount
|
|
1127
|
+
tax_amount: number;
|
|
1128
1128
|
/**
|
|
1129
1129
|
* @description The discount amount, represented as cents
|
|
1130
1130
|
* @example 500
|
|
1131
1131
|
*/
|
|
1132
|
-
discount_amount
|
|
1132
|
+
discount_amount: number;
|
|
1133
1133
|
/**
|
|
1134
1134
|
* @description The subtotal amount, represented as cents
|
|
1135
1135
|
* @example 10000
|
|
1136
1136
|
*/
|
|
1137
|
-
subtotal_amount
|
|
1137
|
+
subtotal_amount: number;
|
|
1138
1138
|
/**
|
|
1139
1139
|
* @description The total amount, represented as cents
|
|
1140
1140
|
* @example 11000
|
|
1141
1141
|
*/
|
|
1142
|
-
total_amount
|
|
1142
|
+
total_amount: number;
|
|
1143
1143
|
/**
|
|
1144
1144
|
* Format: date-time
|
|
1145
1145
|
* @description Indicates when the order was created
|
|
1146
1146
|
* @example 2024-01-15T10:30:00Z
|
|
1147
1147
|
*/
|
|
1148
|
-
created_at
|
|
1148
|
+
created_at: string;
|
|
1149
1149
|
/**
|
|
1150
1150
|
* Format: date-time
|
|
1151
1151
|
* @description Indicates when the order was completed
|
|
1152
1152
|
* @example 2024-01-15T10:35:00Z
|
|
1153
1153
|
*/
|
|
1154
|
-
completed_at
|
|
1154
|
+
completed_at: string;
|
|
1155
1155
|
/**
|
|
1156
1156
|
* @description The billing name of the customer associated with the order
|
|
1157
1157
|
* @example John Doe
|
|
1158
1158
|
*/
|
|
1159
|
-
billing_name
|
|
1159
|
+
billing_name: string;
|
|
1160
1160
|
/**
|
|
1161
1161
|
* @description The billing email address of the customer associated with the order
|
|
1162
1162
|
* @example john@doe.com
|
|
1163
1163
|
*/
|
|
1164
|
-
billing_email
|
|
1164
|
+
billing_email: string;
|
|
1165
1165
|
/**
|
|
1166
1166
|
* @description The ISO-3316 Country Code of the customer associated with the order
|
|
1167
1167
|
* @example US
|
|
1168
1168
|
*/
|
|
1169
|
-
billing_address_country
|
|
1169
|
+
billing_address_country: string;
|
|
1170
1170
|
/**
|
|
1171
1171
|
* @description The IPv4 or IPv6 Address of the associated customer when creating the order
|
|
1172
1172
|
* @example 127.0.0.1/24
|
|
1173
1173
|
*/
|
|
1174
|
-
customer_ip
|
|
1174
|
+
customer_ip: string;
|
|
1175
1175
|
/**
|
|
1176
1176
|
* @description The total amount of giftcard usage associated with the order, represented in cents
|
|
1177
1177
|
* @example 0
|
|
1178
1178
|
*/
|
|
1179
|
-
giftcard_usage_amount
|
|
1179
|
+
giftcard_usage_amount: number;
|
|
1180
1180
|
/** @description The order lines associated with the order */
|
|
1181
|
-
lines
|
|
1181
|
+
lines: components["schemas"]["OrderLineDTO"][];
|
|
1182
1182
|
/**
|
|
1183
1183
|
* @description A comma-seperated string of the names of the product associated with the order
|
|
1184
1184
|
* @example Product A, Product B
|
|
1185
1185
|
*/
|
|
1186
|
-
product_names
|
|
1186
|
+
product_names: string;
|
|
1187
1187
|
/**
|
|
1188
1188
|
* @description A comma-seperated string of the tags of the products associated with the order
|
|
1189
1189
|
* @example ranks, perks
|
|
1190
1190
|
*/
|
|
1191
|
-
product_tags
|
|
1191
|
+
product_tags: string;
|
|
1192
1192
|
/**
|
|
1193
1193
|
* @description A comma-seperated string of the gameservers of the product associated with the order
|
|
1194
1194
|
* @example game server one, game server two
|
|
1195
1195
|
*/
|
|
1196
|
-
product_gameservers
|
|
1196
|
+
product_gameservers: string;
|
|
1197
1197
|
/**
|
|
1198
1198
|
* @description The status of the Order. Possbile options: created, completed, canceled
|
|
1199
1199
|
* @example created
|
|
1200
1200
|
*/
|
|
1201
|
-
status
|
|
1201
|
+
status: string;
|
|
1202
1202
|
};
|
|
1203
1203
|
};
|
|
1204
1204
|
};
|
|
@@ -1266,75 +1266,75 @@ export interface webhooks {
|
|
|
1266
1266
|
* @description The ID of the Webhook Event
|
|
1267
1267
|
* @example 411486491630370816
|
|
1268
1268
|
*/
|
|
1269
|
-
event_id
|
|
1269
|
+
event_id: string;
|
|
1270
1270
|
body: {
|
|
1271
1271
|
/**
|
|
1272
1272
|
* Format: flake-id
|
|
1273
1273
|
* @description The Flake ID of the Payment associated with the Payment
|
|
1274
1274
|
* @example 411486491630370816
|
|
1275
1275
|
*/
|
|
1276
|
-
id
|
|
1276
|
+
id: string;
|
|
1277
1277
|
/**
|
|
1278
1278
|
* Format: flake-id
|
|
1279
1279
|
* @description The Flake ID of the Store associated with the Payment
|
|
1280
1280
|
* @example 411486491630370816
|
|
1281
1281
|
*/
|
|
1282
|
-
store_id
|
|
1282
|
+
store_id: string;
|
|
1283
1283
|
/**
|
|
1284
1284
|
* Format: flake-id
|
|
1285
1285
|
* @description The Flake ID of the Order associated with Payment
|
|
1286
1286
|
* @example 411486491630370816
|
|
1287
1287
|
*/
|
|
1288
|
-
order_id
|
|
1288
|
+
order_id: string;
|
|
1289
1289
|
customer?: components["schemas"]["CustomerDTO"] | null;
|
|
1290
1290
|
/**
|
|
1291
1291
|
* @description The Payment Gateway of the Payment
|
|
1292
1292
|
* @example stripe
|
|
1293
1293
|
*/
|
|
1294
|
-
gateway
|
|
1294
|
+
gateway: string;
|
|
1295
1295
|
/**
|
|
1296
1296
|
* @description The ISO-4217 Currency Code of the Payment
|
|
1297
1297
|
* @example USD
|
|
1298
1298
|
*/
|
|
1299
|
-
currency
|
|
1299
|
+
currency: string;
|
|
1300
1300
|
/**
|
|
1301
1301
|
* @description Indicates if the payment was Tax Inclusive
|
|
1302
1302
|
* @example true
|
|
1303
1303
|
*/
|
|
1304
|
-
tax_inclusive
|
|
1304
|
+
tax_inclusive: boolean;
|
|
1305
1305
|
/**
|
|
1306
1306
|
* @description The payment amount, represented in cents
|
|
1307
1307
|
* @example 7500
|
|
1308
1308
|
*/
|
|
1309
|
-
amount
|
|
1309
|
+
amount: number;
|
|
1310
1310
|
/**
|
|
1311
1311
|
* @description The gateway fee amount, represented in cents
|
|
1312
1312
|
* @example 200
|
|
1313
1313
|
*/
|
|
1314
|
-
gateway_fee_amount
|
|
1314
|
+
gateway_fee_amount: number;
|
|
1315
1315
|
/**
|
|
1316
1316
|
* @description The tax amount, represented in cents
|
|
1317
1317
|
* @example 1200
|
|
1318
1318
|
*/
|
|
1319
|
-
tax_amount
|
|
1319
|
+
tax_amount: number;
|
|
1320
1320
|
/**
|
|
1321
1321
|
* @description The platform fee amount, represented in cents
|
|
1322
1322
|
* @example 375
|
|
1323
1323
|
*/
|
|
1324
|
-
platform_fee_amount
|
|
1324
|
+
platform_fee_amount: number;
|
|
1325
1325
|
/**
|
|
1326
1326
|
* @description The net amount recieved by the associated store, represented in cents
|
|
1327
1327
|
* @example 5925
|
|
1328
1328
|
*/
|
|
1329
|
-
store_net_amount
|
|
1329
|
+
store_net_amount: number;
|
|
1330
1330
|
/** @description The status of the payment */
|
|
1331
|
-
status
|
|
1331
|
+
status: string;
|
|
1332
1332
|
/**
|
|
1333
1333
|
* Format: date-time
|
|
1334
1334
|
* @description Indicated when a chargeback was opened for the payment
|
|
1335
1335
|
* @example 2024-01-25T14:45:00Z
|
|
1336
1336
|
*/
|
|
1337
|
-
chargeback_at
|
|
1337
|
+
chargeback_at: string;
|
|
1338
1338
|
};
|
|
1339
1339
|
};
|
|
1340
1340
|
};
|
|
@@ -1402,109 +1402,109 @@ export interface webhooks {
|
|
|
1402
1402
|
* @description The ID of the Webhook Event
|
|
1403
1403
|
* @example 411486491630370816
|
|
1404
1404
|
*/
|
|
1405
|
-
event_id
|
|
1405
|
+
event_id: string;
|
|
1406
1406
|
body: {
|
|
1407
1407
|
/**
|
|
1408
1408
|
* Format: flake-id
|
|
1409
1409
|
* @description The Flake ID of the Refund
|
|
1410
1410
|
* @example 411486491630370816
|
|
1411
1411
|
*/
|
|
1412
|
-
id
|
|
1412
|
+
id: string;
|
|
1413
1413
|
/**
|
|
1414
1414
|
* Format: flake-id
|
|
1415
1415
|
* @description The Flake ID of the store associated with the Refund
|
|
1416
1416
|
* @example 411486491630370816
|
|
1417
1417
|
*/
|
|
1418
|
-
store_id
|
|
1418
|
+
store_id: string;
|
|
1419
1419
|
/**
|
|
1420
1420
|
* Format: flake-id
|
|
1421
1421
|
* @description The Flake ID of Order associated with the refund
|
|
1422
1422
|
* @example 411486491630370816
|
|
1423
1423
|
*/
|
|
1424
|
-
order_id
|
|
1424
|
+
order_id: string;
|
|
1425
1425
|
customer?: components["schemas"]["CustomerDTO"] | null;
|
|
1426
1426
|
/**
|
|
1427
1427
|
* Format: flake-id
|
|
1428
1428
|
* @description The Flake ID of the Payment associated with the refund
|
|
1429
1429
|
* @example 411486491630370816
|
|
1430
1430
|
*/
|
|
1431
|
-
payment_id
|
|
1431
|
+
payment_id: string;
|
|
1432
1432
|
/** @description The Payment Gateway associated with the refund */
|
|
1433
|
-
gateway
|
|
1433
|
+
gateway: string;
|
|
1434
1434
|
/**
|
|
1435
1435
|
* @description The ISO-4217 Currency Code of the Payment
|
|
1436
1436
|
* @example USD
|
|
1437
1437
|
*/
|
|
1438
|
-
currency
|
|
1438
|
+
currency: string;
|
|
1439
1439
|
/**
|
|
1440
1440
|
* @description Indicates if taxes were inclusive in the associated payment
|
|
1441
1441
|
* @example false
|
|
1442
1442
|
*/
|
|
1443
|
-
tax_inclusive
|
|
1443
|
+
tax_inclusive: boolean;
|
|
1444
1444
|
/**
|
|
1445
1445
|
* @description The initial payment amount, represented in cents
|
|
1446
1446
|
* @example 5000
|
|
1447
1447
|
*/
|
|
1448
|
-
amount
|
|
1448
|
+
amount: number;
|
|
1449
1449
|
/**
|
|
1450
1450
|
* @description The initial gateway fee amount, represented in cents
|
|
1451
1451
|
* @example 150
|
|
1452
1452
|
*/
|
|
1453
|
-
gateway_fee_amount
|
|
1453
|
+
gateway_fee_amount: number;
|
|
1454
1454
|
/**
|
|
1455
1455
|
* @description The initial tax amount, represented in cents
|
|
1456
1456
|
* @example 800
|
|
1457
1457
|
*/
|
|
1458
|
-
tax_amount
|
|
1458
|
+
tax_amount: number;
|
|
1459
1459
|
/**
|
|
1460
1460
|
* @description The initial platform fee amount, represented in cents
|
|
1461
1461
|
* @example 250
|
|
1462
1462
|
*/
|
|
1463
|
-
platform_fee_amount
|
|
1463
|
+
platform_fee_amount: number;
|
|
1464
1464
|
/**
|
|
1465
1465
|
* @description The initial store net amount, represented in cents
|
|
1466
1466
|
* @example 3800
|
|
1467
1467
|
*/
|
|
1468
|
-
store_net_amount
|
|
1468
|
+
store_net_amount: number;
|
|
1469
1469
|
/**
|
|
1470
1470
|
* @description The amount refunded to the store, represented in cents
|
|
1471
1471
|
* @example 5000
|
|
1472
1472
|
*/
|
|
1473
|
-
store_refund_amount
|
|
1473
|
+
store_refund_amount: number;
|
|
1474
1474
|
/**
|
|
1475
1475
|
* Format: date-time
|
|
1476
1476
|
* @description Indicates when the refund was created
|
|
1477
1477
|
* @example 2024-01-20T12:00:00Z
|
|
1478
1478
|
*/
|
|
1479
|
-
created_at
|
|
1479
|
+
created_at: string;
|
|
1480
1480
|
/**
|
|
1481
1481
|
* Format: date-time
|
|
1482
1482
|
* @description Indicates when the refund was approved
|
|
1483
1483
|
* @example 2024-01-20T12:30:00Z
|
|
1484
1484
|
*/
|
|
1485
|
-
approved_at
|
|
1485
|
+
approved_at: string;
|
|
1486
1486
|
/**
|
|
1487
1487
|
* Format: date-time
|
|
1488
1488
|
* @description Indicates when the refund was pending
|
|
1489
1489
|
* @example 2024-01-20T12:15:00Z
|
|
1490
1490
|
*/
|
|
1491
|
-
pending_at
|
|
1491
|
+
pending_at: string;
|
|
1492
1492
|
/**
|
|
1493
1493
|
* Format: date-time
|
|
1494
1494
|
* @description Indicates when the refund was completed
|
|
1495
1495
|
* @example 2024-01-20T13:00:00Z
|
|
1496
1496
|
*/
|
|
1497
|
-
completed_at
|
|
1497
|
+
completed_at: string;
|
|
1498
1498
|
/**
|
|
1499
1499
|
* @description The email address of the intial payment customer
|
|
1500
1500
|
* @example john@doe.com
|
|
1501
1501
|
*/
|
|
1502
|
-
billing_email
|
|
1502
|
+
billing_email: string;
|
|
1503
1503
|
/**
|
|
1504
1504
|
* @description The status of the refund. Possible options: created, approved, processing, completed, canceled, failed
|
|
1505
1505
|
* @example created
|
|
1506
1506
|
*/
|
|
1507
|
-
status
|
|
1507
|
+
status: string;
|
|
1508
1508
|
};
|
|
1509
1509
|
};
|
|
1510
1510
|
};
|
|
@@ -1572,130 +1572,130 @@ export interface webhooks {
|
|
|
1572
1572
|
* @description The ID of the Webhook Event
|
|
1573
1573
|
* @example 411486491630370816
|
|
1574
1574
|
*/
|
|
1575
|
-
event_id
|
|
1575
|
+
event_id: string;
|
|
1576
1576
|
body: {
|
|
1577
1577
|
/**
|
|
1578
1578
|
* Format: flake-id
|
|
1579
1579
|
* @description The Flake ID of the Subscription
|
|
1580
1580
|
* @example 411486491630370816
|
|
1581
1581
|
*/
|
|
1582
|
-
id
|
|
1582
|
+
id: string;
|
|
1583
1583
|
/**
|
|
1584
1584
|
* Format: flake-id
|
|
1585
1585
|
* @description The Flake ID of the Store associated with the Subscription
|
|
1586
1586
|
* @example 411486491630370816
|
|
1587
1587
|
*/
|
|
1588
|
-
store_id
|
|
1588
|
+
store_id: string;
|
|
1589
1589
|
/**
|
|
1590
1590
|
* Format: flake-id
|
|
1591
1591
|
* @description The Flake ID of the Customer associated with the Subscription
|
|
1592
1592
|
* @example 411486491630370816
|
|
1593
1593
|
*/
|
|
1594
|
-
customer_id
|
|
1595
|
-
customer
|
|
1594
|
+
customer_id: string;
|
|
1595
|
+
customer: components["schemas"]["CustomerDTO"];
|
|
1596
1596
|
/**
|
|
1597
1597
|
* @description The current billing cycle number
|
|
1598
1598
|
* @example 1
|
|
1599
1599
|
*/
|
|
1600
|
-
billing_cycle_sequence
|
|
1600
|
+
billing_cycle_sequence: number;
|
|
1601
1601
|
/**
|
|
1602
1602
|
* @description The billing email address of the customer associated with the Subscription
|
|
1603
1603
|
* @example john@doe.com
|
|
1604
1604
|
*/
|
|
1605
|
-
billing_email
|
|
1605
|
+
billing_email: string;
|
|
1606
1606
|
/**
|
|
1607
1607
|
* @description The subtotal amount of the Subscription represented in cents
|
|
1608
1608
|
* @example 9999
|
|
1609
1609
|
*/
|
|
1610
|
-
subtotal_amount
|
|
1610
|
+
subtotal_amount: number;
|
|
1611
1611
|
/**
|
|
1612
1612
|
* @description The tax amount of the Subscription represented in cents
|
|
1613
1613
|
* @example 1500
|
|
1614
1614
|
*/
|
|
1615
|
-
tax_amount
|
|
1615
|
+
tax_amount: number;
|
|
1616
1616
|
/**
|
|
1617
1617
|
* @description The discount amount applied to the Subscription represented in cents
|
|
1618
1618
|
* @example 1000
|
|
1619
1619
|
*/
|
|
1620
|
-
discount_amount
|
|
1620
|
+
discount_amount: number;
|
|
1621
1621
|
/**
|
|
1622
1622
|
* @description The total amount of the Subscription represented in cents
|
|
1623
1623
|
* @example 10499
|
|
1624
1624
|
*/
|
|
1625
|
-
total_amount
|
|
1625
|
+
total_amount: number;
|
|
1626
1626
|
/**
|
|
1627
1627
|
* @description The currency code of the Subscription
|
|
1628
1628
|
* @example USD
|
|
1629
1629
|
*/
|
|
1630
|
-
currency
|
|
1630
|
+
currency: string;
|
|
1631
1631
|
/**
|
|
1632
1632
|
* @description The interval value of the billing cycle
|
|
1633
1633
|
* @example 1
|
|
1634
1634
|
*/
|
|
1635
|
-
interval_value
|
|
1635
|
+
interval_value: number;
|
|
1636
1636
|
/**
|
|
1637
1637
|
* @description The interval scale of the billing cycle
|
|
1638
1638
|
* @example month
|
|
1639
1639
|
*/
|
|
1640
|
-
interval_scale
|
|
1640
|
+
interval_scale: string;
|
|
1641
1641
|
/**
|
|
1642
1642
|
* Format: flake-id
|
|
1643
1643
|
* @description The Flake ID of the Product associated with the Subscription
|
|
1644
1644
|
* @example 411486491630370816
|
|
1645
1645
|
*/
|
|
1646
|
-
product_id
|
|
1646
|
+
product_id: string;
|
|
1647
1647
|
/**
|
|
1648
1648
|
* Format: flake-id
|
|
1649
1649
|
* @description The Flake ID of the Product Version associated with the Subscription
|
|
1650
1650
|
* @example 411486491630370816
|
|
1651
1651
|
*/
|
|
1652
|
-
product_version_id
|
|
1652
|
+
product_version_id: string;
|
|
1653
1653
|
/**
|
|
1654
1654
|
* @description The name of the Product associated with the Subscription
|
|
1655
1655
|
* @example Example Product
|
|
1656
1656
|
*/
|
|
1657
|
-
product_name
|
|
1657
|
+
product_name: string;
|
|
1658
1658
|
/**
|
|
1659
1659
|
* @description The image URL of the Product associated with the Subscription
|
|
1660
1660
|
* @example https://example.com/image.jpg
|
|
1661
1661
|
*/
|
|
1662
1662
|
product_image_url?: null | string;
|
|
1663
|
-
product
|
|
1663
|
+
product: components["schemas"]["ProductDTO"];
|
|
1664
1664
|
/**
|
|
1665
1665
|
* @description The ISO-3166 Country Code of customer associated with the Subscription
|
|
1666
1666
|
* @example US
|
|
1667
1667
|
*/
|
|
1668
|
-
billing_country
|
|
1668
|
+
billing_country: string;
|
|
1669
1669
|
/**
|
|
1670
1670
|
* @description The initial subtotal amount of the Subscription represented in cents
|
|
1671
1671
|
* @example 9999
|
|
1672
1672
|
*/
|
|
1673
|
-
initial_subtotal_amount
|
|
1673
|
+
initial_subtotal_amount: number;
|
|
1674
1674
|
/**
|
|
1675
1675
|
* @description The initial tax amount of the Subscription represented in cents
|
|
1676
1676
|
* @example 1500
|
|
1677
1677
|
*/
|
|
1678
|
-
initial_tax_amount
|
|
1678
|
+
initial_tax_amount: number;
|
|
1679
1679
|
/**
|
|
1680
1680
|
* @description The initial discount amount applied to the Subscription represented in cents
|
|
1681
1681
|
* @example 2000
|
|
1682
1682
|
*/
|
|
1683
|
-
initial_discount_amount
|
|
1683
|
+
initial_discount_amount: number;
|
|
1684
1684
|
/**
|
|
1685
1685
|
* @description The initial gift card usage amount applied to the Subscription represented in cents
|
|
1686
1686
|
* @example 0
|
|
1687
1687
|
*/
|
|
1688
|
-
initial_giftcard_usage_amount
|
|
1688
|
+
initial_giftcard_usage_amount: number;
|
|
1689
1689
|
/**
|
|
1690
1690
|
* @description The initial total amount of the Subscription represented in cents
|
|
1691
1691
|
* @example 9499
|
|
1692
1692
|
*/
|
|
1693
|
-
initial_total_amount
|
|
1693
|
+
initial_total_amount: number;
|
|
1694
1694
|
/**
|
|
1695
1695
|
* @description The IP address of the Customer
|
|
1696
1696
|
* @example 127.0.0.1/24
|
|
1697
1697
|
*/
|
|
1698
|
-
customer_ip
|
|
1698
|
+
customer_ip: string;
|
|
1699
1699
|
/**
|
|
1700
1700
|
* Format: date-time
|
|
1701
1701
|
* @description The start date of the current billing period
|
|
@@ -1725,18 +1725,18 @@ export interface webhooks {
|
|
|
1725
1725
|
* @description The Flake ID of the Checkout associated with the Subscription
|
|
1726
1726
|
* @example 411486491630370816
|
|
1727
1727
|
*/
|
|
1728
|
-
checkout_id
|
|
1728
|
+
checkout_id: string;
|
|
1729
1729
|
/**
|
|
1730
1730
|
* Format: flake-id
|
|
1731
1731
|
* @description The Flake ID of the Checkout Line associated with the Subscription
|
|
1732
1732
|
* @example 411486491630370816
|
|
1733
1733
|
*/
|
|
1734
|
-
checkout_line_id
|
|
1734
|
+
checkout_line_id: string;
|
|
1735
1735
|
/**
|
|
1736
1736
|
* @description The current status of the Subscription. Possible options: created, active, canceled
|
|
1737
1737
|
* @example created
|
|
1738
1738
|
*/
|
|
1739
|
-
status
|
|
1739
|
+
status: string;
|
|
1740
1740
|
};
|
|
1741
1741
|
};
|
|
1742
1742
|
};
|
|
@@ -1804,130 +1804,130 @@ export interface webhooks {
|
|
|
1804
1804
|
* @description The ID of the Webhook Event
|
|
1805
1805
|
* @example 411486491630370816
|
|
1806
1806
|
*/
|
|
1807
|
-
event_id
|
|
1807
|
+
event_id: string;
|
|
1808
1808
|
body: {
|
|
1809
1809
|
/**
|
|
1810
1810
|
* Format: flake-id
|
|
1811
1811
|
* @description The Flake ID of the Subscription
|
|
1812
1812
|
* @example 411486491630370816
|
|
1813
1813
|
*/
|
|
1814
|
-
id
|
|
1814
|
+
id: string;
|
|
1815
1815
|
/**
|
|
1816
1816
|
* Format: flake-id
|
|
1817
1817
|
* @description The Flake ID of the Store associated with the Subscription
|
|
1818
1818
|
* @example 411486491630370816
|
|
1819
1819
|
*/
|
|
1820
|
-
store_id
|
|
1820
|
+
store_id: string;
|
|
1821
1821
|
/**
|
|
1822
1822
|
* Format: flake-id
|
|
1823
1823
|
* @description The Flake ID of the Customer associated with the Subscription
|
|
1824
1824
|
* @example 411486491630370816
|
|
1825
1825
|
*/
|
|
1826
|
-
customer_id
|
|
1827
|
-
customer
|
|
1826
|
+
customer_id: string;
|
|
1827
|
+
customer: components["schemas"]["CustomerDTO"];
|
|
1828
1828
|
/**
|
|
1829
1829
|
* @description The current billing cycle number
|
|
1830
1830
|
* @example 1
|
|
1831
1831
|
*/
|
|
1832
|
-
billing_cycle_sequence
|
|
1832
|
+
billing_cycle_sequence: number;
|
|
1833
1833
|
/**
|
|
1834
1834
|
* @description The billing email address of the customer associated with the Subscription
|
|
1835
1835
|
* @example cancel@example.com
|
|
1836
1836
|
*/
|
|
1837
|
-
billing_email
|
|
1837
|
+
billing_email: string;
|
|
1838
1838
|
/**
|
|
1839
1839
|
* @description The subtotal amount of the Subscription represented in cents
|
|
1840
1840
|
* @example 4999
|
|
1841
1841
|
*/
|
|
1842
|
-
subtotal_amount
|
|
1842
|
+
subtotal_amount: number;
|
|
1843
1843
|
/**
|
|
1844
1844
|
* @description The tax amount of the Subscription represented in cents
|
|
1845
1845
|
* @example 750
|
|
1846
1846
|
*/
|
|
1847
|
-
tax_amount
|
|
1847
|
+
tax_amount: number;
|
|
1848
1848
|
/**
|
|
1849
1849
|
* @description The discount amount applied to the Subscription represented in cents
|
|
1850
1850
|
* @example 0
|
|
1851
1851
|
*/
|
|
1852
|
-
discount_amount
|
|
1852
|
+
discount_amount: number;
|
|
1853
1853
|
/**
|
|
1854
1854
|
* @description The total amount of the Subscription represented in cents
|
|
1855
1855
|
* @example 5749
|
|
1856
1856
|
*/
|
|
1857
|
-
total_amount
|
|
1857
|
+
total_amount: number;
|
|
1858
1858
|
/**
|
|
1859
1859
|
* @description The currency code of the Subscription
|
|
1860
1860
|
* @example USD
|
|
1861
1861
|
*/
|
|
1862
|
-
currency
|
|
1862
|
+
currency: string;
|
|
1863
1863
|
/**
|
|
1864
1864
|
* @description The interval value of the billing cycle
|
|
1865
1865
|
* @example 1
|
|
1866
1866
|
*/
|
|
1867
|
-
interval_value
|
|
1867
|
+
interval_value: number;
|
|
1868
1868
|
/**
|
|
1869
1869
|
* @description The interval scale of the billing cycle
|
|
1870
1870
|
* @example annually
|
|
1871
1871
|
*/
|
|
1872
|
-
interval_scale
|
|
1872
|
+
interval_scale: string;
|
|
1873
1873
|
/**
|
|
1874
1874
|
* Format: flake-id
|
|
1875
1875
|
* @description The Flake ID of the Product associated with the Subscription
|
|
1876
1876
|
* @example 411486491630370816
|
|
1877
1877
|
*/
|
|
1878
|
-
product_id
|
|
1878
|
+
product_id: string;
|
|
1879
1879
|
/**
|
|
1880
1880
|
* Format: flake-id
|
|
1881
1881
|
* @description The Flake ID of the Product Version associated with the Subscription
|
|
1882
1882
|
* @example 411486491630370816
|
|
1883
1883
|
*/
|
|
1884
|
-
product_version_id
|
|
1884
|
+
product_version_id: string;
|
|
1885
1885
|
/**
|
|
1886
1886
|
* @description The name of the Product associated with the Subscription
|
|
1887
1887
|
* @example Starter Plan
|
|
1888
1888
|
*/
|
|
1889
|
-
product_name
|
|
1889
|
+
product_name: string;
|
|
1890
1890
|
/**
|
|
1891
1891
|
* @description The image URL of the Product associated with the Subscription
|
|
1892
1892
|
* @example https://example.com/starter.jpg
|
|
1893
1893
|
*/
|
|
1894
1894
|
product_image_url?: null | string;
|
|
1895
|
-
product
|
|
1895
|
+
product: components["schemas"]["ProductDTO"];
|
|
1896
1896
|
/**
|
|
1897
1897
|
* @description The ISO-3166 country code of customer associated with the Subscription
|
|
1898
1898
|
* @example US
|
|
1899
1899
|
*/
|
|
1900
|
-
billing_country
|
|
1900
|
+
billing_country: string;
|
|
1901
1901
|
/**
|
|
1902
1902
|
* @description The initial subtotal amount of the Subscription represented in cents
|
|
1903
1903
|
* @example 4999
|
|
1904
1904
|
*/
|
|
1905
|
-
initial_subtotal_amount
|
|
1905
|
+
initial_subtotal_amount: number;
|
|
1906
1906
|
/**
|
|
1907
1907
|
* @description The initial tax amount of the Subscription represented in cents
|
|
1908
1908
|
* @example 750
|
|
1909
1909
|
*/
|
|
1910
|
-
initial_tax_amount
|
|
1910
|
+
initial_tax_amount: number;
|
|
1911
1911
|
/**
|
|
1912
1912
|
* @description The initial discount amount applied to the Subscription represented in cents
|
|
1913
1913
|
* @example 500
|
|
1914
1914
|
*/
|
|
1915
|
-
initial_discount_amount
|
|
1915
|
+
initial_discount_amount: number;
|
|
1916
1916
|
/**
|
|
1917
1917
|
* @description The initial gift card usage amount applied to the Subscription represented in cents
|
|
1918
1918
|
* @example 0
|
|
1919
1919
|
*/
|
|
1920
|
-
initial_giftcard_usage_amount
|
|
1920
|
+
initial_giftcard_usage_amount: number;
|
|
1921
1921
|
/**
|
|
1922
1922
|
* @description The initial total amount of the Subscription represented in cents
|
|
1923
1923
|
* @example 5249
|
|
1924
1924
|
*/
|
|
1925
|
-
initial_total_amount
|
|
1925
|
+
initial_total_amount: number;
|
|
1926
1926
|
/**
|
|
1927
1927
|
* @description The IP address of the Customer
|
|
1928
1928
|
* @example 127.0.0.1/24
|
|
1929
1929
|
*/
|
|
1930
|
-
customer_ip
|
|
1930
|
+
customer_ip: string;
|
|
1931
1931
|
/**
|
|
1932
1932
|
* Format: date-time
|
|
1933
1933
|
* @description The start date of the current billing period
|
|
@@ -1968,18 +1968,18 @@ export interface webhooks {
|
|
|
1968
1968
|
* @description The Flake ID of the Checkout associated with the Subscription
|
|
1969
1969
|
* @example 411486491630370816
|
|
1970
1970
|
*/
|
|
1971
|
-
checkout_id
|
|
1971
|
+
checkout_id: string;
|
|
1972
1972
|
/**
|
|
1973
1973
|
* Format: flake-id
|
|
1974
1974
|
* @description The Flake ID of the Checkout Line associated with the Subscription
|
|
1975
1975
|
* @example 411486491630370816
|
|
1976
1976
|
*/
|
|
1977
|
-
checkout_line_id
|
|
1977
|
+
checkout_line_id: string;
|
|
1978
1978
|
/**
|
|
1979
1979
|
* @description The current status of the Subscription. Possible options: created, active, canceled
|
|
1980
1980
|
* @example created
|
|
1981
1981
|
*/
|
|
1982
|
-
status
|
|
1982
|
+
status: string;
|
|
1983
1983
|
};
|
|
1984
1984
|
};
|
|
1985
1985
|
};
|
|
@@ -2047,27 +2047,27 @@ export interface webhooks {
|
|
|
2047
2047
|
* @description The ID of the Webhook Event
|
|
2048
2048
|
* @example 411486491630370816
|
|
2049
2049
|
*/
|
|
2050
|
-
event_id
|
|
2050
|
+
event_id: string;
|
|
2051
2051
|
body: {
|
|
2052
2052
|
/**
|
|
2053
2053
|
* Format: flake-id
|
|
2054
2054
|
* @description The Flake ID of the Trial
|
|
2055
2055
|
* @example 411486491630370816
|
|
2056
2056
|
*/
|
|
2057
|
-
id
|
|
2057
|
+
id: string;
|
|
2058
2058
|
/**
|
|
2059
2059
|
* Format: flake-id
|
|
2060
2060
|
* @description The Flake ID of the Store associated with the Trial
|
|
2061
2061
|
* @example 411486491630370816
|
|
2062
2062
|
*/
|
|
2063
|
-
store_id
|
|
2063
|
+
store_id: string;
|
|
2064
2064
|
/**
|
|
2065
2065
|
* Format: flake-id
|
|
2066
2066
|
* @description The Flake ID of the Customer associated with the Trial
|
|
2067
2067
|
* @example 411486491630370816
|
|
2068
2068
|
*/
|
|
2069
|
-
customer_id
|
|
2070
|
-
customer
|
|
2069
|
+
customer_id: string;
|
|
2070
|
+
customer: components["schemas"]["CustomerDTO"];
|
|
2071
2071
|
/**
|
|
2072
2072
|
* Format: flake-id
|
|
2073
2073
|
* @description The Flake ID of the Checkout associated with the Trial
|
|
@@ -2085,18 +2085,18 @@ export interface webhooks {
|
|
|
2085
2085
|
* @description The Flake ID of the Product associated with the Trial
|
|
2086
2086
|
* @example 411486491630370816
|
|
2087
2087
|
*/
|
|
2088
|
-
product_id
|
|
2088
|
+
product_id: string;
|
|
2089
2089
|
/**
|
|
2090
2090
|
* Format: flake-id
|
|
2091
2091
|
* @description The Flake ID of the Product Version associated with the Trial
|
|
2092
2092
|
* @example 411486491630370816
|
|
2093
2093
|
*/
|
|
2094
|
-
product_version_id
|
|
2094
|
+
product_version_id: string;
|
|
2095
2095
|
/**
|
|
2096
2096
|
* @description The name of the Product associated with the Trial
|
|
2097
2097
|
* @example Example Product
|
|
2098
2098
|
*/
|
|
2099
|
-
product_name
|
|
2099
|
+
product_name: string;
|
|
2100
2100
|
/**
|
|
2101
2101
|
* @description The image URL of the Product associated with the Trial
|
|
2102
2102
|
* @example https://example.com/image.jpg
|
|
@@ -2106,12 +2106,12 @@ export interface webhooks {
|
|
|
2106
2106
|
* @description The period value of the Trial
|
|
2107
2107
|
* @example 1
|
|
2108
2108
|
*/
|
|
2109
|
-
period_value
|
|
2109
|
+
period_value: number;
|
|
2110
2110
|
/**
|
|
2111
2111
|
* @description The period scale of the Trial
|
|
2112
2112
|
* @example month
|
|
2113
2113
|
*/
|
|
2114
|
-
period_scale
|
|
2114
|
+
period_scale: string;
|
|
2115
2115
|
/**
|
|
2116
2116
|
* Format: date-time
|
|
2117
2117
|
* @description The start date of the Trial
|
|
@@ -2128,13 +2128,13 @@ export interface webhooks {
|
|
|
2128
2128
|
* @description The current status of the Trial. Possible options: created, active, canceled, completed
|
|
2129
2129
|
* @example created
|
|
2130
2130
|
*/
|
|
2131
|
-
status
|
|
2131
|
+
status: string;
|
|
2132
2132
|
/**
|
|
2133
2133
|
* Format: date-time
|
|
2134
2134
|
* @description The date and time when the Trial was created
|
|
2135
2135
|
* @example 2024-06-10T08:30:00Z
|
|
2136
2136
|
*/
|
|
2137
|
-
created_at
|
|
2137
|
+
created_at: string;
|
|
2138
2138
|
/**
|
|
2139
2139
|
* Format: date-time
|
|
2140
2140
|
* @description Indicates when the Trial was canceled
|
|
@@ -2208,27 +2208,27 @@ export interface webhooks {
|
|
|
2208
2208
|
* @description The ID of the Webhook Event
|
|
2209
2209
|
* @example 411486491630370816
|
|
2210
2210
|
*/
|
|
2211
|
-
event_id
|
|
2211
|
+
event_id: string;
|
|
2212
2212
|
body: {
|
|
2213
2213
|
/**
|
|
2214
2214
|
* Format: flake-id
|
|
2215
2215
|
* @description The Flake ID of the Trial
|
|
2216
2216
|
* @example 411486491630370816
|
|
2217
2217
|
*/
|
|
2218
|
-
id
|
|
2218
|
+
id: string;
|
|
2219
2219
|
/**
|
|
2220
2220
|
* Format: flake-id
|
|
2221
2221
|
* @description The Flake ID of the Store associated with the Trial
|
|
2222
2222
|
* @example 411486491630370816
|
|
2223
2223
|
*/
|
|
2224
|
-
store_id
|
|
2224
|
+
store_id: string;
|
|
2225
2225
|
/**
|
|
2226
2226
|
* Format: flake-id
|
|
2227
2227
|
* @description The Flake ID of the Customer associated with the Trial
|
|
2228
2228
|
* @example 411486491630370816
|
|
2229
2229
|
*/
|
|
2230
|
-
customer_id
|
|
2231
|
-
customer
|
|
2230
|
+
customer_id: string;
|
|
2231
|
+
customer: components["schemas"]["CustomerDTO"];
|
|
2232
2232
|
/**
|
|
2233
2233
|
* Format: flake-id
|
|
2234
2234
|
* @description The Flake ID of the Checkout associated with the Trial
|
|
@@ -2246,18 +2246,18 @@ export interface webhooks {
|
|
|
2246
2246
|
* @description The Flake ID of the Product associated with the Trial
|
|
2247
2247
|
* @example 411486491630370816
|
|
2248
2248
|
*/
|
|
2249
|
-
product_id
|
|
2249
|
+
product_id: string;
|
|
2250
2250
|
/**
|
|
2251
2251
|
* Format: flake-id
|
|
2252
2252
|
* @description The Flake ID of the Product Version associated with the Trial
|
|
2253
2253
|
* @example 411486491630370816
|
|
2254
2254
|
*/
|
|
2255
|
-
product_version_id
|
|
2255
|
+
product_version_id: string;
|
|
2256
2256
|
/**
|
|
2257
2257
|
* @description The name of the Product associated with the Trial
|
|
2258
2258
|
* @example Example Product
|
|
2259
2259
|
*/
|
|
2260
|
-
product_name
|
|
2260
|
+
product_name: string;
|
|
2261
2261
|
/**
|
|
2262
2262
|
* @description The image URL of the Product associated with the Trial
|
|
2263
2263
|
* @example https://example.com/image.jpg
|
|
@@ -2267,12 +2267,12 @@ export interface webhooks {
|
|
|
2267
2267
|
* @description The period value of the Trial
|
|
2268
2268
|
* @example 1
|
|
2269
2269
|
*/
|
|
2270
|
-
period_value
|
|
2270
|
+
period_value: number;
|
|
2271
2271
|
/**
|
|
2272
2272
|
* @description The period scale of the Trial
|
|
2273
2273
|
* @example month
|
|
2274
2274
|
*/
|
|
2275
|
-
period_scale
|
|
2275
|
+
period_scale: string;
|
|
2276
2276
|
/**
|
|
2277
2277
|
* Format: date-time
|
|
2278
2278
|
* @description The start date of the Trial
|
|
@@ -2289,13 +2289,13 @@ export interface webhooks {
|
|
|
2289
2289
|
* @description The current status of the Trial. Possible options: created, active, canceled, completed
|
|
2290
2290
|
* @example created
|
|
2291
2291
|
*/
|
|
2292
|
-
status
|
|
2292
|
+
status: string;
|
|
2293
2293
|
/**
|
|
2294
2294
|
* Format: date-time
|
|
2295
2295
|
* @description The date and time when the Trial was created
|
|
2296
2296
|
* @example 2024-06-10T08:30:00Z
|
|
2297
2297
|
*/
|
|
2298
|
-
created_at
|
|
2298
|
+
created_at: string;
|
|
2299
2299
|
/**
|
|
2300
2300
|
* Format: date-time
|
|
2301
2301
|
* @description Indicates when the Trial was canceled
|
|
@@ -2369,27 +2369,27 @@ export interface webhooks {
|
|
|
2369
2369
|
* @description The ID of the Webhook Event
|
|
2370
2370
|
* @example 411486491630370816
|
|
2371
2371
|
*/
|
|
2372
|
-
event_id
|
|
2372
|
+
event_id: string;
|
|
2373
2373
|
body: {
|
|
2374
2374
|
/**
|
|
2375
2375
|
* Format: flake-id
|
|
2376
2376
|
* @description The Flake ID of the Trial
|
|
2377
2377
|
* @example 411486491630370816
|
|
2378
2378
|
*/
|
|
2379
|
-
id
|
|
2379
|
+
id: string;
|
|
2380
2380
|
/**
|
|
2381
2381
|
* Format: flake-id
|
|
2382
2382
|
* @description The Flake ID of the Store associated with the Trial
|
|
2383
2383
|
* @example 411486491630370816
|
|
2384
2384
|
*/
|
|
2385
|
-
store_id
|
|
2385
|
+
store_id: string;
|
|
2386
2386
|
/**
|
|
2387
2387
|
* Format: flake-id
|
|
2388
2388
|
* @description The Flake ID of the Customer associated with the Trial
|
|
2389
2389
|
* @example 411486491630370816
|
|
2390
2390
|
*/
|
|
2391
|
-
customer_id
|
|
2392
|
-
customer
|
|
2391
|
+
customer_id: string;
|
|
2392
|
+
customer: components["schemas"]["CustomerDTO"];
|
|
2393
2393
|
/**
|
|
2394
2394
|
* Format: flake-id
|
|
2395
2395
|
* @description The Flake ID of the Checkout associated with the Trial
|
|
@@ -2407,18 +2407,18 @@ export interface webhooks {
|
|
|
2407
2407
|
* @description The Flake ID of the Product associated with the Trial
|
|
2408
2408
|
* @example 411486491630370816
|
|
2409
2409
|
*/
|
|
2410
|
-
product_id
|
|
2410
|
+
product_id: string;
|
|
2411
2411
|
/**
|
|
2412
2412
|
* Format: flake-id
|
|
2413
2413
|
* @description The Flake ID of the Product Version associated with the Trial
|
|
2414
2414
|
* @example 411486491630370816
|
|
2415
2415
|
*/
|
|
2416
|
-
product_version_id
|
|
2416
|
+
product_version_id: string;
|
|
2417
2417
|
/**
|
|
2418
2418
|
* @description The name of the Product associated with the Trial
|
|
2419
2419
|
* @example Example Product
|
|
2420
2420
|
*/
|
|
2421
|
-
product_name
|
|
2421
|
+
product_name: string;
|
|
2422
2422
|
/**
|
|
2423
2423
|
* @description The image URL of the Product associated with the Trial
|
|
2424
2424
|
* @example https://example.com/image.jpg
|
|
@@ -2428,12 +2428,12 @@ export interface webhooks {
|
|
|
2428
2428
|
* @description The period value of the Trial
|
|
2429
2429
|
* @example 1
|
|
2430
2430
|
*/
|
|
2431
|
-
period_value
|
|
2431
|
+
period_value: number;
|
|
2432
2432
|
/**
|
|
2433
2433
|
* @description The period scale of the Trial
|
|
2434
2434
|
* @example month
|
|
2435
2435
|
*/
|
|
2436
|
-
period_scale
|
|
2436
|
+
period_scale: string;
|
|
2437
2437
|
/**
|
|
2438
2438
|
* Format: date-time
|
|
2439
2439
|
* @description The start date of the Trial
|
|
@@ -2450,13 +2450,13 @@ export interface webhooks {
|
|
|
2450
2450
|
* @description The current status of the Trial. Possible options: created, active, canceled, completed
|
|
2451
2451
|
* @example created
|
|
2452
2452
|
*/
|
|
2453
|
-
status
|
|
2453
|
+
status: string;
|
|
2454
2454
|
/**
|
|
2455
2455
|
* Format: date-time
|
|
2456
2456
|
* @description The date and time when the Trial was created
|
|
2457
2457
|
* @example 2024-06-10T08:30:00Z
|
|
2458
2458
|
*/
|
|
2459
|
-
created_at
|
|
2459
|
+
created_at: string;
|
|
2460
2460
|
/**
|
|
2461
2461
|
* Format: date-time
|
|
2462
2462
|
* @description Indicates when the Trial was canceled
|
|
@@ -2506,13 +2506,13 @@ export interface components {
|
|
|
2506
2506
|
* @description The Flake ID of the Checkout
|
|
2507
2507
|
* @example 411486491630370816
|
|
2508
2508
|
*/
|
|
2509
|
-
id
|
|
2509
|
+
id: string;
|
|
2510
2510
|
/** @description Metadata associated with the checkout */
|
|
2511
|
-
metadata
|
|
2511
|
+
metadata: {
|
|
2512
2512
|
[key: string]: string;
|
|
2513
2513
|
};
|
|
2514
2514
|
/** @description The lines of the Checkout */
|
|
2515
|
-
lines
|
|
2515
|
+
lines: components["schemas"]["CheckoutLineDTO"][];
|
|
2516
2516
|
};
|
|
2517
2517
|
CheckoutLineDTO: {
|
|
2518
2518
|
/**
|
|
@@ -2520,21 +2520,21 @@ export interface components {
|
|
|
2520
2520
|
* @description The ID of the Checkout line
|
|
2521
2521
|
* @example 411486491630370816
|
|
2522
2522
|
*/
|
|
2523
|
-
id
|
|
2523
|
+
id: string;
|
|
2524
2524
|
/**
|
|
2525
2525
|
* Format: flake-id
|
|
2526
2526
|
* @description The Product Flake ID of the Checkout Line
|
|
2527
2527
|
* @example 411486491630370816
|
|
2528
2528
|
*/
|
|
2529
|
-
product_id
|
|
2529
|
+
product_id: string;
|
|
2530
2530
|
/**
|
|
2531
2531
|
* Format: flake-id
|
|
2532
2532
|
* @description The Product Version Flake ID of the Checkout Line
|
|
2533
2533
|
* @example 411486491630370816
|
|
2534
2534
|
*/
|
|
2535
|
-
product_version_id
|
|
2535
|
+
product_version_id: string;
|
|
2536
2536
|
/** @description Metadata associated with the Checkout Line */
|
|
2537
|
-
metadata
|
|
2537
|
+
metadata: {
|
|
2538
2538
|
[key: string]: string;
|
|
2539
2539
|
};
|
|
2540
2540
|
};
|
|
@@ -2544,12 +2544,12 @@ export interface components {
|
|
|
2544
2544
|
* @description The Flake ID of the Customer
|
|
2545
2545
|
* @example 411486491630370816
|
|
2546
2546
|
*/
|
|
2547
|
-
id
|
|
2547
|
+
id: string;
|
|
2548
2548
|
/** @example John */
|
|
2549
2549
|
name?: null | string;
|
|
2550
|
-
steam
|
|
2551
|
-
minecraft
|
|
2552
|
-
profile
|
|
2550
|
+
steam: components["schemas"]["SteamCustomerDTO"];
|
|
2551
|
+
minecraft: components["schemas"]["MinecraftCustomerDTO"];
|
|
2552
|
+
profile: components["schemas"]["GenericProfileDTO"];
|
|
2553
2553
|
};
|
|
2554
2554
|
GameServerDTO: {
|
|
2555
2555
|
/**
|
|
@@ -2557,27 +2557,27 @@ export interface components {
|
|
|
2557
2557
|
* @description The Flake ID of the Game Server
|
|
2558
2558
|
* @example 411486491630370816
|
|
2559
2559
|
*/
|
|
2560
|
-
id
|
|
2560
|
+
id: string;
|
|
2561
2561
|
/**
|
|
2562
2562
|
* @description The name of the Game Server
|
|
2563
2563
|
* @example John
|
|
2564
2564
|
*/
|
|
2565
|
-
name
|
|
2565
|
+
name: string;
|
|
2566
2566
|
/** @description Indicates if the Game Server is enabled */
|
|
2567
|
-
enabled
|
|
2567
|
+
enabled: boolean;
|
|
2568
2568
|
};
|
|
2569
2569
|
GenericProfileDTO: {
|
|
2570
|
-
id
|
|
2571
|
-
platform
|
|
2570
|
+
id: string;
|
|
2571
|
+
platform: string;
|
|
2572
2572
|
/** @example John */
|
|
2573
|
-
name
|
|
2574
|
-
avatar_url
|
|
2573
|
+
name: string;
|
|
2574
|
+
avatar_url: string;
|
|
2575
2575
|
};
|
|
2576
2576
|
MinecraftCustomerDTO: {
|
|
2577
|
-
id
|
|
2577
|
+
id: string;
|
|
2578
2578
|
/** @example Notch */
|
|
2579
|
-
name
|
|
2580
|
-
avatar_url
|
|
2579
|
+
name: string;
|
|
2580
|
+
avatar_url: string;
|
|
2581
2581
|
};
|
|
2582
2582
|
OrderDTO: {
|
|
2583
2583
|
/**
|
|
@@ -2585,21 +2585,21 @@ export interface components {
|
|
|
2585
2585
|
* @description The Flake ID of the Order
|
|
2586
2586
|
* @example 411486491630370816
|
|
2587
2587
|
*/
|
|
2588
|
-
id
|
|
2588
|
+
id: string;
|
|
2589
2589
|
/**
|
|
2590
2590
|
* Format: flake-id
|
|
2591
2591
|
* @description The Flake ID of the store associated with the order
|
|
2592
2592
|
* @example 411486491630370816
|
|
2593
2593
|
*/
|
|
2594
|
-
store_id
|
|
2595
|
-
customer
|
|
2594
|
+
store_id: string;
|
|
2595
|
+
customer: components["schemas"]["CustomerDTO"];
|
|
2596
2596
|
/**
|
|
2597
2597
|
* Format: flake-id
|
|
2598
2598
|
* @description The Flake ID of the Checkout associated with the order
|
|
2599
2599
|
* @example 411486491630370816
|
|
2600
2600
|
*/
|
|
2601
|
-
checkout_id
|
|
2602
|
-
checkout
|
|
2601
|
+
checkout_id: string;
|
|
2602
|
+
checkout: components["schemas"]["CheckoutDTO"];
|
|
2603
2603
|
/**
|
|
2604
2604
|
* Format: flake-id
|
|
2605
2605
|
* @description The Flake ID of the Subscription associated with the order
|
|
@@ -2616,91 +2616,91 @@ export interface components {
|
|
|
2616
2616
|
* @description The ISO-4217 Currency Code of the order
|
|
2617
2617
|
* @example USD
|
|
2618
2618
|
*/
|
|
2619
|
-
currency
|
|
2619
|
+
currency: string;
|
|
2620
2620
|
/**
|
|
2621
2621
|
* @description Indicates if the order value was inclusive of tax
|
|
2622
2622
|
* @example true
|
|
2623
2623
|
*/
|
|
2624
|
-
tax_inclusive
|
|
2624
|
+
tax_inclusive: boolean;
|
|
2625
2625
|
/**
|
|
2626
2626
|
* @description The tax amount, represented as cents
|
|
2627
2627
|
* @example 1500
|
|
2628
2628
|
*/
|
|
2629
|
-
tax_amount
|
|
2629
|
+
tax_amount: number;
|
|
2630
2630
|
/**
|
|
2631
2631
|
* @description The discount amount, represented as cents
|
|
2632
2632
|
* @example 500
|
|
2633
2633
|
*/
|
|
2634
|
-
discount_amount
|
|
2634
|
+
discount_amount: number;
|
|
2635
2635
|
/**
|
|
2636
2636
|
* @description The subtotal amount, represented as cents
|
|
2637
2637
|
* @example 10000
|
|
2638
2638
|
*/
|
|
2639
|
-
subtotal_amount
|
|
2639
|
+
subtotal_amount: number;
|
|
2640
2640
|
/**
|
|
2641
2641
|
* @description The total amount, represented as cents
|
|
2642
2642
|
* @example 11000
|
|
2643
2643
|
*/
|
|
2644
|
-
total_amount
|
|
2644
|
+
total_amount: number;
|
|
2645
2645
|
/**
|
|
2646
2646
|
* Format: date-time
|
|
2647
2647
|
* @description Indicates when the order was created
|
|
2648
2648
|
* @example 2024-01-15T10:30:00Z
|
|
2649
2649
|
*/
|
|
2650
|
-
created_at
|
|
2650
|
+
created_at: string;
|
|
2651
2651
|
/**
|
|
2652
2652
|
* Format: date-time
|
|
2653
2653
|
* @description Indicates when the order was completed
|
|
2654
2654
|
* @example 2024-01-15T10:35:00Z
|
|
2655
2655
|
*/
|
|
2656
|
-
completed_at
|
|
2656
|
+
completed_at: string;
|
|
2657
2657
|
/**
|
|
2658
2658
|
* @description The billing name of the customer associated with the order
|
|
2659
2659
|
* @example John Doe
|
|
2660
2660
|
*/
|
|
2661
|
-
billing_name
|
|
2661
|
+
billing_name: string;
|
|
2662
2662
|
/**
|
|
2663
2663
|
* @description The billing email address of the customer associated with the order
|
|
2664
2664
|
* @example john@doe.com
|
|
2665
2665
|
*/
|
|
2666
|
-
billing_email
|
|
2666
|
+
billing_email: string;
|
|
2667
2667
|
/**
|
|
2668
2668
|
* @description The ISO-3316 Country Code of the customer associated with the order
|
|
2669
2669
|
* @example US
|
|
2670
2670
|
*/
|
|
2671
|
-
billing_address_country
|
|
2671
|
+
billing_address_country: string;
|
|
2672
2672
|
/**
|
|
2673
2673
|
* @description The IPv4 or IPv6 Address of the associated customer when creating the order
|
|
2674
2674
|
* @example 127.0.0.1/24
|
|
2675
2675
|
*/
|
|
2676
|
-
customer_ip
|
|
2676
|
+
customer_ip: string;
|
|
2677
2677
|
/**
|
|
2678
2678
|
* @description The total amount of giftcard usage associated with the order, represented in cents
|
|
2679
2679
|
* @example 0
|
|
2680
2680
|
*/
|
|
2681
|
-
giftcard_usage_amount
|
|
2681
|
+
giftcard_usage_amount: number;
|
|
2682
2682
|
/** @description The order lines associated with the order */
|
|
2683
|
-
lines
|
|
2683
|
+
lines: components["schemas"]["OrderLineDTO"][];
|
|
2684
2684
|
/**
|
|
2685
2685
|
* @description A comma-seperated string of the names of the product associated with the order
|
|
2686
2686
|
* @example Product A, Product B
|
|
2687
2687
|
*/
|
|
2688
|
-
product_names
|
|
2688
|
+
product_names: string;
|
|
2689
2689
|
/**
|
|
2690
2690
|
* @description A comma-seperated string of the tags of the products associated with the order
|
|
2691
2691
|
* @example ranks, perks
|
|
2692
2692
|
*/
|
|
2693
|
-
product_tags
|
|
2693
|
+
product_tags: string;
|
|
2694
2694
|
/**
|
|
2695
2695
|
* @description A comma-seperated string of the gameservers of the product associated with the order
|
|
2696
2696
|
* @example game server one, game server two
|
|
2697
2697
|
*/
|
|
2698
|
-
product_gameservers
|
|
2698
|
+
product_gameservers: string;
|
|
2699
2699
|
/**
|
|
2700
2700
|
* @description The status of the Order. Possbile options: created, completed, canceled
|
|
2701
2701
|
* @example created
|
|
2702
2702
|
*/
|
|
2703
|
-
status
|
|
2703
|
+
status: string;
|
|
2704
2704
|
};
|
|
2705
2705
|
OrderLineDTO: {
|
|
2706
2706
|
/**
|
|
@@ -2708,28 +2708,28 @@ export interface components {
|
|
|
2708
2708
|
* @description The Flake ID of the Order Line
|
|
2709
2709
|
* @example 411486491630370816
|
|
2710
2710
|
*/
|
|
2711
|
-
id
|
|
2711
|
+
id: string;
|
|
2712
2712
|
/**
|
|
2713
2713
|
* Format: flake-id
|
|
2714
2714
|
* @description The Flake ID of the Checkout Line associated with this Order Line
|
|
2715
2715
|
* @example 411486491630370816
|
|
2716
2716
|
*/
|
|
2717
|
-
checkout_line_id
|
|
2717
|
+
checkout_line_id: string;
|
|
2718
2718
|
/**
|
|
2719
2719
|
* Format: flake-id
|
|
2720
2720
|
* @description The Flake ID of the Product ID associated with this Order Line
|
|
2721
2721
|
* @example 411486491630370816
|
|
2722
2722
|
*/
|
|
2723
|
-
product_id
|
|
2723
|
+
product_id: string;
|
|
2724
2724
|
/**
|
|
2725
2725
|
* Format: flake-id
|
|
2726
2726
|
* @description The Flake ID of the Product Version ID associated with this Order Line
|
|
2727
2727
|
* @example 411486491630370816
|
|
2728
2728
|
*/
|
|
2729
|
-
product_version_id
|
|
2730
|
-
product
|
|
2729
|
+
product_version_id: string;
|
|
2730
|
+
product: components["schemas"]["ProductDTO"];
|
|
2731
2731
|
/** @description The name of the product associated with this Order Line */
|
|
2732
|
-
product_name
|
|
2732
|
+
product_name: string;
|
|
2733
2733
|
/** @description The Image URL of the Product associated with this Order Line */
|
|
2734
2734
|
product_image_url?: null | string;
|
|
2735
2735
|
/**
|
|
@@ -2759,32 +2759,32 @@ export interface components {
|
|
|
2759
2759
|
* @description The price of the Order Line
|
|
2760
2760
|
* @example 1000
|
|
2761
2761
|
*/
|
|
2762
|
-
price
|
|
2762
|
+
price: number;
|
|
2763
2763
|
/**
|
|
2764
2764
|
* @description The quantity of the Order Line
|
|
2765
2765
|
* @example 1
|
|
2766
2766
|
*/
|
|
2767
|
-
quantity
|
|
2767
|
+
quantity: number;
|
|
2768
2768
|
/**
|
|
2769
2769
|
* @description The discount amount of the order line, represented in cents
|
|
2770
2770
|
* @example 0
|
|
2771
2771
|
*/
|
|
2772
|
-
discount_amount
|
|
2772
|
+
discount_amount: number;
|
|
2773
2773
|
/**
|
|
2774
2774
|
* @description The subtotal amount of the order line, represented in cents
|
|
2775
2775
|
* @example 1000
|
|
2776
2776
|
*/
|
|
2777
|
-
subtotal_amount
|
|
2777
|
+
subtotal_amount: number;
|
|
2778
2778
|
/**
|
|
2779
2779
|
* @description The tax amount of the order line, represented in cents
|
|
2780
2780
|
* @example 100
|
|
2781
2781
|
*/
|
|
2782
|
-
tax_amount
|
|
2782
|
+
tax_amount: number;
|
|
2783
2783
|
/**
|
|
2784
2784
|
* @description The total amount of the order line, represented in cents
|
|
2785
2785
|
* @example 1100
|
|
2786
2786
|
*/
|
|
2787
|
-
total_amount
|
|
2787
|
+
total_amount: number;
|
|
2788
2788
|
/**
|
|
2789
2789
|
* Format: flake-id
|
|
2790
2790
|
* @description The Flake ID of which was the selected Game Server ID for the Order Line
|
|
@@ -2797,11 +2797,11 @@ export interface components {
|
|
|
2797
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
2798
|
* @example on_purchase
|
|
2799
2799
|
*/
|
|
2800
|
-
stage
|
|
2800
|
+
stage: string;
|
|
2801
2801
|
/** @description The command to execute */
|
|
2802
|
-
content
|
|
2802
|
+
content: string;
|
|
2803
2803
|
/** @description Indicated if the command should be executed only when the customer is online */
|
|
2804
|
-
online_only
|
|
2804
|
+
online_only: boolean;
|
|
2805
2805
|
};
|
|
2806
2806
|
ProductDTO: {
|
|
2807
2807
|
/**
|
|
@@ -2809,41 +2809,41 @@ export interface components {
|
|
|
2809
2809
|
* @description The Flake ID of the Product
|
|
2810
2810
|
* @example 411486491630370816
|
|
2811
2811
|
*/
|
|
2812
|
-
id
|
|
2812
|
+
id: string;
|
|
2813
2813
|
/**
|
|
2814
2814
|
* Format: flake-id
|
|
2815
2815
|
* @description The Flake ID of the Store
|
|
2816
2816
|
* @example 411486491630370816
|
|
2817
2817
|
*/
|
|
2818
|
-
store_id
|
|
2818
|
+
store_id: string;
|
|
2819
2819
|
/**
|
|
2820
2820
|
* Format: flake-id
|
|
2821
2821
|
* @description The Flake ID of the Version of the Product
|
|
2822
2822
|
* @example 411486491630370816
|
|
2823
2823
|
*/
|
|
2824
|
-
version_id
|
|
2824
|
+
version_id: string;
|
|
2825
2825
|
/** @description The Image URL of the product */
|
|
2826
2826
|
image_url?: null | string;
|
|
2827
2827
|
/** @description The URL-Friendly Slug of the Product */
|
|
2828
|
-
slug
|
|
2828
|
+
slug: string;
|
|
2829
2829
|
/** @description The name of the Product */
|
|
2830
|
-
name
|
|
2830
|
+
name: string;
|
|
2831
2831
|
/** @description The description of the product */
|
|
2832
|
-
description
|
|
2832
|
+
description: string;
|
|
2833
2833
|
/** @description Indicates if the product is enabled. */
|
|
2834
|
-
enabled
|
|
2834
|
+
enabled: boolean;
|
|
2835
2835
|
/** @description The label of the product */
|
|
2836
2836
|
label?: null | string;
|
|
2837
2837
|
/** @description The sort order of the product */
|
|
2838
|
-
sort_order
|
|
2838
|
+
sort_order: number;
|
|
2839
2839
|
/** @description The price of the product, represented in cents. */
|
|
2840
|
-
price
|
|
2840
|
+
price: number;
|
|
2841
2841
|
/** @description Indicates if the customer must select a single game server when purchasing the product */
|
|
2842
|
-
single_game_server_only
|
|
2842
|
+
single_game_server_only: boolean;
|
|
2843
2843
|
/** @description Indicates if one-time purchases are supported on the product */
|
|
2844
|
-
allow_one_time_purchase
|
|
2844
|
+
allow_one_time_purchase: boolean;
|
|
2845
2845
|
/** @description Indicates if subscriptions are supported on the product */
|
|
2846
|
-
allow_subscription
|
|
2846
|
+
allow_subscription: boolean;
|
|
2847
2847
|
/**
|
|
2848
2848
|
* @description The value of the interval in which the product subscription renews at
|
|
2849
2849
|
* @example 1
|
|
@@ -2855,7 +2855,7 @@ export interface components {
|
|
|
2855
2855
|
*/
|
|
2856
2856
|
subscription_interval_scale?: null | string;
|
|
2857
2857
|
/** @description Indicates whether automatic removal is enabled */
|
|
2858
|
-
remove_after_enabled
|
|
2858
|
+
remove_after_enabled: boolean;
|
|
2859
2859
|
/**
|
|
2860
2860
|
* @description The value of the time in which this product should be removed
|
|
2861
2861
|
* @example 1
|
|
@@ -2867,15 +2867,15 @@ export interface components {
|
|
|
2867
2867
|
*/
|
|
2868
2868
|
remove_after_time_scale?: null | string;
|
|
2869
2869
|
/** @description The tags associated with the product */
|
|
2870
|
-
tags
|
|
2870
|
+
tags: components["schemas"]["ProductTagDTO"][];
|
|
2871
2871
|
/** @description A comma-seperated string of all the tags associated with the product */
|
|
2872
|
-
tag_names
|
|
2872
|
+
tag_names: string;
|
|
2873
2873
|
/** @description The game servers associated with the product */
|
|
2874
|
-
gameservers
|
|
2874
|
+
gameservers: components["schemas"]["ProductGameServerDTO"][];
|
|
2875
2875
|
/** @description A comma-seperated string of all the game servers associated with the product */
|
|
2876
|
-
gameserver_names
|
|
2876
|
+
gameserver_names: string;
|
|
2877
2877
|
/** @description The commands associated with the product */
|
|
2878
|
-
commands
|
|
2878
|
+
commands: components["schemas"]["ProductCommandDTO"][];
|
|
2879
2879
|
/**
|
|
2880
2880
|
* Format: date-time
|
|
2881
2881
|
* @description When the product was created
|
|
@@ -2887,7 +2887,7 @@ export interface components {
|
|
|
2887
2887
|
*/
|
|
2888
2888
|
updated_at?: null | string;
|
|
2889
2889
|
/** @description The metadata of the product */
|
|
2890
|
-
metadata
|
|
2890
|
+
metadata: {
|
|
2891
2891
|
[key: string]: string;
|
|
2892
2892
|
};
|
|
2893
2893
|
};
|
|
@@ -2897,11 +2897,11 @@ export interface components {
|
|
|
2897
2897
|
* @description The ID of the Game Server
|
|
2898
2898
|
* @example 411486491630370816
|
|
2899
2899
|
*/
|
|
2900
|
-
id
|
|
2900
|
+
id: string;
|
|
2901
2901
|
/** @description The name of the Game Server */
|
|
2902
|
-
name
|
|
2902
|
+
name: string;
|
|
2903
2903
|
/** @description Indicates if the Game Server is enabled */
|
|
2904
|
-
enabled
|
|
2904
|
+
enabled: boolean;
|
|
2905
2905
|
};
|
|
2906
2906
|
ProductTagDTO: {
|
|
2907
2907
|
/**
|
|
@@ -2909,25 +2909,25 @@ export interface components {
|
|
|
2909
2909
|
* @description The Flake ID of the Product Tag
|
|
2910
2910
|
* @example 411486491630370816
|
|
2911
2911
|
*/
|
|
2912
|
-
id
|
|
2912
|
+
id: string;
|
|
2913
2913
|
/** @description The URL-Friendly slug of the Product Tag */
|
|
2914
|
-
slug
|
|
2914
|
+
slug: string;
|
|
2915
2915
|
/** @description The name of the Product Tag */
|
|
2916
|
-
name
|
|
2916
|
+
name: string;
|
|
2917
2917
|
};
|
|
2918
2918
|
SteamCustomerDTO: {
|
|
2919
2919
|
/**
|
|
2920
2920
|
* @description SteamID64
|
|
2921
2921
|
* @example 76561197960287930
|
|
2922
2922
|
*/
|
|
2923
|
-
id
|
|
2923
|
+
id: string;
|
|
2924
2924
|
/**
|
|
2925
2925
|
* @description The name on the Steam Profile
|
|
2926
2926
|
* @example John
|
|
2927
2927
|
*/
|
|
2928
|
-
name
|
|
2928
|
+
name: string;
|
|
2929
2929
|
/** @description The Steam Avatar URL */
|
|
2930
|
-
avatar_url
|
|
2930
|
+
avatar_url: string;
|
|
2931
2931
|
};
|
|
2932
2932
|
/**
|
|
2933
2933
|
* @description The type of webhook event
|