@paynow-gg/typescript-sdk 1.0.52 → 1.0.54
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 +579 -92
- package/dist/generated/management.d.ts.map +1 -1
- package/dist/generated/management.js +12 -0
- package/dist/generated/management.js.map +1 -1
- package/dist/generated/storefront.d.ts +1255 -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 +468 -262
- 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;
|
|
@@ -1726,6 +1493,11 @@ export interface webhooks {
|
|
|
1726
1493
|
* @example 411486491630370816
|
|
1727
1494
|
*/
|
|
1728
1495
|
coupon_id?: null | string;
|
|
1496
|
+
/**
|
|
1497
|
+
* @description The type of the order
|
|
1498
|
+
* @example one_time
|
|
1499
|
+
*/
|
|
1500
|
+
type: string;
|
|
1729
1501
|
/**
|
|
1730
1502
|
* @description The ISO-4217 Currency Code of the order
|
|
1731
1503
|
* @example USD
|
|
@@ -2143,7 +1915,7 @@ export interface webhooks {
|
|
|
2143
1915
|
product_image_url?: null | string;
|
|
2144
1916
|
product: components["schemas"]["ProductDTO"];
|
|
2145
1917
|
/**
|
|
2146
|
-
* @description The ISO-3166 Country Code of customer associated with the Subscription
|
|
1918
|
+
* @description The ISO-3166 Country Code of the customer associated with the Subscription
|
|
2147
1919
|
* @example US
|
|
2148
1920
|
*/
|
|
2149
1921
|
billing_country: string;
|
|
@@ -2214,10 +1986,12 @@ export interface webhooks {
|
|
|
2214
1986
|
*/
|
|
2215
1987
|
checkout_line_id: string;
|
|
2216
1988
|
/**
|
|
2217
|
-
* @description The current status of the Subscription.
|
|
1989
|
+
* @description The current status of the Subscription. Possible options: created, active, canceled
|
|
2218
1990
|
* @example created
|
|
2219
1991
|
*/
|
|
2220
1992
|
status: string;
|
|
1993
|
+
/** @description The lines of the Subscription */
|
|
1994
|
+
lines: components["schemas"]["SubscriptionLineDTO"][];
|
|
2221
1995
|
};
|
|
2222
1996
|
};
|
|
2223
1997
|
};
|
|
@@ -2287,6 +2061,17 @@ export interface webhooks {
|
|
|
2287
2061
|
*/
|
|
2288
2062
|
event_id: string;
|
|
2289
2063
|
body: {
|
|
2064
|
+
/**
|
|
2065
|
+
* Format: date-time
|
|
2066
|
+
* @description Indicates when the subscription was canceled
|
|
2067
|
+
* @example 2024-05-15T14:20:00Z
|
|
2068
|
+
*/
|
|
2069
|
+
canceled_at?: null | string;
|
|
2070
|
+
/**
|
|
2071
|
+
* @description The reason for the subscription cancellation
|
|
2072
|
+
* @example customer_request
|
|
2073
|
+
*/
|
|
2074
|
+
cancel_reason?: null | string;
|
|
2290
2075
|
/**
|
|
2291
2076
|
* Format: flake-id
|
|
2292
2077
|
* @description The Flake ID of the Subscription
|
|
@@ -2314,27 +2099,27 @@ export interface webhooks {
|
|
|
2314
2099
|
billing_cycle_sequence: number;
|
|
2315
2100
|
/**
|
|
2316
2101
|
* @description The billing email address of the customer associated with the Subscription
|
|
2317
|
-
* @example
|
|
2102
|
+
* @example john@doe.com
|
|
2318
2103
|
*/
|
|
2319
2104
|
billing_email: string;
|
|
2320
2105
|
/**
|
|
2321
2106
|
* @description The subtotal amount of the Subscription represented in cents
|
|
2322
|
-
* @example
|
|
2107
|
+
* @example 9999
|
|
2323
2108
|
*/
|
|
2324
2109
|
subtotal_amount: number;
|
|
2325
2110
|
/**
|
|
2326
2111
|
* @description The tax amount of the Subscription represented in cents
|
|
2327
|
-
* @example
|
|
2112
|
+
* @example 1500
|
|
2328
2113
|
*/
|
|
2329
2114
|
tax_amount: number;
|
|
2330
2115
|
/**
|
|
2331
2116
|
* @description The discount amount applied to the Subscription represented in cents
|
|
2332
|
-
* @example
|
|
2117
|
+
* @example 1000
|
|
2333
2118
|
*/
|
|
2334
2119
|
discount_amount: number;
|
|
2335
2120
|
/**
|
|
2336
2121
|
* @description The total amount of the Subscription represented in cents
|
|
2337
|
-
* @example
|
|
2122
|
+
* @example 10499
|
|
2338
2123
|
*/
|
|
2339
2124
|
total_amount: number;
|
|
2340
2125
|
/**
|
|
@@ -2349,7 +2134,7 @@ export interface webhooks {
|
|
|
2349
2134
|
interval_value: number;
|
|
2350
2135
|
/**
|
|
2351
2136
|
* @description The interval scale of the billing cycle
|
|
2352
|
-
* @example
|
|
2137
|
+
* @example month
|
|
2353
2138
|
*/
|
|
2354
2139
|
interval_scale: string;
|
|
2355
2140
|
/**
|
|
@@ -2366,33 +2151,33 @@ export interface webhooks {
|
|
|
2366
2151
|
product_version_id: string;
|
|
2367
2152
|
/**
|
|
2368
2153
|
* @description The name of the Product associated with the Subscription
|
|
2369
|
-
* @example
|
|
2154
|
+
* @example Example Product
|
|
2370
2155
|
*/
|
|
2371
2156
|
product_name: string;
|
|
2372
2157
|
/**
|
|
2373
2158
|
* @description The image URL of the Product associated with the Subscription
|
|
2374
|
-
* @example https://example.com/
|
|
2159
|
+
* @example https://example.com/image.jpg
|
|
2375
2160
|
*/
|
|
2376
2161
|
product_image_url?: null | string;
|
|
2377
2162
|
product: components["schemas"]["ProductDTO"];
|
|
2378
2163
|
/**
|
|
2379
|
-
* @description The ISO-3166
|
|
2164
|
+
* @description The ISO-3166 Country Code of the customer associated with the Subscription
|
|
2380
2165
|
* @example US
|
|
2381
2166
|
*/
|
|
2382
2167
|
billing_country: string;
|
|
2383
2168
|
/**
|
|
2384
2169
|
* @description The initial subtotal amount of the Subscription represented in cents
|
|
2385
|
-
* @example
|
|
2170
|
+
* @example 9999
|
|
2386
2171
|
*/
|
|
2387
2172
|
initial_subtotal_amount: number;
|
|
2388
2173
|
/**
|
|
2389
2174
|
* @description The initial tax amount of the Subscription represented in cents
|
|
2390
|
-
* @example
|
|
2175
|
+
* @example 1500
|
|
2391
2176
|
*/
|
|
2392
2177
|
initial_tax_amount: number;
|
|
2393
2178
|
/**
|
|
2394
2179
|
* @description The initial discount amount applied to the Subscription represented in cents
|
|
2395
|
-
* @example
|
|
2180
|
+
* @example 2000
|
|
2396
2181
|
*/
|
|
2397
2182
|
initial_discount_amount: number;
|
|
2398
2183
|
/**
|
|
@@ -2402,7 +2187,7 @@ export interface webhooks {
|
|
|
2402
2187
|
initial_giftcard_usage_amount: number;
|
|
2403
2188
|
/**
|
|
2404
2189
|
* @description The initial total amount of the Subscription represented in cents
|
|
2405
|
-
* @example
|
|
2190
|
+
* @example 9499
|
|
2406
2191
|
*/
|
|
2407
2192
|
initial_total_amount: number;
|
|
2408
2193
|
/**
|
|
@@ -2413,38 +2198,262 @@ export interface webhooks {
|
|
|
2413
2198
|
/**
|
|
2414
2199
|
* Format: date-time
|
|
2415
2200
|
* @description The start date of the current billing period
|
|
2416
|
-
* @example 2024-
|
|
2201
|
+
* @example 2024-02-01T00:00:00Z
|
|
2417
2202
|
*/
|
|
2418
2203
|
current_period_start?: null | string;
|
|
2419
2204
|
/**
|
|
2420
2205
|
* Format: date-time
|
|
2421
2206
|
* @description The end date of the current billing period
|
|
2422
|
-
* @example
|
|
2207
|
+
* @example 2024-03-01T00:00:00Z
|
|
2423
2208
|
*/
|
|
2424
2209
|
current_period_end?: null | string;
|
|
2425
2210
|
/**
|
|
2426
2211
|
* Format: date-time
|
|
2427
2212
|
* @description The date and time when the Subscription was created
|
|
2428
|
-
* @example 2024-
|
|
2213
|
+
* @example 2024-02-01T10:15:00Z
|
|
2429
2214
|
*/
|
|
2430
2215
|
created_at?: null | string;
|
|
2431
2216
|
/**
|
|
2432
2217
|
* Format: date-time
|
|
2433
2218
|
* @description Indicates when the subscription was active
|
|
2434
|
-
* @example 2024-
|
|
2219
|
+
* @example 2024-02-01T10:20:00Z
|
|
2435
2220
|
*/
|
|
2436
2221
|
active_at?: null | string;
|
|
2437
2222
|
/**
|
|
2438
|
-
* Format:
|
|
2439
|
-
* @description
|
|
2440
|
-
* @example
|
|
2441
|
-
*/
|
|
2442
|
-
|
|
2223
|
+
* Format: flake-id
|
|
2224
|
+
* @description The Flake ID of the Checkout associated with the Subscription
|
|
2225
|
+
* @example 411486491630370816
|
|
2226
|
+
*/
|
|
2227
|
+
checkout_id: string;
|
|
2443
2228
|
/**
|
|
2444
|
-
*
|
|
2445
|
-
* @
|
|
2229
|
+
* Format: flake-id
|
|
2230
|
+
* @description The Flake ID of the Checkout Line associated with the Subscription
|
|
2231
|
+
* @example 411486491630370816
|
|
2446
2232
|
*/
|
|
2447
|
-
|
|
2233
|
+
checkout_line_id: string;
|
|
2234
|
+
/**
|
|
2235
|
+
* @description The current status of the Subscription. Possible options: created, active, canceled
|
|
2236
|
+
* @example created
|
|
2237
|
+
*/
|
|
2238
|
+
status: string;
|
|
2239
|
+
/** @description The lines of the Subscription */
|
|
2240
|
+
lines: components["schemas"]["SubscriptionLineDTO"][];
|
|
2241
|
+
};
|
|
2242
|
+
};
|
|
2243
|
+
};
|
|
2244
|
+
};
|
|
2245
|
+
responses: {
|
|
2246
|
+
/** @description Webhook processed successfully */
|
|
2247
|
+
200: {
|
|
2248
|
+
headers: {
|
|
2249
|
+
[name: string]: unknown;
|
|
2250
|
+
};
|
|
2251
|
+
content?: never;
|
|
2252
|
+
};
|
|
2253
|
+
/** @description Bad request */
|
|
2254
|
+
400: {
|
|
2255
|
+
headers: {
|
|
2256
|
+
[name: string]: unknown;
|
|
2257
|
+
};
|
|
2258
|
+
content?: never;
|
|
2259
|
+
};
|
|
2260
|
+
/** @description Internal server error */
|
|
2261
|
+
500: {
|
|
2262
|
+
headers: {
|
|
2263
|
+
[name: string]: unknown;
|
|
2264
|
+
};
|
|
2265
|
+
content?: never;
|
|
2266
|
+
};
|
|
2267
|
+
};
|
|
2268
|
+
};
|
|
2269
|
+
delete?: never;
|
|
2270
|
+
options?: never;
|
|
2271
|
+
head?: never;
|
|
2272
|
+
patch?: never;
|
|
2273
|
+
trace?: never;
|
|
2274
|
+
};
|
|
2275
|
+
ON_SUBSCRIPTION_RENEWED: {
|
|
2276
|
+
parameters: {
|
|
2277
|
+
query?: never;
|
|
2278
|
+
header?: never;
|
|
2279
|
+
path?: never;
|
|
2280
|
+
cookie?: never;
|
|
2281
|
+
};
|
|
2282
|
+
get?: never;
|
|
2283
|
+
put?: never;
|
|
2284
|
+
/**
|
|
2285
|
+
* Triggered when a subscription is renewed
|
|
2286
|
+
* @description Webhook for ON_SUBSCRIPTION_RENEWED
|
|
2287
|
+
*/
|
|
2288
|
+
post: {
|
|
2289
|
+
parameters: {
|
|
2290
|
+
query?: never;
|
|
2291
|
+
header?: never;
|
|
2292
|
+
path?: never;
|
|
2293
|
+
cookie?: never;
|
|
2294
|
+
};
|
|
2295
|
+
requestBody: {
|
|
2296
|
+
content: {
|
|
2297
|
+
"application/json": {
|
|
2298
|
+
/**
|
|
2299
|
+
* @description The type of webhook event
|
|
2300
|
+
* @example ON_SUBSCRIPTION_RENEWED
|
|
2301
|
+
*/
|
|
2302
|
+
event_type: components["schemas"]["WebhookEventType"];
|
|
2303
|
+
/**
|
|
2304
|
+
* Format: flake-id
|
|
2305
|
+
* @description The ID of the Webhook Event
|
|
2306
|
+
* @example 411486491630370816
|
|
2307
|
+
*/
|
|
2308
|
+
event_id: string;
|
|
2309
|
+
body: {
|
|
2310
|
+
/**
|
|
2311
|
+
* Format: flake-id
|
|
2312
|
+
* @description The Flake ID of the Subscription
|
|
2313
|
+
* @example 411486491630370816
|
|
2314
|
+
*/
|
|
2315
|
+
id: string;
|
|
2316
|
+
/**
|
|
2317
|
+
* Format: flake-id
|
|
2318
|
+
* @description The Flake ID of the Store associated with the Subscription
|
|
2319
|
+
* @example 411486491630370816
|
|
2320
|
+
*/
|
|
2321
|
+
store_id: string;
|
|
2322
|
+
/**
|
|
2323
|
+
* Format: flake-id
|
|
2324
|
+
* @description The Flake ID of the Customer associated with the Subscription
|
|
2325
|
+
* @example 411486491630370816
|
|
2326
|
+
*/
|
|
2327
|
+
customer_id: string;
|
|
2328
|
+
customer: components["schemas"]["CustomerDTO"];
|
|
2329
|
+
checkout: components["schemas"]["CheckoutDTO"];
|
|
2330
|
+
/**
|
|
2331
|
+
* @description The current billing cycle number
|
|
2332
|
+
* @example 1
|
|
2333
|
+
*/
|
|
2334
|
+
billing_cycle_sequence: number;
|
|
2335
|
+
/**
|
|
2336
|
+
* @description The billing email address of the customer associated with the Subscription
|
|
2337
|
+
* @example john@doe.com
|
|
2338
|
+
*/
|
|
2339
|
+
billing_email: string;
|
|
2340
|
+
/**
|
|
2341
|
+
* @description The subtotal amount of the Subscription represented in cents
|
|
2342
|
+
* @example 9999
|
|
2343
|
+
*/
|
|
2344
|
+
subtotal_amount: number;
|
|
2345
|
+
/**
|
|
2346
|
+
* @description The tax amount of the Subscription represented in cents
|
|
2347
|
+
* @example 1500
|
|
2348
|
+
*/
|
|
2349
|
+
tax_amount: number;
|
|
2350
|
+
/**
|
|
2351
|
+
* @description The discount amount applied to the Subscription represented in cents
|
|
2352
|
+
* @example 1000
|
|
2353
|
+
*/
|
|
2354
|
+
discount_amount: number;
|
|
2355
|
+
/**
|
|
2356
|
+
* @description The total amount of the Subscription represented in cents
|
|
2357
|
+
* @example 10499
|
|
2358
|
+
*/
|
|
2359
|
+
total_amount: number;
|
|
2360
|
+
/**
|
|
2361
|
+
* @description The currency code of the Subscription
|
|
2362
|
+
* @example USD
|
|
2363
|
+
*/
|
|
2364
|
+
currency: string;
|
|
2365
|
+
/**
|
|
2366
|
+
* @description The interval value of the billing cycle
|
|
2367
|
+
* @example 1
|
|
2368
|
+
*/
|
|
2369
|
+
interval_value: number;
|
|
2370
|
+
/**
|
|
2371
|
+
* @description The interval scale of the billing cycle
|
|
2372
|
+
* @example month
|
|
2373
|
+
*/
|
|
2374
|
+
interval_scale: string;
|
|
2375
|
+
/**
|
|
2376
|
+
* Format: flake-id
|
|
2377
|
+
* @description The Flake ID of the Product associated with the Subscription
|
|
2378
|
+
* @example 411486491630370816
|
|
2379
|
+
*/
|
|
2380
|
+
product_id: string;
|
|
2381
|
+
/**
|
|
2382
|
+
* Format: flake-id
|
|
2383
|
+
* @description The Flake ID of the Product Version associated with the Subscription
|
|
2384
|
+
* @example 411486491630370816
|
|
2385
|
+
*/
|
|
2386
|
+
product_version_id: string;
|
|
2387
|
+
/**
|
|
2388
|
+
* @description The name of the Product associated with the Subscription
|
|
2389
|
+
* @example Example Product
|
|
2390
|
+
*/
|
|
2391
|
+
product_name: string;
|
|
2392
|
+
/**
|
|
2393
|
+
* @description The image URL of the Product associated with the Subscription
|
|
2394
|
+
* @example https://example.com/image.jpg
|
|
2395
|
+
*/
|
|
2396
|
+
product_image_url?: null | string;
|
|
2397
|
+
product: components["schemas"]["ProductDTO"];
|
|
2398
|
+
/**
|
|
2399
|
+
* @description The ISO-3166 Country Code of the customer associated with the Subscription
|
|
2400
|
+
* @example US
|
|
2401
|
+
*/
|
|
2402
|
+
billing_country: string;
|
|
2403
|
+
/**
|
|
2404
|
+
* @description The initial subtotal amount of the Subscription represented in cents
|
|
2405
|
+
* @example 9999
|
|
2406
|
+
*/
|
|
2407
|
+
initial_subtotal_amount: number;
|
|
2408
|
+
/**
|
|
2409
|
+
* @description The initial tax amount of the Subscription represented in cents
|
|
2410
|
+
* @example 1500
|
|
2411
|
+
*/
|
|
2412
|
+
initial_tax_amount: number;
|
|
2413
|
+
/**
|
|
2414
|
+
* @description The initial discount amount applied to the Subscription represented in cents
|
|
2415
|
+
* @example 2000
|
|
2416
|
+
*/
|
|
2417
|
+
initial_discount_amount: number;
|
|
2418
|
+
/**
|
|
2419
|
+
* @description The initial gift card usage amount applied to the Subscription represented in cents
|
|
2420
|
+
* @example 0
|
|
2421
|
+
*/
|
|
2422
|
+
initial_giftcard_usage_amount: number;
|
|
2423
|
+
/**
|
|
2424
|
+
* @description The initial total amount of the Subscription represented in cents
|
|
2425
|
+
* @example 9499
|
|
2426
|
+
*/
|
|
2427
|
+
initial_total_amount: number;
|
|
2428
|
+
/**
|
|
2429
|
+
* @description The IP address of the Customer
|
|
2430
|
+
* @example 127.0.0.1/24
|
|
2431
|
+
*/
|
|
2432
|
+
customer_ip: string;
|
|
2433
|
+
/**
|
|
2434
|
+
* Format: date-time
|
|
2435
|
+
* @description The start date of the current billing period
|
|
2436
|
+
* @example 2024-02-01T00:00:00Z
|
|
2437
|
+
*/
|
|
2438
|
+
current_period_start?: null | string;
|
|
2439
|
+
/**
|
|
2440
|
+
* Format: date-time
|
|
2441
|
+
* @description The end date of the current billing period
|
|
2442
|
+
* @example 2024-03-01T00:00:00Z
|
|
2443
|
+
*/
|
|
2444
|
+
current_period_end?: null | string;
|
|
2445
|
+
/**
|
|
2446
|
+
* Format: date-time
|
|
2447
|
+
* @description The date and time when the Subscription was created
|
|
2448
|
+
* @example 2024-02-01T10:15:00Z
|
|
2449
|
+
*/
|
|
2450
|
+
created_at?: null | string;
|
|
2451
|
+
/**
|
|
2452
|
+
* Format: date-time
|
|
2453
|
+
* @description Indicates when the subscription was active
|
|
2454
|
+
* @example 2024-02-01T10:20:00Z
|
|
2455
|
+
*/
|
|
2456
|
+
active_at?: null | string;
|
|
2448
2457
|
/**
|
|
2449
2458
|
* Format: flake-id
|
|
2450
2459
|
* @description The Flake ID of the Checkout associated with the Subscription
|
|
@@ -2458,10 +2467,12 @@ export interface webhooks {
|
|
|
2458
2467
|
*/
|
|
2459
2468
|
checkout_line_id: string;
|
|
2460
2469
|
/**
|
|
2461
|
-
* @description The current status of the Subscription.
|
|
2470
|
+
* @description The current status of the Subscription. Possible options: created, active, canceled
|
|
2462
2471
|
* @example created
|
|
2463
2472
|
*/
|
|
2464
2473
|
status: string;
|
|
2474
|
+
/** @description The lines of the Subscription */
|
|
2475
|
+
lines: components["schemas"]["SubscriptionLineDTO"][];
|
|
2465
2476
|
};
|
|
2466
2477
|
};
|
|
2467
2478
|
};
|
|
@@ -3094,6 +3105,11 @@ export interface components {
|
|
|
3094
3105
|
* @example 411486491630370816
|
|
3095
3106
|
*/
|
|
3096
3107
|
coupon_id?: null | string;
|
|
3108
|
+
/**
|
|
3109
|
+
* @description The type of the order
|
|
3110
|
+
* @example one_time
|
|
3111
|
+
*/
|
|
3112
|
+
type: string;
|
|
3097
3113
|
/**
|
|
3098
3114
|
* @description The ISO-4217 Currency Code of the order
|
|
3099
3115
|
* @example USD
|
|
@@ -3196,7 +3212,7 @@ export interface components {
|
|
|
3196
3212
|
* @description The Flake ID of the Checkout Line associated with this Order Line
|
|
3197
3213
|
* @example 411486491630370816
|
|
3198
3214
|
*/
|
|
3199
|
-
checkout_line_id
|
|
3215
|
+
checkout_line_id?: null | string;
|
|
3200
3216
|
/**
|
|
3201
3217
|
* Format: flake-id
|
|
3202
3218
|
* @description The Flake ID of the Product ID associated with this Order Line
|
|
@@ -3220,6 +3236,12 @@ export interface components {
|
|
|
3220
3236
|
* @example 411486491630370816
|
|
3221
3237
|
*/
|
|
3222
3238
|
subscription_id?: null | string;
|
|
3239
|
+
/**
|
|
3240
|
+
* Format: flake-id
|
|
3241
|
+
* @description The Flake ID of the Subscription Line associated with this Order Line
|
|
3242
|
+
* @example 411486491630370816
|
|
3243
|
+
*/
|
|
3244
|
+
subscription_line_id?: null | string;
|
|
3223
3245
|
/**
|
|
3224
3246
|
* @description The value of the interval in which the subscription associated with this Order Line renews at
|
|
3225
3247
|
* @example 1
|
|
@@ -3411,6 +3433,190 @@ export interface components {
|
|
|
3411
3433
|
/** @description The Steam Avatar URL */
|
|
3412
3434
|
avatar_url: string;
|
|
3413
3435
|
};
|
|
3436
|
+
SubscriptionLineDTO: {
|
|
3437
|
+
/**
|
|
3438
|
+
* Format: flake-id
|
|
3439
|
+
* @description The Flake ID of the Subscription Line
|
|
3440
|
+
* @example 411486491630370816
|
|
3441
|
+
*/
|
|
3442
|
+
id: string;
|
|
3443
|
+
/**
|
|
3444
|
+
* Format: flake-id
|
|
3445
|
+
* @description The Flake ID of the Subscription associated with this Subscription Line
|
|
3446
|
+
* @example 411486491630370816
|
|
3447
|
+
*/
|
|
3448
|
+
subscription_id: string;
|
|
3449
|
+
/**
|
|
3450
|
+
* Format: flake-id
|
|
3451
|
+
* @description The Flake ID of the Checkout Line associated with this Subscription Line
|
|
3452
|
+
* @example 411486491630370816
|
|
3453
|
+
*/
|
|
3454
|
+
checkout_line_id?: null | string;
|
|
3455
|
+
/**
|
|
3456
|
+
* Format: flake-id
|
|
3457
|
+
* @description The Flake ID of the initial Order Line associated with this Subscription Line
|
|
3458
|
+
* @example 411486491630370816
|
|
3459
|
+
*/
|
|
3460
|
+
initial_order_line_id?: null | string;
|
|
3461
|
+
/**
|
|
3462
|
+
* Format: flake-id
|
|
3463
|
+
* @description The Flake ID of the customer this Subscription Line was gifted to
|
|
3464
|
+
* @example 411486491630370816
|
|
3465
|
+
*/
|
|
3466
|
+
gift_to_customer_id?: null | string;
|
|
3467
|
+
gift_to_customer?: components["schemas"]["CustomerDTO"] | null;
|
|
3468
|
+
/**
|
|
3469
|
+
* Format: flake-id
|
|
3470
|
+
* @description The Flake ID of the selected Game Server for this Subscription Line
|
|
3471
|
+
* @example 411486491630370816
|
|
3472
|
+
*/
|
|
3473
|
+
selected_gameserver_id?: null | string;
|
|
3474
|
+
/**
|
|
3475
|
+
* Format: flake-id
|
|
3476
|
+
* @description The Flake ID of the Sale associated with this Subscription Line
|
|
3477
|
+
* @example 411486491630370816
|
|
3478
|
+
*/
|
|
3479
|
+
sale_id?: null | string;
|
|
3480
|
+
/**
|
|
3481
|
+
* Format: flake-id
|
|
3482
|
+
* @description The Flake ID of the Trial associated with this Subscription Line
|
|
3483
|
+
* @example 411486491630370816
|
|
3484
|
+
*/
|
|
3485
|
+
trial_id?: null | string;
|
|
3486
|
+
/**
|
|
3487
|
+
* Format: flake-id
|
|
3488
|
+
* @description The Flake ID of the Product associated with this Subscription Line
|
|
3489
|
+
* @example 411486491630370816
|
|
3490
|
+
*/
|
|
3491
|
+
product_id: string;
|
|
3492
|
+
/**
|
|
3493
|
+
* Format: flake-id
|
|
3494
|
+
* @description The Flake ID of the Product Version associated with this Subscription Line
|
|
3495
|
+
* @example 411486491630370816
|
|
3496
|
+
*/
|
|
3497
|
+
product_version_id: string;
|
|
3498
|
+
/**
|
|
3499
|
+
* @description The name of the Product associated with this Subscription Line
|
|
3500
|
+
* @example Example Product
|
|
3501
|
+
*/
|
|
3502
|
+
product_name: string;
|
|
3503
|
+
/**
|
|
3504
|
+
* @description The image URL of the Product associated with this Subscription Line
|
|
3505
|
+
* @example https://example.com/image.jpg
|
|
3506
|
+
*/
|
|
3507
|
+
product_image_url?: null | string;
|
|
3508
|
+
product?: components["schemas"]["ProductDTO"] | null;
|
|
3509
|
+
/**
|
|
3510
|
+
* @description Whether the price of this Subscription Line is tax inclusive
|
|
3511
|
+
* @example false
|
|
3512
|
+
*/
|
|
3513
|
+
tax_inclusive: boolean;
|
|
3514
|
+
/**
|
|
3515
|
+
* @description The price of this Subscription Line represented in cents
|
|
3516
|
+
* @example 9999
|
|
3517
|
+
*/
|
|
3518
|
+
price: number;
|
|
3519
|
+
/**
|
|
3520
|
+
* @description The discount amount applied to this Subscription Line represented in cents
|
|
3521
|
+
* @example 1000
|
|
3522
|
+
*/
|
|
3523
|
+
discount_amount: number;
|
|
3524
|
+
/**
|
|
3525
|
+
* @description The subtotal amount of this Subscription Line represented in cents
|
|
3526
|
+
* @example 8999
|
|
3527
|
+
*/
|
|
3528
|
+
subtotal_amount: number;
|
|
3529
|
+
/**
|
|
3530
|
+
* @description The tax amount of this Subscription Line represented in cents
|
|
3531
|
+
* @example 1350
|
|
3532
|
+
*/
|
|
3533
|
+
tax_amount: number;
|
|
3534
|
+
/**
|
|
3535
|
+
* @description The total amount of this Subscription Line represented in cents
|
|
3536
|
+
* @example 10349
|
|
3537
|
+
*/
|
|
3538
|
+
total_amount: number;
|
|
3539
|
+
/**
|
|
3540
|
+
* @description The initial discount amount applied to this Subscription Line represented in cents
|
|
3541
|
+
* @example 2000
|
|
3542
|
+
*/
|
|
3543
|
+
initial_discount_amount: number;
|
|
3544
|
+
/**
|
|
3545
|
+
* @description The initial subtotal amount of this Subscription Line represented in cents
|
|
3546
|
+
* @example 7999
|
|
3547
|
+
*/
|
|
3548
|
+
initial_subtotal_amount: number;
|
|
3549
|
+
/**
|
|
3550
|
+
* @description The initial gift card usage amount applied to this Subscription Line represented in cents
|
|
3551
|
+
* @example 0
|
|
3552
|
+
*/
|
|
3553
|
+
initial_giftcard_usage_amount: number;
|
|
3554
|
+
/**
|
|
3555
|
+
* @description The initial tax amount of this Subscription Line represented in cents
|
|
3556
|
+
* @example 1200
|
|
3557
|
+
*/
|
|
3558
|
+
initial_tax_amount: number;
|
|
3559
|
+
/**
|
|
3560
|
+
* @description The initial total amount of this Subscription Line represented in cents
|
|
3561
|
+
* @example 9199
|
|
3562
|
+
*/
|
|
3563
|
+
initial_total_amount: number;
|
|
3564
|
+
/**
|
|
3565
|
+
* @description The currency code of this Subscription Line
|
|
3566
|
+
* @example USD
|
|
3567
|
+
*/
|
|
3568
|
+
currency: string;
|
|
3569
|
+
/**
|
|
3570
|
+
* @description The presentment currency code of this Subscription Line
|
|
3571
|
+
* @example EUR
|
|
3572
|
+
*/
|
|
3573
|
+
presentment_currency?: null | string;
|
|
3574
|
+
/**
|
|
3575
|
+
* @description The presentment subtotal amount of this Subscription Line represented in cents
|
|
3576
|
+
* @example 8299
|
|
3577
|
+
*/
|
|
3578
|
+
presentment_subtotal_amount?: null | number;
|
|
3579
|
+
/**
|
|
3580
|
+
* @description The presentment discount amount of this Subscription Line represented in cents
|
|
3581
|
+
* @example 0
|
|
3582
|
+
*/
|
|
3583
|
+
presentment_discount_amount?: null | number;
|
|
3584
|
+
/**
|
|
3585
|
+
* @description The presentment tax amount of this Subscription Line represented in cents
|
|
3586
|
+
* @example 1245
|
|
3587
|
+
*/
|
|
3588
|
+
presentment_tax_amount?: null | number;
|
|
3589
|
+
/**
|
|
3590
|
+
* @description The presentment total amount of this Subscription Line represented in cents
|
|
3591
|
+
* @example 9544
|
|
3592
|
+
*/
|
|
3593
|
+
presentment_total_amount?: null | number;
|
|
3594
|
+
/**
|
|
3595
|
+
* @description The initial presentment discount amount of this Subscription Line represented in cents
|
|
3596
|
+
* @example 0
|
|
3597
|
+
*/
|
|
3598
|
+
initial_presentment_discount_amount?: null | number;
|
|
3599
|
+
/**
|
|
3600
|
+
* @description The initial presentment subtotal amount of this Subscription Line represented in cents
|
|
3601
|
+
* @example 7359
|
|
3602
|
+
*/
|
|
3603
|
+
initial_presentment_subtotal_amount?: null | number;
|
|
3604
|
+
/**
|
|
3605
|
+
* @description The initial presentment gift card usage amount of this Subscription Line represented in cents
|
|
3606
|
+
* @example 0
|
|
3607
|
+
*/
|
|
3608
|
+
initial_presentment_giftcard_usage_amount?: null | number;
|
|
3609
|
+
/**
|
|
3610
|
+
* @description The initial presentment tax amount of this Subscription Line represented in cents
|
|
3611
|
+
* @example 1104
|
|
3612
|
+
*/
|
|
3613
|
+
initial_presentment_tax_amount?: null | number;
|
|
3614
|
+
/**
|
|
3615
|
+
* @description The initial presentment total amount of this Subscription Line represented in cents
|
|
3616
|
+
* @example 8463
|
|
3617
|
+
*/
|
|
3618
|
+
initial_presentment_total_amount?: null | number;
|
|
3619
|
+
};
|
|
3414
3620
|
/**
|
|
3415
3621
|
* @description The type of webhook event
|
|
3416
3622
|
* @enum {string}
|