@paynow-gg/typescript-sdk 1.0.53 → 1.0.55
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/generated/management.d.ts +546 -91
- package/dist/generated/management.d.ts.map +1 -1
- package/dist/generated/management.js +8 -0
- package/dist/generated/management.js.map +1 -1
- package/dist/generated/storefront.d.ts +1258 -79
- package/dist/generated/storefront.d.ts.map +1 -1
- package/dist/generated/storefront.js +16 -4
- package/dist/generated/storefront.js.map +1 -1
- package/dist/generated/webhooks.d.ts +494 -264
- package/dist/generated/webhooks.d.ts.map +1 -1
- package/dist/generated/webhooks.js.map +1 -1
- package/package.json +1 -1
|
@@ -1,238 +1,5 @@
|
|
|
1
1
|
export type paths = Record<string, never>;
|
|
2
2
|
export interface webhooks {
|
|
3
|
-
ON_SUBSCRIPTION_RENEWED: {
|
|
4
|
-
parameters: {
|
|
5
|
-
query?: never;
|
|
6
|
-
header?: never;
|
|
7
|
-
path?: never;
|
|
8
|
-
cookie?: never;
|
|
9
|
-
};
|
|
10
|
-
get?: never;
|
|
11
|
-
put?: never;
|
|
12
|
-
/**
|
|
13
|
-
* Triggered when a subscription is renewed
|
|
14
|
-
* @description Webhook for ON_SUBSCRIPTION_RENEWED
|
|
15
|
-
*/
|
|
16
|
-
post: {
|
|
17
|
-
parameters: {
|
|
18
|
-
query?: never;
|
|
19
|
-
header?: never;
|
|
20
|
-
path?: never;
|
|
21
|
-
cookie?: never;
|
|
22
|
-
};
|
|
23
|
-
requestBody: {
|
|
24
|
-
content: {
|
|
25
|
-
"application/json": {
|
|
26
|
-
/**
|
|
27
|
-
* @description The type of webhook event
|
|
28
|
-
* @example ON_SUBSCRIPTION_RENEWED
|
|
29
|
-
*/
|
|
30
|
-
event_type: components["schemas"]["WebhookEventType"];
|
|
31
|
-
/**
|
|
32
|
-
* Format: flake-id
|
|
33
|
-
* @description The ID of the Webhook Event
|
|
34
|
-
* @example 411486491630370816
|
|
35
|
-
*/
|
|
36
|
-
event_id: string;
|
|
37
|
-
body: {
|
|
38
|
-
/**
|
|
39
|
-
* Format: flake-id
|
|
40
|
-
* @description The Flake ID of the Subscription
|
|
41
|
-
* @example 411486491630370816
|
|
42
|
-
*/
|
|
43
|
-
id: string;
|
|
44
|
-
/**
|
|
45
|
-
* Format: flake-id
|
|
46
|
-
* @description The Flake ID of the Store associated with the Subscription
|
|
47
|
-
* @example 411486491630370816
|
|
48
|
-
*/
|
|
49
|
-
store_id: string;
|
|
50
|
-
/**
|
|
51
|
-
* Format: flake-id
|
|
52
|
-
* @description The Flake ID of the Customer associated with the Subscription
|
|
53
|
-
* @example 411486491630370816
|
|
54
|
-
*/
|
|
55
|
-
customer_id: string;
|
|
56
|
-
customer: components["schemas"]["CustomerDTO"];
|
|
57
|
-
checkout: components["schemas"]["CheckoutDTO"];
|
|
58
|
-
/**
|
|
59
|
-
* @description The current billing cycle number
|
|
60
|
-
* @example 2
|
|
61
|
-
*/
|
|
62
|
-
billing_cycle_sequence: number;
|
|
63
|
-
/**
|
|
64
|
-
* @description The billing email address of the customer associated with the Subscription
|
|
65
|
-
* @example john@doe.com
|
|
66
|
-
*/
|
|
67
|
-
billing_email: string;
|
|
68
|
-
/**
|
|
69
|
-
* @description The subtotal amount of the Subscription represented in cents
|
|
70
|
-
* @example 8999
|
|
71
|
-
*/
|
|
72
|
-
subtotal_amount: number;
|
|
73
|
-
/**
|
|
74
|
-
* @description The tax amount of the Subscription represented in cents
|
|
75
|
-
* @example 1350
|
|
76
|
-
*/
|
|
77
|
-
tax_amount: number;
|
|
78
|
-
/**
|
|
79
|
-
* @description The discount amount applied to the Subscription represented in cents
|
|
80
|
-
* @example 0
|
|
81
|
-
*/
|
|
82
|
-
discount_amount: number;
|
|
83
|
-
/**
|
|
84
|
-
* @description The total amount of the Subscription represented in cents
|
|
85
|
-
* @example 10349
|
|
86
|
-
*/
|
|
87
|
-
total_amount: number;
|
|
88
|
-
/**
|
|
89
|
-
* @description The currency code of the Subscription
|
|
90
|
-
* @example USD
|
|
91
|
-
*/
|
|
92
|
-
currency: string;
|
|
93
|
-
/**
|
|
94
|
-
* @description The interval value of the billing cycle
|
|
95
|
-
* @example 1
|
|
96
|
-
*/
|
|
97
|
-
interval_value: number;
|
|
98
|
-
/**
|
|
99
|
-
* @description The interval scale of the billing cycle
|
|
100
|
-
* @example month
|
|
101
|
-
*/
|
|
102
|
-
interval_scale: string;
|
|
103
|
-
/**
|
|
104
|
-
* Format: flake-id
|
|
105
|
-
* @description The Flake ID of the Product associated with the Subscription
|
|
106
|
-
* @example 411486491630370816
|
|
107
|
-
*/
|
|
108
|
-
product_id: string;
|
|
109
|
-
/**
|
|
110
|
-
* Format: flake-id
|
|
111
|
-
* @description The Flake ID of the Product Version associated with the Subscription
|
|
112
|
-
* @example 411486491630370816
|
|
113
|
-
*/
|
|
114
|
-
product_version_id: string;
|
|
115
|
-
/**
|
|
116
|
-
* @description The name of the Product associated with the Subscription
|
|
117
|
-
* @example Example Product
|
|
118
|
-
*/
|
|
119
|
-
product_name: string;
|
|
120
|
-
/**
|
|
121
|
-
* @description The image URL of the Product associated with the Subscription
|
|
122
|
-
* @example https://example.com/biz.jpg
|
|
123
|
-
*/
|
|
124
|
-
product_image_url?: null | string;
|
|
125
|
-
product: components["schemas"]["ProductDTO"];
|
|
126
|
-
/**
|
|
127
|
-
* @description The ISO-3166 country code of customer associated with the Subscription
|
|
128
|
-
* @example US
|
|
129
|
-
*/
|
|
130
|
-
billing_country: string;
|
|
131
|
-
/**
|
|
132
|
-
* @description The initial subtotal amount of the Subscription represented in cents
|
|
133
|
-
* @example 8999
|
|
134
|
-
*/
|
|
135
|
-
initial_subtotal_amount: number;
|
|
136
|
-
/**
|
|
137
|
-
* @description The initial tax amount of the Subscription represented in cents
|
|
138
|
-
* @example 1350
|
|
139
|
-
*/
|
|
140
|
-
initial_tax_amount: number;
|
|
141
|
-
/**
|
|
142
|
-
* @description The initial discount amount applied to the Subscription represented in cents
|
|
143
|
-
* @example 1500
|
|
144
|
-
*/
|
|
145
|
-
initial_discount_amount: number;
|
|
146
|
-
/**
|
|
147
|
-
* @description The initial gift card usage amount applied to the Subscription represented in cents
|
|
148
|
-
* @example 0
|
|
149
|
-
*/
|
|
150
|
-
initial_giftcard_usage_amount: number;
|
|
151
|
-
/**
|
|
152
|
-
* @description The initial total amount of the Subscription represented in cents
|
|
153
|
-
* @example 8849
|
|
154
|
-
*/
|
|
155
|
-
initial_total_amount: number;
|
|
156
|
-
/**
|
|
157
|
-
* @description The IP address of the Customer
|
|
158
|
-
* @example 127.0.0.1/24
|
|
159
|
-
*/
|
|
160
|
-
customer_ip: string;
|
|
161
|
-
/**
|
|
162
|
-
* Format: date-time
|
|
163
|
-
* @description The start date of the current billing period
|
|
164
|
-
* @example 2024-03-01T00:00:00Z
|
|
165
|
-
*/
|
|
166
|
-
current_period_start?: null | string;
|
|
167
|
-
/**
|
|
168
|
-
* Format: date-time
|
|
169
|
-
* @description The end date of the current billing period
|
|
170
|
-
* @example 2024-06-01T00:00:00Z
|
|
171
|
-
*/
|
|
172
|
-
current_period_end?: null | string;
|
|
173
|
-
/**
|
|
174
|
-
* Format: date-time
|
|
175
|
-
* @description The date and time when the Subscription was created
|
|
176
|
-
* @example 2024-03-01T11:00:00Z
|
|
177
|
-
*/
|
|
178
|
-
created_at?: null | string;
|
|
179
|
-
/**
|
|
180
|
-
* Format: date-time
|
|
181
|
-
* @description Indicates when the subscription was active
|
|
182
|
-
* @example 2024-03-01T11:05:00Z
|
|
183
|
-
*/
|
|
184
|
-
active_at?: null | string;
|
|
185
|
-
/**
|
|
186
|
-
* Format: flake-id
|
|
187
|
-
* @description The Flake ID of the Checkout associated with the Subscription
|
|
188
|
-
* @example 411486491630370816
|
|
189
|
-
*/
|
|
190
|
-
checkout_id: string;
|
|
191
|
-
/**
|
|
192
|
-
* Format: flake-id
|
|
193
|
-
* @description The Flake ID of the Checkout Line associated with the Subscription
|
|
194
|
-
* @example 411486491630370816
|
|
195
|
-
*/
|
|
196
|
-
checkout_line_id: string;
|
|
197
|
-
/**
|
|
198
|
-
* @description The current status of the Subscription. Possible options: created, active, canceled
|
|
199
|
-
* @example created
|
|
200
|
-
*/
|
|
201
|
-
status: string;
|
|
202
|
-
};
|
|
203
|
-
};
|
|
204
|
-
};
|
|
205
|
-
};
|
|
206
|
-
responses: {
|
|
207
|
-
/** @description Webhook processed successfully */
|
|
208
|
-
200: {
|
|
209
|
-
headers: {
|
|
210
|
-
[name: string]: unknown;
|
|
211
|
-
};
|
|
212
|
-
content?: never;
|
|
213
|
-
};
|
|
214
|
-
/** @description Bad request */
|
|
215
|
-
400: {
|
|
216
|
-
headers: {
|
|
217
|
-
[name: string]: unknown;
|
|
218
|
-
};
|
|
219
|
-
content?: never;
|
|
220
|
-
};
|
|
221
|
-
/** @description Internal server error */
|
|
222
|
-
500: {
|
|
223
|
-
headers: {
|
|
224
|
-
[name: string]: unknown;
|
|
225
|
-
};
|
|
226
|
-
content?: never;
|
|
227
|
-
};
|
|
228
|
-
};
|
|
229
|
-
};
|
|
230
|
-
delete?: never;
|
|
231
|
-
options?: never;
|
|
232
|
-
head?: never;
|
|
233
|
-
patch?: never;
|
|
234
|
-
trace?: never;
|
|
235
|
-
};
|
|
236
3
|
ON_CHARGEBACK: {
|
|
237
4
|
parameters: {
|
|
238
5
|
query?: never;
|
|
@@ -1720,12 +1487,21 @@ export interface webhooks {
|
|
|
1720
1487
|
* @example 411486491630370816
|
|
1721
1488
|
*/
|
|
1722
1489
|
subscription_id?: null | string;
|
|
1490
|
+
/** @description Applied coupons to this order */
|
|
1491
|
+
applied_coupons: components["schemas"]["OrderCouponUsageDTO"][];
|
|
1492
|
+
/** @description Applied gift cards to this order */
|
|
1493
|
+
applied_giftcards: components["schemas"]["OrderGiftCardUsageDTO"][];
|
|
1723
1494
|
/**
|
|
1724
1495
|
* Format: flake-id
|
|
1725
1496
|
* @description The Flake ID of the Coupon associated with the order
|
|
1726
1497
|
* @example 411486491630370816
|
|
1727
1498
|
*/
|
|
1728
|
-
coupon_id
|
|
1499
|
+
coupon_id: string;
|
|
1500
|
+
/**
|
|
1501
|
+
* @description The type of the order
|
|
1502
|
+
* @example one_time
|
|
1503
|
+
*/
|
|
1504
|
+
type: string;
|
|
1729
1505
|
/**
|
|
1730
1506
|
* @description The ISO-4217 Currency Code of the order
|
|
1731
1507
|
* @example USD
|
|
@@ -2143,7 +1919,7 @@ export interface webhooks {
|
|
|
2143
1919
|
product_image_url?: null | string;
|
|
2144
1920
|
product: components["schemas"]["ProductDTO"];
|
|
2145
1921
|
/**
|
|
2146
|
-
* @description The ISO-3166 Country Code of customer associated with the Subscription
|
|
1922
|
+
* @description The ISO-3166 Country Code of the customer associated with the Subscription
|
|
2147
1923
|
* @example US
|
|
2148
1924
|
*/
|
|
2149
1925
|
billing_country: string;
|
|
@@ -2214,10 +1990,12 @@ export interface webhooks {
|
|
|
2214
1990
|
*/
|
|
2215
1991
|
checkout_line_id: string;
|
|
2216
1992
|
/**
|
|
2217
|
-
* @description The current status of the Subscription.
|
|
1993
|
+
* @description The current status of the Subscription. Possible options: created, active, canceled
|
|
2218
1994
|
* @example created
|
|
2219
1995
|
*/
|
|
2220
1996
|
status: string;
|
|
1997
|
+
/** @description The lines of the Subscription */
|
|
1998
|
+
lines: components["schemas"]["SubscriptionLineDTO"][];
|
|
2221
1999
|
};
|
|
2222
2000
|
};
|
|
2223
2001
|
};
|
|
@@ -2287,6 +2065,17 @@ export interface webhooks {
|
|
|
2287
2065
|
*/
|
|
2288
2066
|
event_id: string;
|
|
2289
2067
|
body: {
|
|
2068
|
+
/**
|
|
2069
|
+
* Format: date-time
|
|
2070
|
+
* @description Indicates when the subscription was canceled
|
|
2071
|
+
* @example 2024-05-15T14:20:00Z
|
|
2072
|
+
*/
|
|
2073
|
+
canceled_at?: null | string;
|
|
2074
|
+
/**
|
|
2075
|
+
* @description The reason for the subscription cancellation
|
|
2076
|
+
* @example customer_request
|
|
2077
|
+
*/
|
|
2078
|
+
cancel_reason?: null | string;
|
|
2290
2079
|
/**
|
|
2291
2080
|
* Format: flake-id
|
|
2292
2081
|
* @description The Flake ID of the Subscription
|
|
@@ -2314,27 +2103,27 @@ export interface webhooks {
|
|
|
2314
2103
|
billing_cycle_sequence: number;
|
|
2315
2104
|
/**
|
|
2316
2105
|
* @description The billing email address of the customer associated with the Subscription
|
|
2317
|
-
* @example
|
|
2106
|
+
* @example john@doe.com
|
|
2318
2107
|
*/
|
|
2319
2108
|
billing_email: string;
|
|
2320
2109
|
/**
|
|
2321
2110
|
* @description The subtotal amount of the Subscription represented in cents
|
|
2322
|
-
* @example
|
|
2111
|
+
* @example 9999
|
|
2323
2112
|
*/
|
|
2324
2113
|
subtotal_amount: number;
|
|
2325
2114
|
/**
|
|
2326
2115
|
* @description The tax amount of the Subscription represented in cents
|
|
2327
|
-
* @example
|
|
2116
|
+
* @example 1500
|
|
2328
2117
|
*/
|
|
2329
2118
|
tax_amount: number;
|
|
2330
2119
|
/**
|
|
2331
2120
|
* @description The discount amount applied to the Subscription represented in cents
|
|
2332
|
-
* @example
|
|
2121
|
+
* @example 1000
|
|
2333
2122
|
*/
|
|
2334
2123
|
discount_amount: number;
|
|
2335
2124
|
/**
|
|
2336
2125
|
* @description The total amount of the Subscription represented in cents
|
|
2337
|
-
* @example
|
|
2126
|
+
* @example 10499
|
|
2338
2127
|
*/
|
|
2339
2128
|
total_amount: number;
|
|
2340
2129
|
/**
|
|
@@ -2349,7 +2138,7 @@ export interface webhooks {
|
|
|
2349
2138
|
interval_value: number;
|
|
2350
2139
|
/**
|
|
2351
2140
|
* @description The interval scale of the billing cycle
|
|
2352
|
-
* @example
|
|
2141
|
+
* @example month
|
|
2353
2142
|
*/
|
|
2354
2143
|
interval_scale: string;
|
|
2355
2144
|
/**
|
|
@@ -2366,33 +2155,33 @@ export interface webhooks {
|
|
|
2366
2155
|
product_version_id: string;
|
|
2367
2156
|
/**
|
|
2368
2157
|
* @description The name of the Product associated with the Subscription
|
|
2369
|
-
* @example
|
|
2158
|
+
* @example Example Product
|
|
2370
2159
|
*/
|
|
2371
2160
|
product_name: string;
|
|
2372
2161
|
/**
|
|
2373
2162
|
* @description The image URL of the Product associated with the Subscription
|
|
2374
|
-
* @example https://example.com/
|
|
2163
|
+
* @example https://example.com/image.jpg
|
|
2375
2164
|
*/
|
|
2376
2165
|
product_image_url?: null | string;
|
|
2377
2166
|
product: components["schemas"]["ProductDTO"];
|
|
2378
2167
|
/**
|
|
2379
|
-
* @description The ISO-3166
|
|
2168
|
+
* @description The ISO-3166 Country Code of the customer associated with the Subscription
|
|
2380
2169
|
* @example US
|
|
2381
2170
|
*/
|
|
2382
2171
|
billing_country: string;
|
|
2383
2172
|
/**
|
|
2384
2173
|
* @description The initial subtotal amount of the Subscription represented in cents
|
|
2385
|
-
* @example
|
|
2174
|
+
* @example 9999
|
|
2386
2175
|
*/
|
|
2387
2176
|
initial_subtotal_amount: number;
|
|
2388
2177
|
/**
|
|
2389
2178
|
* @description The initial tax amount of the Subscription represented in cents
|
|
2390
|
-
* @example
|
|
2179
|
+
* @example 1500
|
|
2391
2180
|
*/
|
|
2392
2181
|
initial_tax_amount: number;
|
|
2393
2182
|
/**
|
|
2394
2183
|
* @description The initial discount amount applied to the Subscription represented in cents
|
|
2395
|
-
* @example
|
|
2184
|
+
* @example 2000
|
|
2396
2185
|
*/
|
|
2397
2186
|
initial_discount_amount: number;
|
|
2398
2187
|
/**
|
|
@@ -2402,7 +2191,7 @@ export interface webhooks {
|
|
|
2402
2191
|
initial_giftcard_usage_amount: number;
|
|
2403
2192
|
/**
|
|
2404
2193
|
* @description The initial total amount of the Subscription represented in cents
|
|
2405
|
-
* @example
|
|
2194
|
+
* @example 9499
|
|
2406
2195
|
*/
|
|
2407
2196
|
initial_total_amount: number;
|
|
2408
2197
|
/**
|
|
@@ -2413,38 +2202,262 @@ export interface webhooks {
|
|
|
2413
2202
|
/**
|
|
2414
2203
|
* Format: date-time
|
|
2415
2204
|
* @description The start date of the current billing period
|
|
2416
|
-
* @example 2024-
|
|
2205
|
+
* @example 2024-02-01T00:00:00Z
|
|
2417
2206
|
*/
|
|
2418
2207
|
current_period_start?: null | string;
|
|
2419
2208
|
/**
|
|
2420
2209
|
* Format: date-time
|
|
2421
2210
|
* @description The end date of the current billing period
|
|
2422
|
-
* @example
|
|
2211
|
+
* @example 2024-03-01T00:00:00Z
|
|
2423
2212
|
*/
|
|
2424
2213
|
current_period_end?: null | string;
|
|
2425
2214
|
/**
|
|
2426
2215
|
* Format: date-time
|
|
2427
2216
|
* @description The date and time when the Subscription was created
|
|
2428
|
-
* @example 2024-
|
|
2217
|
+
* @example 2024-02-01T10:15:00Z
|
|
2429
2218
|
*/
|
|
2430
2219
|
created_at?: null | string;
|
|
2431
2220
|
/**
|
|
2432
2221
|
* Format: date-time
|
|
2433
2222
|
* @description Indicates when the subscription was active
|
|
2434
|
-
* @example 2024-
|
|
2223
|
+
* @example 2024-02-01T10:20:00Z
|
|
2435
2224
|
*/
|
|
2436
2225
|
active_at?: null | string;
|
|
2437
2226
|
/**
|
|
2438
|
-
* Format:
|
|
2439
|
-
* @description
|
|
2440
|
-
* @example
|
|
2441
|
-
*/
|
|
2442
|
-
|
|
2227
|
+
* Format: flake-id
|
|
2228
|
+
* @description The Flake ID of the Checkout associated with the Subscription
|
|
2229
|
+
* @example 411486491630370816
|
|
2230
|
+
*/
|
|
2231
|
+
checkout_id: string;
|
|
2443
2232
|
/**
|
|
2444
|
-
*
|
|
2445
|
-
* @
|
|
2233
|
+
* Format: flake-id
|
|
2234
|
+
* @description The Flake ID of the Checkout Line associated with the Subscription
|
|
2235
|
+
* @example 411486491630370816
|
|
2446
2236
|
*/
|
|
2447
|
-
|
|
2237
|
+
checkout_line_id: string;
|
|
2238
|
+
/**
|
|
2239
|
+
* @description The current status of the Subscription. Possible options: created, active, canceled
|
|
2240
|
+
* @example created
|
|
2241
|
+
*/
|
|
2242
|
+
status: string;
|
|
2243
|
+
/** @description The lines of the Subscription */
|
|
2244
|
+
lines: components["schemas"]["SubscriptionLineDTO"][];
|
|
2245
|
+
};
|
|
2246
|
+
};
|
|
2247
|
+
};
|
|
2248
|
+
};
|
|
2249
|
+
responses: {
|
|
2250
|
+
/** @description Webhook processed successfully */
|
|
2251
|
+
200: {
|
|
2252
|
+
headers: {
|
|
2253
|
+
[name: string]: unknown;
|
|
2254
|
+
};
|
|
2255
|
+
content?: never;
|
|
2256
|
+
};
|
|
2257
|
+
/** @description Bad request */
|
|
2258
|
+
400: {
|
|
2259
|
+
headers: {
|
|
2260
|
+
[name: string]: unknown;
|
|
2261
|
+
};
|
|
2262
|
+
content?: never;
|
|
2263
|
+
};
|
|
2264
|
+
/** @description Internal server error */
|
|
2265
|
+
500: {
|
|
2266
|
+
headers: {
|
|
2267
|
+
[name: string]: unknown;
|
|
2268
|
+
};
|
|
2269
|
+
content?: never;
|
|
2270
|
+
};
|
|
2271
|
+
};
|
|
2272
|
+
};
|
|
2273
|
+
delete?: never;
|
|
2274
|
+
options?: never;
|
|
2275
|
+
head?: never;
|
|
2276
|
+
patch?: never;
|
|
2277
|
+
trace?: never;
|
|
2278
|
+
};
|
|
2279
|
+
ON_SUBSCRIPTION_RENEWED: {
|
|
2280
|
+
parameters: {
|
|
2281
|
+
query?: never;
|
|
2282
|
+
header?: never;
|
|
2283
|
+
path?: never;
|
|
2284
|
+
cookie?: never;
|
|
2285
|
+
};
|
|
2286
|
+
get?: never;
|
|
2287
|
+
put?: never;
|
|
2288
|
+
/**
|
|
2289
|
+
* Triggered when a subscription is renewed
|
|
2290
|
+
* @description Webhook for ON_SUBSCRIPTION_RENEWED
|
|
2291
|
+
*/
|
|
2292
|
+
post: {
|
|
2293
|
+
parameters: {
|
|
2294
|
+
query?: never;
|
|
2295
|
+
header?: never;
|
|
2296
|
+
path?: never;
|
|
2297
|
+
cookie?: never;
|
|
2298
|
+
};
|
|
2299
|
+
requestBody: {
|
|
2300
|
+
content: {
|
|
2301
|
+
"application/json": {
|
|
2302
|
+
/**
|
|
2303
|
+
* @description The type of webhook event
|
|
2304
|
+
* @example ON_SUBSCRIPTION_RENEWED
|
|
2305
|
+
*/
|
|
2306
|
+
event_type: components["schemas"]["WebhookEventType"];
|
|
2307
|
+
/**
|
|
2308
|
+
* Format: flake-id
|
|
2309
|
+
* @description The ID of the Webhook Event
|
|
2310
|
+
* @example 411486491630370816
|
|
2311
|
+
*/
|
|
2312
|
+
event_id: string;
|
|
2313
|
+
body: {
|
|
2314
|
+
/**
|
|
2315
|
+
* Format: flake-id
|
|
2316
|
+
* @description The Flake ID of the Subscription
|
|
2317
|
+
* @example 411486491630370816
|
|
2318
|
+
*/
|
|
2319
|
+
id: string;
|
|
2320
|
+
/**
|
|
2321
|
+
* Format: flake-id
|
|
2322
|
+
* @description The Flake ID of the Store associated with the Subscription
|
|
2323
|
+
* @example 411486491630370816
|
|
2324
|
+
*/
|
|
2325
|
+
store_id: string;
|
|
2326
|
+
/**
|
|
2327
|
+
* Format: flake-id
|
|
2328
|
+
* @description The Flake ID of the Customer associated with the Subscription
|
|
2329
|
+
* @example 411486491630370816
|
|
2330
|
+
*/
|
|
2331
|
+
customer_id: string;
|
|
2332
|
+
customer: components["schemas"]["CustomerDTO"];
|
|
2333
|
+
checkout: components["schemas"]["CheckoutDTO"];
|
|
2334
|
+
/**
|
|
2335
|
+
* @description The current billing cycle number
|
|
2336
|
+
* @example 1
|
|
2337
|
+
*/
|
|
2338
|
+
billing_cycle_sequence: number;
|
|
2339
|
+
/**
|
|
2340
|
+
* @description The billing email address of the customer associated with the Subscription
|
|
2341
|
+
* @example john@doe.com
|
|
2342
|
+
*/
|
|
2343
|
+
billing_email: string;
|
|
2344
|
+
/**
|
|
2345
|
+
* @description The subtotal amount of the Subscription represented in cents
|
|
2346
|
+
* @example 9999
|
|
2347
|
+
*/
|
|
2348
|
+
subtotal_amount: number;
|
|
2349
|
+
/**
|
|
2350
|
+
* @description The tax amount of the Subscription represented in cents
|
|
2351
|
+
* @example 1500
|
|
2352
|
+
*/
|
|
2353
|
+
tax_amount: number;
|
|
2354
|
+
/**
|
|
2355
|
+
* @description The discount amount applied to the Subscription represented in cents
|
|
2356
|
+
* @example 1000
|
|
2357
|
+
*/
|
|
2358
|
+
discount_amount: number;
|
|
2359
|
+
/**
|
|
2360
|
+
* @description The total amount of the Subscription represented in cents
|
|
2361
|
+
* @example 10499
|
|
2362
|
+
*/
|
|
2363
|
+
total_amount: number;
|
|
2364
|
+
/**
|
|
2365
|
+
* @description The currency code of the Subscription
|
|
2366
|
+
* @example USD
|
|
2367
|
+
*/
|
|
2368
|
+
currency: string;
|
|
2369
|
+
/**
|
|
2370
|
+
* @description The interval value of the billing cycle
|
|
2371
|
+
* @example 1
|
|
2372
|
+
*/
|
|
2373
|
+
interval_value: number;
|
|
2374
|
+
/**
|
|
2375
|
+
* @description The interval scale of the billing cycle
|
|
2376
|
+
* @example month
|
|
2377
|
+
*/
|
|
2378
|
+
interval_scale: string;
|
|
2379
|
+
/**
|
|
2380
|
+
* Format: flake-id
|
|
2381
|
+
* @description The Flake ID of the Product associated with the Subscription
|
|
2382
|
+
* @example 411486491630370816
|
|
2383
|
+
*/
|
|
2384
|
+
product_id: string;
|
|
2385
|
+
/**
|
|
2386
|
+
* Format: flake-id
|
|
2387
|
+
* @description The Flake ID of the Product Version associated with the Subscription
|
|
2388
|
+
* @example 411486491630370816
|
|
2389
|
+
*/
|
|
2390
|
+
product_version_id: string;
|
|
2391
|
+
/**
|
|
2392
|
+
* @description The name of the Product associated with the Subscription
|
|
2393
|
+
* @example Example Product
|
|
2394
|
+
*/
|
|
2395
|
+
product_name: string;
|
|
2396
|
+
/**
|
|
2397
|
+
* @description The image URL of the Product associated with the Subscription
|
|
2398
|
+
* @example https://example.com/image.jpg
|
|
2399
|
+
*/
|
|
2400
|
+
product_image_url?: null | string;
|
|
2401
|
+
product: components["schemas"]["ProductDTO"];
|
|
2402
|
+
/**
|
|
2403
|
+
* @description The ISO-3166 Country Code of the customer associated with the Subscription
|
|
2404
|
+
* @example US
|
|
2405
|
+
*/
|
|
2406
|
+
billing_country: string;
|
|
2407
|
+
/**
|
|
2408
|
+
* @description The initial subtotal amount of the Subscription represented in cents
|
|
2409
|
+
* @example 9999
|
|
2410
|
+
*/
|
|
2411
|
+
initial_subtotal_amount: number;
|
|
2412
|
+
/**
|
|
2413
|
+
* @description The initial tax amount of the Subscription represented in cents
|
|
2414
|
+
* @example 1500
|
|
2415
|
+
*/
|
|
2416
|
+
initial_tax_amount: number;
|
|
2417
|
+
/**
|
|
2418
|
+
* @description The initial discount amount applied to the Subscription represented in cents
|
|
2419
|
+
* @example 2000
|
|
2420
|
+
*/
|
|
2421
|
+
initial_discount_amount: number;
|
|
2422
|
+
/**
|
|
2423
|
+
* @description The initial gift card usage amount applied to the Subscription represented in cents
|
|
2424
|
+
* @example 0
|
|
2425
|
+
*/
|
|
2426
|
+
initial_giftcard_usage_amount: number;
|
|
2427
|
+
/**
|
|
2428
|
+
* @description The initial total amount of the Subscription represented in cents
|
|
2429
|
+
* @example 9499
|
|
2430
|
+
*/
|
|
2431
|
+
initial_total_amount: number;
|
|
2432
|
+
/**
|
|
2433
|
+
* @description The IP address of the Customer
|
|
2434
|
+
* @example 127.0.0.1/24
|
|
2435
|
+
*/
|
|
2436
|
+
customer_ip: string;
|
|
2437
|
+
/**
|
|
2438
|
+
* Format: date-time
|
|
2439
|
+
* @description The start date of the current billing period
|
|
2440
|
+
* @example 2024-02-01T00:00:00Z
|
|
2441
|
+
*/
|
|
2442
|
+
current_period_start?: null | string;
|
|
2443
|
+
/**
|
|
2444
|
+
* Format: date-time
|
|
2445
|
+
* @description The end date of the current billing period
|
|
2446
|
+
* @example 2024-03-01T00:00:00Z
|
|
2447
|
+
*/
|
|
2448
|
+
current_period_end?: null | string;
|
|
2449
|
+
/**
|
|
2450
|
+
* Format: date-time
|
|
2451
|
+
* @description The date and time when the Subscription was created
|
|
2452
|
+
* @example 2024-02-01T10:15:00Z
|
|
2453
|
+
*/
|
|
2454
|
+
created_at?: null | string;
|
|
2455
|
+
/**
|
|
2456
|
+
* Format: date-time
|
|
2457
|
+
* @description Indicates when the subscription was active
|
|
2458
|
+
* @example 2024-02-01T10:20:00Z
|
|
2459
|
+
*/
|
|
2460
|
+
active_at?: null | string;
|
|
2448
2461
|
/**
|
|
2449
2462
|
* Format: flake-id
|
|
2450
2463
|
* @description The Flake ID of the Checkout associated with the Subscription
|
|
@@ -2458,10 +2471,12 @@ export interface webhooks {
|
|
|
2458
2471
|
*/
|
|
2459
2472
|
checkout_line_id: string;
|
|
2460
2473
|
/**
|
|
2461
|
-
* @description The current status of the Subscription.
|
|
2474
|
+
* @description The current status of the Subscription. Possible options: created, active, canceled
|
|
2462
2475
|
* @example created
|
|
2463
2476
|
*/
|
|
2464
2477
|
status: string;
|
|
2478
|
+
/** @description The lines of the Subscription */
|
|
2479
|
+
lines: components["schemas"]["SubscriptionLineDTO"][];
|
|
2465
2480
|
};
|
|
2466
2481
|
};
|
|
2467
2482
|
};
|
|
@@ -3061,6 +3076,14 @@ export interface components {
|
|
|
3061
3076
|
name: string;
|
|
3062
3077
|
avatar_url: string;
|
|
3063
3078
|
};
|
|
3079
|
+
OrderCouponUsageDTO: {
|
|
3080
|
+
/**
|
|
3081
|
+
* Format: flake-id
|
|
3082
|
+
* @example 411486491630370816
|
|
3083
|
+
*/
|
|
3084
|
+
coupon_id: string;
|
|
3085
|
+
usage_amount: number;
|
|
3086
|
+
};
|
|
3064
3087
|
OrderDTO: {
|
|
3065
3088
|
/**
|
|
3066
3089
|
* Format: flake-id
|
|
@@ -3088,12 +3111,21 @@ export interface components {
|
|
|
3088
3111
|
* @example 411486491630370816
|
|
3089
3112
|
*/
|
|
3090
3113
|
subscription_id?: null | string;
|
|
3114
|
+
/** @description Applied coupons to this order */
|
|
3115
|
+
applied_coupons: components["schemas"]["OrderCouponUsageDTO"][];
|
|
3116
|
+
/** @description Applied gift cards to this order */
|
|
3117
|
+
applied_giftcards: components["schemas"]["OrderGiftCardUsageDTO"][];
|
|
3091
3118
|
/**
|
|
3092
3119
|
* Format: flake-id
|
|
3093
3120
|
* @description The Flake ID of the Coupon associated with the order
|
|
3094
3121
|
* @example 411486491630370816
|
|
3095
3122
|
*/
|
|
3096
|
-
coupon_id
|
|
3123
|
+
coupon_id: string;
|
|
3124
|
+
/**
|
|
3125
|
+
* @description The type of the order
|
|
3126
|
+
* @example one_time
|
|
3127
|
+
*/
|
|
3128
|
+
type: string;
|
|
3097
3129
|
/**
|
|
3098
3130
|
* @description The ISO-4217 Currency Code of the order
|
|
3099
3131
|
* @example USD
|
|
@@ -3184,6 +3216,14 @@ export interface components {
|
|
|
3184
3216
|
*/
|
|
3185
3217
|
status: string;
|
|
3186
3218
|
};
|
|
3219
|
+
OrderGiftCardUsageDTO: {
|
|
3220
|
+
/**
|
|
3221
|
+
* Format: flake-id
|
|
3222
|
+
* @example 411486491630370816
|
|
3223
|
+
*/
|
|
3224
|
+
giftcard_id: string;
|
|
3225
|
+
usage_amount: number;
|
|
3226
|
+
};
|
|
3187
3227
|
OrderLineDTO: {
|
|
3188
3228
|
/**
|
|
3189
3229
|
* Format: flake-id
|
|
@@ -3196,7 +3236,7 @@ export interface components {
|
|
|
3196
3236
|
* @description The Flake ID of the Checkout Line associated with this Order Line
|
|
3197
3237
|
* @example 411486491630370816
|
|
3198
3238
|
*/
|
|
3199
|
-
checkout_line_id
|
|
3239
|
+
checkout_line_id?: null | string;
|
|
3200
3240
|
/**
|
|
3201
3241
|
* Format: flake-id
|
|
3202
3242
|
* @description The Flake ID of the Product ID associated with this Order Line
|
|
@@ -3220,6 +3260,12 @@ export interface components {
|
|
|
3220
3260
|
* @example 411486491630370816
|
|
3221
3261
|
*/
|
|
3222
3262
|
subscription_id?: null | string;
|
|
3263
|
+
/**
|
|
3264
|
+
* Format: flake-id
|
|
3265
|
+
* @description The Flake ID of the Subscription Line associated with this Order Line
|
|
3266
|
+
* @example 411486491630370816
|
|
3267
|
+
*/
|
|
3268
|
+
subscription_line_id?: null | string;
|
|
3223
3269
|
/**
|
|
3224
3270
|
* @description The value of the interval in which the subscription associated with this Order Line renews at
|
|
3225
3271
|
* @example 1
|
|
@@ -3411,6 +3457,190 @@ export interface components {
|
|
|
3411
3457
|
/** @description The Steam Avatar URL */
|
|
3412
3458
|
avatar_url: string;
|
|
3413
3459
|
};
|
|
3460
|
+
SubscriptionLineDTO: {
|
|
3461
|
+
/**
|
|
3462
|
+
* Format: flake-id
|
|
3463
|
+
* @description The Flake ID of the Subscription Line
|
|
3464
|
+
* @example 411486491630370816
|
|
3465
|
+
*/
|
|
3466
|
+
id: string;
|
|
3467
|
+
/**
|
|
3468
|
+
* Format: flake-id
|
|
3469
|
+
* @description The Flake ID of the Subscription associated with this Subscription Line
|
|
3470
|
+
* @example 411486491630370816
|
|
3471
|
+
*/
|
|
3472
|
+
subscription_id: string;
|
|
3473
|
+
/**
|
|
3474
|
+
* Format: flake-id
|
|
3475
|
+
* @description The Flake ID of the Checkout Line associated with this Subscription Line
|
|
3476
|
+
* @example 411486491630370816
|
|
3477
|
+
*/
|
|
3478
|
+
checkout_line_id?: null | string;
|
|
3479
|
+
/**
|
|
3480
|
+
* Format: flake-id
|
|
3481
|
+
* @description The Flake ID of the initial Order Line associated with this Subscription Line
|
|
3482
|
+
* @example 411486491630370816
|
|
3483
|
+
*/
|
|
3484
|
+
initial_order_line_id?: null | string;
|
|
3485
|
+
/**
|
|
3486
|
+
* Format: flake-id
|
|
3487
|
+
* @description The Flake ID of the customer this Subscription Line was gifted to
|
|
3488
|
+
* @example 411486491630370816
|
|
3489
|
+
*/
|
|
3490
|
+
gift_to_customer_id?: null | string;
|
|
3491
|
+
gift_to_customer?: components["schemas"]["CustomerDTO"] | null;
|
|
3492
|
+
/**
|
|
3493
|
+
* Format: flake-id
|
|
3494
|
+
* @description The Flake ID of the selected Game Server for this Subscription Line
|
|
3495
|
+
* @example 411486491630370816
|
|
3496
|
+
*/
|
|
3497
|
+
selected_gameserver_id?: null | string;
|
|
3498
|
+
/**
|
|
3499
|
+
* Format: flake-id
|
|
3500
|
+
* @description The Flake ID of the Sale associated with this Subscription Line
|
|
3501
|
+
* @example 411486491630370816
|
|
3502
|
+
*/
|
|
3503
|
+
sale_id?: null | string;
|
|
3504
|
+
/**
|
|
3505
|
+
* Format: flake-id
|
|
3506
|
+
* @description The Flake ID of the Trial associated with this Subscription Line
|
|
3507
|
+
* @example 411486491630370816
|
|
3508
|
+
*/
|
|
3509
|
+
trial_id?: null | string;
|
|
3510
|
+
/**
|
|
3511
|
+
* Format: flake-id
|
|
3512
|
+
* @description The Flake ID of the Product associated with this Subscription Line
|
|
3513
|
+
* @example 411486491630370816
|
|
3514
|
+
*/
|
|
3515
|
+
product_id: string;
|
|
3516
|
+
/**
|
|
3517
|
+
* Format: flake-id
|
|
3518
|
+
* @description The Flake ID of the Product Version associated with this Subscription Line
|
|
3519
|
+
* @example 411486491630370816
|
|
3520
|
+
*/
|
|
3521
|
+
product_version_id: string;
|
|
3522
|
+
/**
|
|
3523
|
+
* @description The name of the Product associated with this Subscription Line
|
|
3524
|
+
* @example Example Product
|
|
3525
|
+
*/
|
|
3526
|
+
product_name: string;
|
|
3527
|
+
/**
|
|
3528
|
+
* @description The image URL of the Product associated with this Subscription Line
|
|
3529
|
+
* @example https://example.com/image.jpg
|
|
3530
|
+
*/
|
|
3531
|
+
product_image_url?: null | string;
|
|
3532
|
+
product?: components["schemas"]["ProductDTO"] | null;
|
|
3533
|
+
/**
|
|
3534
|
+
* @description Whether the price of this Subscription Line is tax inclusive
|
|
3535
|
+
* @example false
|
|
3536
|
+
*/
|
|
3537
|
+
tax_inclusive: boolean;
|
|
3538
|
+
/**
|
|
3539
|
+
* @description The price of this Subscription Line represented in cents
|
|
3540
|
+
* @example 9999
|
|
3541
|
+
*/
|
|
3542
|
+
price: number;
|
|
3543
|
+
/**
|
|
3544
|
+
* @description The discount amount applied to this Subscription Line represented in cents
|
|
3545
|
+
* @example 1000
|
|
3546
|
+
*/
|
|
3547
|
+
discount_amount: number;
|
|
3548
|
+
/**
|
|
3549
|
+
* @description The subtotal amount of this Subscription Line represented in cents
|
|
3550
|
+
* @example 8999
|
|
3551
|
+
*/
|
|
3552
|
+
subtotal_amount: number;
|
|
3553
|
+
/**
|
|
3554
|
+
* @description The tax amount of this Subscription Line represented in cents
|
|
3555
|
+
* @example 1350
|
|
3556
|
+
*/
|
|
3557
|
+
tax_amount: number;
|
|
3558
|
+
/**
|
|
3559
|
+
* @description The total amount of this Subscription Line represented in cents
|
|
3560
|
+
* @example 10349
|
|
3561
|
+
*/
|
|
3562
|
+
total_amount: number;
|
|
3563
|
+
/**
|
|
3564
|
+
* @description The initial discount amount applied to this Subscription Line represented in cents
|
|
3565
|
+
* @example 2000
|
|
3566
|
+
*/
|
|
3567
|
+
initial_discount_amount: number;
|
|
3568
|
+
/**
|
|
3569
|
+
* @description The initial subtotal amount of this Subscription Line represented in cents
|
|
3570
|
+
* @example 7999
|
|
3571
|
+
*/
|
|
3572
|
+
initial_subtotal_amount: number;
|
|
3573
|
+
/**
|
|
3574
|
+
* @description The initial gift card usage amount applied to this Subscription Line represented in cents
|
|
3575
|
+
* @example 0
|
|
3576
|
+
*/
|
|
3577
|
+
initial_giftcard_usage_amount: number;
|
|
3578
|
+
/**
|
|
3579
|
+
* @description The initial tax amount of this Subscription Line represented in cents
|
|
3580
|
+
* @example 1200
|
|
3581
|
+
*/
|
|
3582
|
+
initial_tax_amount: number;
|
|
3583
|
+
/**
|
|
3584
|
+
* @description The initial total amount of this Subscription Line represented in cents
|
|
3585
|
+
* @example 9199
|
|
3586
|
+
*/
|
|
3587
|
+
initial_total_amount: number;
|
|
3588
|
+
/**
|
|
3589
|
+
* @description The currency code of this Subscription Line
|
|
3590
|
+
* @example USD
|
|
3591
|
+
*/
|
|
3592
|
+
currency: string;
|
|
3593
|
+
/**
|
|
3594
|
+
* @description The presentment currency code of this Subscription Line
|
|
3595
|
+
* @example EUR
|
|
3596
|
+
*/
|
|
3597
|
+
presentment_currency?: null | string;
|
|
3598
|
+
/**
|
|
3599
|
+
* @description The presentment subtotal amount of this Subscription Line represented in cents
|
|
3600
|
+
* @example 8299
|
|
3601
|
+
*/
|
|
3602
|
+
presentment_subtotal_amount?: null | number;
|
|
3603
|
+
/**
|
|
3604
|
+
* @description The presentment discount amount of this Subscription Line represented in cents
|
|
3605
|
+
* @example 0
|
|
3606
|
+
*/
|
|
3607
|
+
presentment_discount_amount?: null | number;
|
|
3608
|
+
/**
|
|
3609
|
+
* @description The presentment tax amount of this Subscription Line represented in cents
|
|
3610
|
+
* @example 1245
|
|
3611
|
+
*/
|
|
3612
|
+
presentment_tax_amount?: null | number;
|
|
3613
|
+
/**
|
|
3614
|
+
* @description The presentment total amount of this Subscription Line represented in cents
|
|
3615
|
+
* @example 9544
|
|
3616
|
+
*/
|
|
3617
|
+
presentment_total_amount?: null | number;
|
|
3618
|
+
/**
|
|
3619
|
+
* @description The initial presentment discount amount of this Subscription Line represented in cents
|
|
3620
|
+
* @example 0
|
|
3621
|
+
*/
|
|
3622
|
+
initial_presentment_discount_amount?: null | number;
|
|
3623
|
+
/**
|
|
3624
|
+
* @description The initial presentment subtotal amount of this Subscription Line represented in cents
|
|
3625
|
+
* @example 7359
|
|
3626
|
+
*/
|
|
3627
|
+
initial_presentment_subtotal_amount?: null | number;
|
|
3628
|
+
/**
|
|
3629
|
+
* @description The initial presentment gift card usage amount of this Subscription Line represented in cents
|
|
3630
|
+
* @example 0
|
|
3631
|
+
*/
|
|
3632
|
+
initial_presentment_giftcard_usage_amount?: null | number;
|
|
3633
|
+
/**
|
|
3634
|
+
* @description The initial presentment tax amount of this Subscription Line represented in cents
|
|
3635
|
+
* @example 1104
|
|
3636
|
+
*/
|
|
3637
|
+
initial_presentment_tax_amount?: null | number;
|
|
3638
|
+
/**
|
|
3639
|
+
* @description The initial presentment total amount of this Subscription Line represented in cents
|
|
3640
|
+
* @example 8463
|
|
3641
|
+
*/
|
|
3642
|
+
initial_presentment_total_amount?: null | number;
|
|
3643
|
+
};
|
|
3414
3644
|
/**
|
|
3415
3645
|
* @description The type of webhook event
|
|
3416
3646
|
* @enum {string}
|