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