@paynow-gg/typescript-sdk 1.0.61 → 2.0.2

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.
Files changed (140) hide show
  1. package/LICENSE +1 -1
  2. package/README.md +44 -5
  3. package/dist/cjs/generated/management/client.d.ts +902 -0
  4. package/dist/cjs/generated/management/client.d.ts.map +1 -0
  5. package/dist/cjs/generated/management/client.js +1583 -0
  6. package/dist/cjs/generated/management/client.js.map +1 -0
  7. package/dist/cjs/generated/management/types.d.ts +7771 -0
  8. package/dist/cjs/generated/management/types.d.ts.map +1 -0
  9. package/dist/cjs/generated/management/types.js +4 -0
  10. package/dist/cjs/generated/management/types.js.map +1 -0
  11. package/dist/cjs/generated/storefront/client.d.ts +229 -0
  12. package/dist/cjs/generated/storefront/client.d.ts.map +1 -0
  13. package/dist/cjs/generated/storefront/client.js +357 -0
  14. package/dist/cjs/generated/storefront/client.js.map +1 -0
  15. package/dist/cjs/generated/storefront/types.d.ts +3076 -0
  16. package/dist/cjs/generated/storefront/types.d.ts.map +1 -0
  17. package/dist/cjs/generated/storefront/types.js +4 -0
  18. package/dist/cjs/generated/storefront/types.js.map +1 -0
  19. package/dist/cjs/generated/webhooks/types.d.ts +3113 -0
  20. package/dist/cjs/generated/webhooks/types.d.ts.map +1 -0
  21. package/dist/cjs/generated/webhooks/types.js +4 -0
  22. package/dist/cjs/generated/webhooks/types.js.map +1 -0
  23. package/dist/cjs/index.d.ts +9 -0
  24. package/dist/cjs/index.d.ts.map +1 -0
  25. package/dist/cjs/index.js +16 -0
  26. package/dist/cjs/index.js.map +1 -0
  27. package/dist/cjs/management.d.ts +3 -0
  28. package/dist/cjs/management.d.ts.map +1 -0
  29. package/dist/cjs/management.js +22 -0
  30. package/dist/cjs/management.js.map +1 -0
  31. package/dist/cjs/package.json +3 -0
  32. package/dist/cjs/runtime/errors.d.ts +18 -0
  33. package/dist/cjs/runtime/errors.d.ts.map +1 -0
  34. package/dist/cjs/runtime/errors.js +41 -0
  35. package/dist/cjs/runtime/errors.js.map +1 -0
  36. package/dist/cjs/runtime/http.d.ts +20 -0
  37. package/dist/cjs/runtime/http.d.ts.map +1 -0
  38. package/dist/cjs/runtime/http.js +121 -0
  39. package/dist/cjs/runtime/http.js.map +1 -0
  40. package/dist/cjs/runtime/options.d.ts +12 -0
  41. package/dist/cjs/runtime/options.d.ts.map +1 -0
  42. package/dist/{types.js → cjs/runtime/options.js} +1 -1
  43. package/dist/cjs/runtime/options.js.map +1 -0
  44. package/dist/cjs/storefront.d.ts +3 -0
  45. package/dist/cjs/storefront.d.ts.map +1 -0
  46. package/dist/cjs/storefront.js +22 -0
  47. package/dist/cjs/storefront.js.map +1 -0
  48. package/dist/cjs/webhooks.d.ts +2 -0
  49. package/dist/cjs/webhooks.d.ts.map +1 -0
  50. package/dist/cjs/webhooks.js +18 -0
  51. package/dist/cjs/webhooks.js.map +1 -0
  52. package/dist/esm/generated/management/client.d.ts +902 -0
  53. package/dist/esm/generated/management/client.d.ts.map +1 -0
  54. package/dist/esm/generated/management/client.js +1545 -0
  55. package/dist/esm/generated/management/client.js.map +1 -0
  56. package/dist/esm/generated/management/types.d.ts +7771 -0
  57. package/dist/esm/generated/management/types.d.ts.map +1 -0
  58. package/dist/esm/generated/management/types.js +3 -0
  59. package/dist/esm/generated/management/types.js.map +1 -0
  60. package/dist/esm/generated/storefront/client.d.ts +229 -0
  61. package/dist/esm/generated/storefront/client.d.ts.map +1 -0
  62. package/dist/esm/generated/storefront/client.js +340 -0
  63. package/dist/esm/generated/storefront/client.js.map +1 -0
  64. package/dist/esm/generated/storefront/types.d.ts +3076 -0
  65. package/dist/esm/generated/storefront/types.d.ts.map +1 -0
  66. package/dist/esm/generated/storefront/types.js +3 -0
  67. package/dist/esm/generated/storefront/types.js.map +1 -0
  68. package/dist/esm/generated/webhooks/types.d.ts +3113 -0
  69. package/dist/esm/generated/webhooks/types.d.ts.map +1 -0
  70. package/dist/esm/generated/webhooks/types.js +3 -0
  71. package/dist/esm/generated/webhooks/types.js.map +1 -0
  72. package/dist/esm/index.d.ts +9 -0
  73. package/dist/esm/index.d.ts.map +1 -0
  74. package/dist/esm/index.js +5 -0
  75. package/dist/esm/index.js.map +1 -0
  76. package/dist/esm/management.d.ts +3 -0
  77. package/dist/esm/management.d.ts.map +1 -0
  78. package/dist/esm/management.js +3 -0
  79. package/dist/esm/management.js.map +1 -0
  80. package/dist/esm/package.json +3 -0
  81. package/dist/esm/runtime/errors.d.ts +18 -0
  82. package/dist/esm/runtime/errors.d.ts.map +1 -0
  83. package/dist/esm/runtime/errors.js +36 -0
  84. package/dist/esm/runtime/errors.js.map +1 -0
  85. package/dist/esm/runtime/http.d.ts +20 -0
  86. package/dist/esm/runtime/http.d.ts.map +1 -0
  87. package/dist/esm/runtime/http.js +117 -0
  88. package/dist/esm/runtime/http.js.map +1 -0
  89. package/dist/esm/runtime/options.d.ts +12 -0
  90. package/dist/esm/runtime/options.d.ts.map +1 -0
  91. package/dist/esm/runtime/options.js +2 -0
  92. package/dist/esm/runtime/options.js.map +1 -0
  93. package/dist/esm/storefront.d.ts +3 -0
  94. package/dist/esm/storefront.d.ts.map +1 -0
  95. package/dist/esm/storefront.js +3 -0
  96. package/dist/esm/storefront.js.map +1 -0
  97. package/dist/esm/webhooks.d.ts +2 -0
  98. package/dist/esm/webhooks.d.ts.map +1 -0
  99. package/dist/esm/webhooks.js +2 -0
  100. package/dist/esm/webhooks.js.map +1 -0
  101. package/package.json +74 -15
  102. package/dist/client.d.ts +0 -73
  103. package/dist/client.d.ts.map +0 -1
  104. package/dist/client.js +0 -55
  105. package/dist/client.js.map +0 -1
  106. package/dist/errors.d.ts +0 -7
  107. package/dist/errors.d.ts.map +0 -1
  108. package/dist/errors.js +0 -14
  109. package/dist/errors.js.map +0 -1
  110. package/dist/generate.d.ts +0 -2
  111. package/dist/generate.d.ts.map +0 -1
  112. package/dist/generate.js +0 -102
  113. package/dist/generate.js.map +0 -1
  114. package/dist/generated/management.d.ts +0 -12767
  115. package/dist/generated/management.d.ts.map +0 -1
  116. package/dist/generated/management.js +0 -638
  117. package/dist/generated/management.js.map +0 -1
  118. package/dist/generated/storefront.d.ts +0 -3464
  119. package/dist/generated/storefront.d.ts.map +0 -1
  120. package/dist/generated/storefront.js +0 -90
  121. package/dist/generated/storefront.js.map +0 -1
  122. package/dist/generated/webhooks.d.ts +0 -3659
  123. package/dist/generated/webhooks.d.ts.map +0 -1
  124. package/dist/generated/webhooks.js +0 -5
  125. package/dist/generated/webhooks.js.map +0 -1
  126. package/dist/index.d.ts +0 -12
  127. package/dist/index.d.ts.map +0 -1
  128. package/dist/index.js +0 -10
  129. package/dist/index.js.map +0 -1
  130. package/dist/management.d.ts +0 -7
  131. package/dist/management.d.ts.map +0 -1
  132. package/dist/management.js +0 -12
  133. package/dist/management.js.map +0 -1
  134. package/dist/storefront.d.ts +0 -7
  135. package/dist/storefront.d.ts.map +0 -1
  136. package/dist/storefront.js +0 -13
  137. package/dist/storefront.js.map +0 -1
  138. package/dist/types.d.ts +0 -12
  139. package/dist/types.d.ts.map +0 -1
  140. package/dist/types.js.map +0 -1
@@ -1,3464 +0,0 @@
1
- export interface paths {
2
- "/v1/store/cart": {
3
- parameters: {
4
- query?: never;
5
- header?: never;
6
- path?: never;
7
- cookie?: never;
8
- };
9
- /**
10
- * Get cart
11
- * @description Retrieves the current customer's shopping cart.
12
- */
13
- get: operations["Cart_GetCart"];
14
- put?: never;
15
- post?: never;
16
- /**
17
- * Clear cart
18
- * @description Clears all items from the customer's shopping cart.
19
- */
20
- delete: operations["Cart_ClearCart"];
21
- options?: never;
22
- head?: never;
23
- patch?: never;
24
- trace?: never;
25
- };
26
- "/v1/store/cart/lines": {
27
- parameters: {
28
- query?: never;
29
- header?: never;
30
- path?: never;
31
- cookie?: never;
32
- };
33
- get?: never;
34
- /**
35
- * Add product to cart
36
- * @description Adds a product to the cart or updates the quantity of an existing product.
37
- * When increment parameter is "true" or "1", the specified quantity will be added to any existing quantity.
38
- * Otherwise, the quantity will be set to the specified value, replacing any existing quantity.
39
- */
40
- put: operations["Cart_AddLine"];
41
- post?: never;
42
- delete?: never;
43
- options?: never;
44
- head?: never;
45
- patch?: never;
46
- trace?: never;
47
- };
48
- "/v1/store/cart/checkout": {
49
- parameters: {
50
- query?: never;
51
- header?: never;
52
- path?: never;
53
- cookie?: never;
54
- };
55
- get?: never;
56
- put?: never;
57
- /**
58
- * Create a cart checkout session
59
- * @description Creates a checkout session from the contents of the cart.
60
- * After creating the checkout session, redirect the customer to the `url` returned.
61
- */
62
- post: operations["Cart_CreateCartCheckout"];
63
- delete?: never;
64
- options?: never;
65
- head?: never;
66
- patch?: never;
67
- trace?: never;
68
- };
69
- "/v1/checkouts": {
70
- parameters: {
71
- query?: never;
72
- header?: never;
73
- path?: never;
74
- cookie?: never;
75
- };
76
- get?: never;
77
- put?: never;
78
- /**
79
- * Create a checkout session
80
- * @description Creates a checkout session using a Customer token.
81
- * After creating the checkout session, redirect the customer to the `url` returned.
82
- */
83
- post: operations["Checkout_CreateCheckoutSession"];
84
- delete?: never;
85
- options?: never;
86
- head?: never;
87
- patch?: never;
88
- trace?: never;
89
- };
90
- "/v1/store/customer/auth": {
91
- parameters: {
92
- query?: never;
93
- header?: never;
94
- path?: never;
95
- cookie?: never;
96
- };
97
- get?: never;
98
- put?: never;
99
- /**
100
- * Authenticate customer
101
- * @description Creates a customer and returns a customer token from a platform account.
102
- */
103
- post: operations["Customer_AuthenticateStorefrontCustomer"];
104
- delete?: never;
105
- options?: never;
106
- head?: never;
107
- patch?: never;
108
- trace?: never;
109
- };
110
- "/v1/store/customer": {
111
- parameters: {
112
- query?: never;
113
- header?: never;
114
- path?: never;
115
- cookie?: never;
116
- };
117
- /**
118
- * Get current customer
119
- * @description Retrieves the current customer from the passed Customer token.
120
- */
121
- get: operations["Customer_GetStorefrontCustomer"];
122
- put?: never;
123
- post?: never;
124
- delete?: never;
125
- options?: never;
126
- head?: never;
127
- patch?: never;
128
- trace?: never;
129
- };
130
- "/v1/store/customer/giftcards/lookup/{code}": {
131
- parameters: {
132
- query?: never;
133
- header?: never;
134
- path?: never;
135
- cookie?: never;
136
- };
137
- /** Lookup a gift card by the code */
138
- get: operations["Customer_GetStorefrontGiftCard"];
139
- put?: never;
140
- post?: never;
141
- delete?: never;
142
- options?: never;
143
- head?: never;
144
- patch?: never;
145
- trace?: never;
146
- };
147
- "/v1/store/customer/delivery/items": {
148
- parameters: {
149
- query?: never;
150
- header?: never;
151
- path?: never;
152
- cookie?: never;
153
- };
154
- /**
155
- * Get the customers delivery items
156
- * @description Retrieves the current customers delivery items.
157
- */
158
- get: operations["Delivery_GetStorefrontCustomerDeliveryItems"];
159
- put?: never;
160
- post?: never;
161
- delete?: never;
162
- options?: never;
163
- head?: never;
164
- patch?: never;
165
- trace?: never;
166
- };
167
- "/v1/store/customer/command-delivery": {
168
- parameters: {
169
- query?: never;
170
- header?: never;
171
- path?: never;
172
- cookie?: never;
173
- };
174
- get?: never;
175
- put?: never;
176
- post?: never;
177
- delete?: never;
178
- options?: never;
179
- head?: never;
180
- patch?: never;
181
- trace?: never;
182
- };
183
- "/v1/stores/{storeId}/product_versions/discord_actions": {
184
- parameters: {
185
- query?: never;
186
- header?: never;
187
- path?: never;
188
- cookie?: never;
189
- };
190
- get: operations["Discord_DoProductsHaveDiscordActions"];
191
- put?: never;
192
- post?: never;
193
- delete?: never;
194
- options?: never;
195
- head?: never;
196
- patch?: never;
197
- trace?: never;
198
- };
199
- "/v1/store/navlinks": {
200
- parameters: {
201
- query?: never;
202
- header?: never;
203
- path?: never;
204
- cookie?: never;
205
- };
206
- /**
207
- * Get navlinks
208
- * @description Retrieves the store's navlink structure used for navigation.
209
- */
210
- get: operations["Navlinks_GetStorefrontNavLinks"];
211
- put?: never;
212
- post?: never;
213
- delete?: never;
214
- options?: never;
215
- head?: never;
216
- patch?: never;
217
- trace?: never;
218
- };
219
- "/v1/store/products": {
220
- parameters: {
221
- query?: never;
222
- header?: never;
223
- path?: never;
224
- cookie?: never;
225
- };
226
- /**
227
- * Get products
228
- * @description Retrieves the available products. To make sure all VAT rates are properly displayed, pass in the IP headers as instructed.
229
- */
230
- get: operations["Products_GetStorefrontProducts"];
231
- put?: never;
232
- post?: never;
233
- delete?: never;
234
- options?: never;
235
- head?: never;
236
- patch?: never;
237
- trace?: never;
238
- };
239
- "/v1/store/products/{idOrSlug}": {
240
- parameters: {
241
- query?: never;
242
- header?: never;
243
- path?: never;
244
- cookie?: never;
245
- };
246
- /**
247
- * Get product by ID or slug
248
- * @description Retrieves a product by an ID or a slug. To make sure all VAT rates are properly displayed, pass in the IP headers as instructed.
249
- */
250
- get: operations["Products_GetStorefrontProductByIdOrSlug"];
251
- put?: never;
252
- post?: never;
253
- delete?: never;
254
- options?: never;
255
- head?: never;
256
- patch?: never;
257
- trace?: never;
258
- };
259
- "/v1/store": {
260
- parameters: {
261
- query?: never;
262
- header?: never;
263
- path?: never;
264
- cookie?: never;
265
- };
266
- /**
267
- * Get current store
268
- * @description Retrieves a store by the passed in x-paynow-store-id or Customer token.
269
- */
270
- get: operations["Store_GetStorefrontStore"];
271
- put?: never;
272
- post?: never;
273
- delete?: never;
274
- options?: never;
275
- head?: never;
276
- patch?: never;
277
- trace?: never;
278
- };
279
- "/v1/store/customer/subscriptions": {
280
- parameters: {
281
- query?: never;
282
- header?: never;
283
- path?: never;
284
- cookie?: never;
285
- };
286
- /**
287
- * Get subscriptions
288
- * @description Retrieves all subscriptions for the specified customer token.
289
- * {% hint style="warning" %}
290
- * This endpoint is only available for stores that use Steam based authentication.
291
- * {% endhint %}
292
- */
293
- get: operations["Subscriptions_GetSubscriptions"];
294
- put?: never;
295
- post?: never;
296
- delete?: never;
297
- options?: never;
298
- head?: never;
299
- patch?: never;
300
- trace?: never;
301
- };
302
- "/v1/store/customer/subscriptions/{subscriptionId}": {
303
- parameters: {
304
- query?: never;
305
- header?: never;
306
- path?: never;
307
- cookie?: never;
308
- };
309
- /**
310
- * Get subscription by ID
311
- * @description Retrieves a subscription for the specified store by the supplied customer token.
312
- * {% hint style="warning" %}
313
- * This endpoint is only available for stores that use Steam based authentication.
314
- * {% endhint %}
315
- */
316
- get: operations["Subscriptions_GetSubscriptionById"];
317
- put?: never;
318
- post?: never;
319
- /**
320
- * Cancel subscription by ID
321
- * @description Cancels a subscription for the specified store by the supplied customer token.
322
- * {% hint style="warning" %}
323
- * This endpoint is only available for stores that use Steam based authentication.
324
- * {% endhint %}
325
- */
326
- delete: operations["Subscriptions_CancelSubscription"];
327
- options?: never;
328
- head?: never;
329
- patch?: never;
330
- trace?: never;
331
- };
332
- "/v1/store/tags": {
333
- parameters: {
334
- query?: never;
335
- header?: never;
336
- path?: never;
337
- cookie?: never;
338
- };
339
- /**
340
- * Get tags
341
- * @description Retrieves the store's tags.
342
- */
343
- get: operations["Tags_GetStorefrontTags"];
344
- put?: never;
345
- post?: never;
346
- delete?: never;
347
- options?: never;
348
- head?: never;
349
- patch?: never;
350
- trace?: never;
351
- };
352
- "/v1/store/tier-groups": {
353
- parameters: {
354
- query?: never;
355
- header?: never;
356
- path?: never;
357
- cookie?: never;
358
- };
359
- /**
360
- * Get customer tier groups
361
- * @description Retrieves tier group state for a logged in customer. Returns an empty array if not logged in.
362
- */
363
- get: operations["TierGroups_GetCustomerTierGroups"];
364
- put?: never;
365
- post?: never;
366
- delete?: never;
367
- options?: never;
368
- head?: never;
369
- patch?: never;
370
- trace?: never;
371
- };
372
- "/v1/store/tier-groups/{id}/change": {
373
- parameters: {
374
- query?: never;
375
- header?: never;
376
- path?: never;
377
- cookie?: never;
378
- };
379
- get?: never;
380
- put?: never;
381
- /**
382
- * Update subscription tier group
383
- * @description Upgrades or downgrades an existing subscription tier group. The customer must have an active subscription within this tier group.
384
- */
385
- post: operations["TierGroups_UpdateSubscriptionTierGroup"];
386
- delete?: never;
387
- options?: never;
388
- head?: never;
389
- patch?: never;
390
- trace?: never;
391
- };
392
- "/v1/store/tier-groups/{id}/change/preview": {
393
- parameters: {
394
- query?: never;
395
- header?: never;
396
- path?: never;
397
- cookie?: never;
398
- };
399
- get?: never;
400
- put?: never;
401
- /**
402
- * Preview update subscription tier group
403
- * @description Previews an upgrade or a downgrade an existing subscription tier group. The customer must have an active subscription within this tier group.
404
- */
405
- post: operations["TierGroups_UpdateSubscriptionTierGroupPreview"];
406
- delete?: never;
407
- options?: never;
408
- head?: never;
409
- patch?: never;
410
- trace?: never;
411
- };
412
- }
413
- export type webhooks = Record<string, never>;
414
- export interface components {
415
- schemas: {
416
- ActorDto: {
417
- type: components["schemas"]["PayNowActorType"];
418
- id?: components["schemas"]["FlakeId"];
419
- };
420
- /** @description Alipay payment method details */
421
- AlipayDetailsDto: {
422
- /**
423
- * @description The Alipay buyer identifier
424
- * @example buyer_abc123
425
- */
426
- buyer_id?: null | string;
427
- /**
428
- * @description A unique fingerprint for this Alipay account
429
- * @example fingerprint_xyz789
430
- */
431
- fingerprint?: null | string;
432
- };
433
- AuthenticateStorefrontCustomerRequestDto: {
434
- platform: components["schemas"]["CustomerProfilePlatform"];
435
- /**
436
- * @description The account ID on the platform
437
- * @example 76561198152492642
438
- */
439
- id: string;
440
- };
441
- AuthenticateStorefrontCustomerResponseDto: {
442
- /** @description The token for the Customer */
443
- customer_token: string;
444
- };
445
- /** @description Bancontact payment method details */
446
- BancontactDetailsDto: {
447
- /**
448
- * @description The bank identifier
449
- * @example bnp_paribas
450
- */
451
- bank?: null | string;
452
- /**
453
- * @description The bank name
454
- * @example BNP Paribas
455
- */
456
- bank_name?: null | string;
457
- /**
458
- * @description The Bank Identifier Code
459
- * @example GEBABEBB
460
- */
461
- bic?: null | string;
462
- /**
463
- * @description The last 4 digits of the IBAN
464
- * @example 3456
465
- */
466
- iban_last4?: null | string;
467
- /**
468
- * @description The payer name
469
- * @example Jean Dupont
470
- */
471
- payer_name?: null | string;
472
- };
473
- /** @description Card payment method details */
474
- CardDetailsDto: {
475
- /**
476
- * @description The card brand
477
- * @example visa
478
- */
479
- brand: string;
480
- /**
481
- * @description The country code where the card was issued
482
- * @example US
483
- */
484
- country: string;
485
- /**
486
- * Format: int32
487
- * @description The card expiration month
488
- * @example 12
489
- */
490
- exp_month: number;
491
- /**
492
- * Format: int32
493
- * @description The card expiration year
494
- * @example 2028
495
- */
496
- exp_year: number;
497
- /**
498
- * @description A unique fingerprint for this card
499
- * @example abc123def456
500
- */
501
- fingerprint: string;
502
- /**
503
- * @description The card funding type
504
- * @example credit
505
- */
506
- funding: string;
507
- /**
508
- * @description The last 4 digits of the card number
509
- * @example 4242
510
- */
511
- last4: string;
512
- /**
513
- * @description The Bank Identification Number (first 6/8 digits of card).
514
- * Only available internally.
515
- * @example 424242
516
- */
517
- bin?: null | string;
518
- /**
519
- * @description The card issuer/bank name.
520
- * Only available internally.
521
- * @example Chase Bank
522
- */
523
- issuer?: null | string;
524
- /**
525
- * @description The card description.
526
- * Only available internally.
527
- * @example Visa Signature
528
- */
529
- description?: null | string;
530
- wallet?: components["schemas"]["CardWalletDto"];
531
- };
532
- /** @description Digital wallet details for a card */
533
- CardWalletDto: {
534
- /**
535
- * @description The type of digital wallet
536
- * @example apple_pay
537
- */
538
- type: string;
539
- };
540
- /** @description Represents a customer's shopping cart */
541
- CartDto: {
542
- store_id: components["schemas"]["FlakeId"];
543
- customer_id: components["schemas"]["FlakeId"];
544
- /** @description The line items in the cart */
545
- lines: components["schemas"]["CartLineDto"][];
546
- /**
547
- * Format: int64
548
- * @description The total price of all items in the cart in the smallest currency unit (e.g., cents)
549
- */
550
- total: number;
551
- /** @description The currency code (e.g., usd, eur, gbp) */
552
- currency: string;
553
- };
554
- CartLineCustomVariableDto: {
555
- id: components["schemas"]["FlakeId"];
556
- /** @description The display name of the custom variable */
557
- name: string;
558
- /** @description The unique identifier string for the custom variable */
559
- identifier: string;
560
- /** @description The description of the custom variable */
561
- description: string;
562
- type: components["schemas"]["CustomVariableType"];
563
- /** @description The selected value of the custom variable */
564
- value: string;
565
- /** @description The collection of available options for this custom variable. Only present for dropdown type */
566
- options: components["schemas"]["StorefrontCustomVariableOptionDto"][];
567
- selected_option?: components["schemas"]["StorefrontCustomVariableOptionDto"];
568
- };
569
- /** @description Represents a line item in a cart */
570
- CartLineDto: {
571
- /** @description The unique key for this line item */
572
- line_key: string;
573
- product_id: components["schemas"]["FlakeId"];
574
- /** @description The name of the product */
575
- name: string;
576
- /** @description The slug of the product */
577
- slug: string;
578
- /**
579
- * Format: int64
580
- * @description The price of the product in the smallest currency unit (e.g., cents)
581
- */
582
- price: number;
583
- /**
584
- * Format: int32
585
- * @description The quantity of this product in the cart
586
- */
587
- quantity: number;
588
- /** @description Indicates whether this line item should be a subscription */
589
- subscription: boolean;
590
- /** @description Indicates whether this line will be trialied by the customer. */
591
- trial: boolean;
592
- /** @description The URL to the product image */
593
- image_url?: null | string;
594
- selected_gameserver_id?: components["schemas"]["FlakeId"];
595
- selected_gameserver?: components["schemas"]["StorefrontGameServerDto"];
596
- pricing: components["schemas"]["StorefrontProductPricingDetailsDto"];
597
- /** @description Selected custom variables for this cart line. */
598
- custom_variables: components["schemas"]["CartLineCustomVariableDto"][];
599
- gift_to_customer?: components["schemas"]["CustomerDto"];
600
- gift_to_customer_id?: components["schemas"]["FlakeId"];
601
- };
602
- /** @description Cash App payment method details */
603
- CashAppDetailsDto: {
604
- /**
605
- * @description The Cash App buyer identifier
606
- * @example buyer_abc123
607
- */
608
- buyer_id: string;
609
- /**
610
- * @description The Cash App cashtag
611
- * @example $johndoe
612
- */
613
- cashtag: string;
614
- };
615
- /** @description Payment outcome information returned after a subscription change triggers an immediate charge. */
616
- CheckoutPaymentInfoDto: {
617
- /** @description Status string from the payment provider. */
618
- status: string;
619
- /** @description Indicates whether the payment was declined. */
620
- declined: boolean;
621
- /** @description The customer readable decline reason, if the payment was declined. */
622
- decline_message?: null | string;
623
- /** @description Checkout URL to redirect to for on-session payments. */
624
- checkout_url?: null | string;
625
- };
626
- /** @description Request to create a new checkout session from a cart */
627
- CreateCartCheckoutSessionDto: {
628
- coupon_id?: components["schemas"]["FlakeId"];
629
- /** @description Optional array of promo codes (coupons, gift cards, affiliates) to apply.
630
- * An invalid promo code will cause an error. */
631
- promo_codes?: null | string[];
632
- /** @description Optional affiliate code to track referrals.
633
- * An invalid affiliate code will NOT cause an error. */
634
- affiliate_code?: null | string;
635
- /** @description Optional URL to redirect to after successful checkout */
636
- return_url?: null | string;
637
- /** @description Optional URL to redirect to if checkout is canceled */
638
- cancel_url?: null | string;
639
- /** @description Whether to automatically redirect the customer (return_url must be set) */
640
- auto_redirect?: null | boolean;
641
- };
642
- /** @description Represents a line item in a checkout session request */
643
- CreateCheckoutSessionLineDto: {
644
- product_id: components["schemas"]["FlakeId"];
645
- /** @description Determines whether this line should create a subscription */
646
- subscription?: null | boolean;
647
- /** @description Indicates whether the product should be trialed */
648
- trial?: null | boolean;
649
- gift_to?: components["schemas"]["CustomerPlatformAccountDto"];
650
- gift_to_customer_id?: components["schemas"]["FlakeId"];
651
- /**
652
- * Format: int32
653
- * @description The quantity of this product to purchase
654
- */
655
- quantity: number;
656
- selected_gameserver_id?: components["schemas"]["FlakeId"];
657
- /** @description Key-value pair mapping custom variable identifiers to their selected values.
658
- * Required only when the product includes custom variables. */
659
- custom_variables?: null | {
660
- [key: string]: string;
661
- };
662
- };
663
- /** @description Request to create a new checkout session */
664
- CreateCheckoutSessionRequestDto: {
665
- /** @description The line items to include in the checkout. */
666
- lines: components["schemas"]["CreateCheckoutSessionLineDto"][];
667
- coupon_id?: components["schemas"]["FlakeId"];
668
- /** @description Optional array of promo codes (coupons, gift cards, affiliates) to apply.
669
- * An invalid promo code will cause an error. */
670
- promo_codes?: null | string[];
671
- /** @description Optional affiliate code to track referrals.
672
- * An invalid affiliate code will NOT cause an error. */
673
- affiliate_code?: null | string;
674
- /** @description Optional URL to redirect to after successful checkout */
675
- return_url?: null | string;
676
- /** @description Optional URL to redirect to if checkout is canceled */
677
- cancel_url?: null | string;
678
- /** @description Whether to automatically redirect the customer (return_url must be set) */
679
- auto_redirect?: null | boolean;
680
- };
681
- /** @description Response after creating a checkout session */
682
- CreateCheckoutSessionResponseDto: {
683
- id: components["schemas"]["FlakeId"];
684
- /** @description The token for the checkout session */
685
- token: string;
686
- /** @description The URL to redirect the customer to complete checkout */
687
- url: string;
688
- };
689
- /** @description Cryptocurrency payment method details */
690
- CryptoDetailsDto: {
691
- /**
692
- * @description The cryptocurrency used
693
- * @example BTC
694
- */
695
- crypto_currency: string;
696
- /**
697
- * @description The amount in cryptocurrency
698
- * @example 0.00150000
699
- */
700
- crypto_amount: string;
701
- /**
702
- * @description The total amount paid in cryptocurrency
703
- * @example 0.00150000
704
- */
705
- total_paid: string;
706
- /**
707
- * Format: int32
708
- * @description The number of blockchain confirmations
709
- * @example 6
710
- */
711
- confirmations: number;
712
- };
713
- CustomVariableLineItemDto: {
714
- id: components["schemas"]["FlakeId"];
715
- /** @description The identifier used to reference this custom variable (e.g., "color", "size"). */
716
- identifier: string;
717
- /** @description The display name of the custom variable shown to users. */
718
- name: string;
719
- /** @description A detailed description of what this custom variable represents. */
720
- description: string;
721
- /**
722
- * Format: int64
723
- * @description The price associated with this custom variable in the smallest currency unit (e.g., cents).
724
- */
725
- price: number;
726
- /** @description The selected value for this custom variable. */
727
- value: string;
728
- };
729
- /**
730
- * @description Defines the type of input method for a custom variable.
731
- * @enum {string}
732
- */
733
- CustomVariableType: "dropdown" | "text" | "number";
734
- /** @description Represents a customer in the PayNow system with their associated profiles and metadata. */
735
- CustomerDto: {
736
- id: components["schemas"]["FlakeId"];
737
- store_id: components["schemas"]["FlakeId"];
738
- profile?: components["schemas"]["GenericProfileDto"];
739
- steam_id?: components["schemas"]["SteamId"];
740
- steam?: components["schemas"]["SteamProfileDto"];
741
- /**
742
- * @description The customer's Minecraft UUID, if they have linked their Minecraft account.
743
- * Not set for offline Minecraft stores. If the platform type is Minecraft - Geyser,
744
- * and the profile is a bedrock account, this will be a UUID generated from the Xbox XUID.
745
- * @example f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2
746
- */
747
- minecraft_uuid?: null | string;
748
- minecraft?: components["schemas"]["MinecraftProfileDto"];
749
- /** @description The customer's Xbox XUID, if available. */
750
- xbox_xuid?: null | string;
751
- minecraft_platform?: components["schemas"]["CustomerMinecraftPlatform"];
752
- /**
753
- * @description The display name for the customer.
754
- * @example m0uka
755
- */
756
- name?: null | string;
757
- /**
758
- * Format: date-time
759
- * @description The date and time when the customer was created in the system.
760
- */
761
- created_at: string;
762
- /**
763
- * Format: date-time
764
- * @description The date and time when the customer was last updated, if applicable.
765
- */
766
- updated_at?: null | string;
767
- /** @description Additional custom data associated with the customer. */
768
- metadata: {
769
- [key: string]: string;
770
- };
771
- };
772
- /** @enum {string} */
773
- CustomerMinecraftPlatform: "unknown" | "java" | "bedrock";
774
- /** @description Represents a customer platform association, used for gifting */
775
- CustomerPlatformAccountDto: {
776
- platform: components["schemas"]["CustomerProfilePlatform"];
777
- /**
778
- * @description The account ID on the platform
779
- * @example 76561198152492642
780
- */
781
- id: string;
782
- };
783
- /** @enum {string} */
784
- CustomerProfilePlatform: "invalid" | "steam" | "minecraft" | "paynow_name" | "paynow" | "minecraft_java_name" | "minecraft_bedrock_name" | "xbox_xuid" | "minecraft_uuid";
785
- CustomerTierGroupDto: {
786
- tier_group_id: components["schemas"]["FlakeId"];
787
- active_product_id: components["schemas"]["FlakeId"];
788
- pending_change_product_id?: components["schemas"]["FlakeId"];
789
- /**
790
- * Format: date-time
791
- * @description The date and time of the next subscription renewal for this tier group.
792
- */
793
- next_renewal_at: string;
794
- /**
795
- * Format: int64
796
- * @description The next billing amount in the smallest currency unit (e.g., cents) in the settlement currency.
797
- */
798
- next_billing_amount: number;
799
- /**
800
- * Format: int64
801
- * @description The next billing amount in the smallest currency unit (e.g., cents) in the customer-facing presentment currency.
802
- */
803
- next_billing_presentment_amount: number;
804
- /** @description The settlement currency code (e.g., "usd"). */
805
- currency: string;
806
- /** @description The customer-facing presentment currency code (e.g., "eur"). */
807
- presentment_currency: string;
808
- };
809
- /** @description Represents the product information for a delivery item */
810
- DeliveryItemProductDto: {
811
- id: components["schemas"]["FlakeId"];
812
- /**
813
- * @description The name of the product
814
- * @example Premium Membership
815
- */
816
- name: string;
817
- /**
818
- * @description The URL-friendly slug of the product
819
- * @example premium-membership
820
- */
821
- slug: string;
822
- /**
823
- * @description The version identifier of the product
824
- * @example v2.1.0
825
- */
826
- version_id: string;
827
- };
828
- /** @enum {string} */
829
- DeliveryItemStateDto: "usable" | "active" | "used" | "revoked" | "renewed";
830
- /**
831
- * Format: flake-id
832
- * @example 411486491630370816
833
- */
834
- FlakeId: string;
835
- /** @description Represents a generic platform profile for a customer. */
836
- GenericProfileDto: {
837
- /** @description The platform-specific identifier for the profile. */
838
- id: string;
839
- /**
840
- * @description The name of the platform this profile belongs to.
841
- * @example steam
842
- */
843
- platform: string;
844
- /** @description The display name of the user on this platform. */
845
- name: string;
846
- /** @description The URL to the user's avatar image on this platform. */
847
- avatar_url?: null | string;
848
- };
849
- /** @description iDEAL payment method details */
850
- IdealDetailsDto: {
851
- /**
852
- * @description The bank identifier
853
- * @example abn_amro
854
- */
855
- bank: string;
856
- /**
857
- * @description The Bank Identifier Code
858
- * @example ABNANL2A
859
- */
860
- bic: string;
861
- /**
862
- * @description The last 4 digits of the IBAN
863
- * @example 1234
864
- */
865
- iban_last4?: null | string;
866
- /**
867
- * @description The payer name
868
- * @example John Doe
869
- */
870
- payer_name?: null | string;
871
- };
872
- /** @description Klarna payment method details */
873
- KlarnaDetailsDto: {
874
- /**
875
- * @description The country code
876
- * @example SE
877
- */
878
- country?: null | string;
879
- /**
880
- * @description The Klarna payment method category
881
- * @example pay_later
882
- */
883
- method_category?: null | string;
884
- };
885
- /** @description Link payment method details */
886
- LinkDetailsDto: {
887
- /**
888
- * @description The email associated with the Link account
889
- * @example john.doe@example.com
890
- */
891
- email: string;
892
- };
893
- /** @description Represents a Minecraft profile for a customer. */
894
- MinecraftProfileDto: {
895
- /**
896
- * @description The UUID of the Minecraft player.
897
- * If the platform is Minecraft Offline, this will be the name itself.
898
- * If the platform is Minecraft Geyser, and this is a Bedrock account, this ID will be an Xbox XUID.
899
- * @example f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2
900
- */
901
- id: string;
902
- /**
903
- * @description The username of the Minecraft player.
904
- * @example notch
905
- */
906
- name: string;
907
- /** @description The URL to the player's Minecraft skin rendered as an avatar. */
908
- avatar_url: string;
909
- };
910
- /** @description Przelewy24 payment method details */
911
- P24DetailsDto: {
912
- /**
913
- * @description The bank identifier
914
- * @example ing
915
- */
916
- bank: string;
917
- /**
918
- * @description The payer name
919
- * @example Jan Kowalski
920
- */
921
- payer_name?: null | string;
922
- };
923
- /** @description Pay by Bank payment method details */
924
- PayByBankDetailsDto: {
925
- /**
926
- * @description The bank name
927
- * @example Chase Bank
928
- */
929
- bank_name?: null | string;
930
- /**
931
- * @description The Bank Identifier Code
932
- * @example CHASUS33
933
- */
934
- bic?: null | string;
935
- /**
936
- * @description The country code
937
- * @example US
938
- */
939
- country?: null | string;
940
- /**
941
- * @description The payer name
942
- * @example John Smith
943
- */
944
- payer_name?: null | string;
945
- };
946
- /** @enum {string} */
947
- PayNowActorType: "anonymous" | "user" | "api_key" | "customer" | "game_server" | "internal" | "admin" | "platform" | "global_customer";
948
- /** @description Represents a PayNow error */
949
- PayNowError: {
950
- /**
951
- * Format: int32
952
- * @description The HTTP status code.
953
- * @example 400
954
- */
955
- status: number;
956
- /**
957
- * @description The PayNow parseable error code.
958
- * @example bad-request
959
- */
960
- code: string;
961
- /**
962
- * @description The human-readable error message.
963
- * @example Bad Request Example
964
- */
965
- message: string;
966
- /**
967
- * @description A distributed trace ID used for debugging.
968
- * @example 234a5bcd543ef3fa53ce929d0e0e4736
969
- */
970
- trace_id?: null | string;
971
- /** @description An array of multiple errors. Only used by some API services. */
972
- errors?: null | components["schemas"]["ValidationError"][];
973
- };
974
- /** @description PayPal payment method details */
975
- PayPalDetailsDto: {
976
- /**
977
- * @description The PayPal payer identifier
978
- * @example PAYERID123
979
- */
980
- payer_id: string;
981
- /**
982
- * @description The PayPal account email
983
- * @example john.doe@example.com
984
- */
985
- payer_email: string;
986
- /**
987
- * @description The PayPal account holder name
988
- * @example John Doe
989
- */
990
- payer_name: string;
991
- /**
992
- * @description The country code of the PayPal account
993
- * @example US
994
- */
995
- country: string;
996
- /**
997
- * @description Indicates if this PayPal account is vaulted
998
- * @example true
999
- */
1000
- vault: boolean;
1001
- /**
1002
- * @description Indicates if vault approval is pending
1003
- * @example false
1004
- */
1005
- pending_vault_approval?: null | boolean;
1006
- /**
1007
- * @description Indicates if this is a standalone setup
1008
- * @example false
1009
- */
1010
- standalone_setup?: null | boolean;
1011
- };
1012
- /** @description Contains detailed information about a payment method.
1013
- * DISCLAIMER: These fields are not guaranteed to be backwards compatible and may change or be removed without notice. */
1014
- PaymentMethodDetailsDto: {
1015
- card?: components["schemas"]["CardDetailsDto"];
1016
- cashapp?: components["schemas"]["CashAppDetailsDto"];
1017
- paypal?: components["schemas"]["PayPalDetailsDto"];
1018
- link?: components["schemas"]["LinkDetailsDto"];
1019
- crypto?: components["schemas"]["CryptoDetailsDto"];
1020
- steamskins?: components["schemas"]["SteamSkinsDetailsDto"];
1021
- ideal?: components["schemas"]["IdealDetailsDto"];
1022
- p24?: components["schemas"]["P24DetailsDto"];
1023
- bancontact?: components["schemas"]["BancontactDetailsDto"];
1024
- klarna?: components["schemas"]["KlarnaDetailsDto"];
1025
- alipay?: components["schemas"]["AlipayDetailsDto"];
1026
- pay_by_bank?: components["schemas"]["PayByBankDetailsDto"];
1027
- pix?: components["schemas"]["PixDetailsDto"];
1028
- paysafecard?: components["schemas"]["PaysafeCardDetailsDto"];
1029
- };
1030
- /** @description Represents a stored payment method */
1031
- PaymentMethodDto: {
1032
- id: components["schemas"]["FlakeId"];
1033
- customer_id: components["schemas"]["FlakeId"];
1034
- /** @description The payment gateway provider */
1035
- gateway: string;
1036
- /** @description The gateway's identifier for this payment method */
1037
- gateway_id: string;
1038
- /** @description The gateway's customer identifier */
1039
- gateway_customer_id: string;
1040
- /**
1041
- * @description The gateway-specific type identifier
1042
- * @example card
1043
- */
1044
- gateway_type: string;
1045
- /**
1046
- * @description The payment method type
1047
- * @example card
1048
- */
1049
- method_type: string;
1050
- method_details: components["schemas"]["PaymentMethodDetailsDto"];
1051
- /**
1052
- * Format: date-time
1053
- * @description The date and time when this payment method was created
1054
- * @example 2025-03-15T10:20:30Z
1055
- */
1056
- created_at: string;
1057
- /** @description The gateway entity identifier */
1058
- gateway_entity_identifier: string;
1059
- /**
1060
- * Format: date-time
1061
- * @description The date and time when this payment method was last updated
1062
- * @example 2025-03-20T14:30:00Z
1063
- */
1064
- updated_at?: null | string;
1065
- };
1066
- /** @description Paysafecard payment method details */
1067
- PaysafeCardDetailsDto: {
1068
- first_name?: null | string;
1069
- last_name?: null | string;
1070
- psc_id?: null | string;
1071
- association_id?: null | string;
1072
- };
1073
- /** @description Pix payment method details */
1074
- PixDetailsDto: {
1075
- /**
1076
- * @description The bank name
1077
- * @example Banco do Brasil
1078
- */
1079
- bank_name?: null | string;
1080
- /**
1081
- * @description The bank account number
1082
- * @example 12345-6
1083
- */
1084
- bank_account_number?: null | string;
1085
- /**
1086
- * @description The payer name
1087
- * @example João Silva
1088
- */
1089
- payer_name?: null | string;
1090
- };
1091
- /** @enum {string} */
1092
- PlatformCapability: "invalid" | "connected_users";
1093
- PlatformStoreTypeAssociationDetailsDto: {
1094
- platform_id: components["schemas"]["FlakeId"];
1095
- associated_platform?: components["schemas"]["PublicPlatformDto"];
1096
- /** @description The store platform identifier string (e.g. "rust", "minecraft"). */
1097
- store_platform: string;
1098
- /**
1099
- * Format: int64
1100
- * @description Overrides the default PayNow platform fee percentage for this association.
1101
- * Expressed in basis points (e.g. 250 = 2.50%).
1102
- */
1103
- paynow_platform_fee_percentage_override?: null | number;
1104
- /**
1105
- * Format: int64
1106
- * @description The fee percentage charged by the connected platform.
1107
- * Expressed in basis points (e.g. 250 = 2.50%).
1108
- */
1109
- connected_platform_fee_percentage?: null | number;
1110
- /**
1111
- * Format: int64
1112
- * @description The payout ID associated with the connected platform.
1113
- */
1114
- connected_platform_wallet_id?: null | number;
1115
- /** @description When true, billing plans are disabled for this platform/store type combination. */
1116
- disable_billing_plans: boolean;
1117
- /** @description When true, legal or compliance disclaimers should be displayed to the end user. */
1118
- display_disclaimers: boolean;
1119
- /** @description Whether the management hides some PayNow UI */
1120
- full_external_management: boolean;
1121
- };
1122
- /** @enum {string} */
1123
- PlatformType: "invalid" | "marketplace" | "store_platform" | "other";
1124
- ProductDeliverableActionsDto: {
1125
- /** @description Value indicating whether to grant a giftcard with the product with the subtotal amount. */
1126
- grant_giftcard: boolean;
1127
- };
1128
- ProductGameServerDto: {
1129
- id: components["schemas"]["FlakeId"];
1130
- /**
1131
- * @description The name of the game server.
1132
- * @example US 2x TRIO
1133
- */
1134
- name: string;
1135
- /** @description Indicates whether this game server is enabled. */
1136
- enabled: boolean;
1137
- };
1138
- /** @enum {string} */
1139
- ProductRemoveAfterIntervalScale: "invalid" | "day" | "week" | "month";
1140
- /** @enum {string} */
1141
- ProductSubscriptionIntervalScale: "invalid" | "day" | "week" | "month" | "year";
1142
- ProductTagDto: {
1143
- id: components["schemas"]["FlakeId"];
1144
- /**
1145
- * @description The unique slug for the tag.
1146
- * @example packages
1147
- */
1148
- slug: string;
1149
- /**
1150
- * @description The display name of the tag.
1151
- * @example Packages
1152
- */
1153
- name: string;
1154
- };
1155
- /**
1156
- * @description Describes how proration is handled when a subscription change is applied.
1157
- * @enum {string}
1158
- */
1159
- ProrationBehaviorDto: "invalid" | "immediate" | "next_billing_period" | "none";
1160
- PublicPlatformDto: {
1161
- id: components["schemas"]["FlakeId"];
1162
- slug: string;
1163
- type: components["schemas"]["PlatformType"];
1164
- country_code: string;
1165
- business_name: string;
1166
- name: string;
1167
- description: string;
1168
- website_url: string;
1169
- logo_url: string;
1170
- accent_color: string;
1171
- capabilities: components["schemas"]["PlatformCapability"][];
1172
- /** Format: date-time */
1173
- created_at: string;
1174
- /** Format: date-time */
1175
- updated_at: string;
1176
- /** Format: date-time */
1177
- disabled_at?: null | string;
1178
- };
1179
- /** @enum {string} */
1180
- SaleDiscountType: "percent" | "amount";
1181
- /** @description Object representing a sales tax jurisdiction and its associated taxes. */
1182
- SalesTaxJurisdictionDto: {
1183
- /**
1184
- * @description The name of the tax jurisdiction.
1185
- * @example EU OSS
1186
- */
1187
- name: string;
1188
- /** @description List of taxes applied within this jurisdiction. */
1189
- taxes: components["schemas"]["SalesTaxJurisdictionTaxDto"][];
1190
- /** @description Explanation for why taxes are not applied, if applicable.
1191
- * This property is null when taxes are applied. */
1192
- not_taxed_reason?: null | string;
1193
- };
1194
- /** @description Object representing a specific tax within a sales tax jurisdiction. */
1195
- SalesTaxJurisdictionTaxDto: {
1196
- /** @description The name of the tax. */
1197
- tax_name: string;
1198
- /** @description The amount subject to taxation, formatted as a string. */
1199
- taxable_amount: string;
1200
- /** @description The calculated tax amount, formatted as a string. */
1201
- tax_amount: string;
1202
- /** @description The rate at which the tax is applied, formatted as a string. */
1203
- tax_rate: string;
1204
- };
1205
- /**
1206
- * Format: steam-id
1207
- * @description A 64-bit Steam account identifier. Accepts string or numeric format.
1208
- * @example 76561197960287930
1209
- */
1210
- SteamId: string;
1211
- /** @description Represents a Steam profile for a customer. */
1212
- SteamProfileDto: {
1213
- id: components["schemas"]["SteamId"];
1214
- /** @description The display name of the user on Steam. */
1215
- name: string;
1216
- /** @description The URL to the user's Steam avatar image. */
1217
- avatar_url: string;
1218
- };
1219
- /** @description Steam Skins payment method details */
1220
- SteamSkinsDetailsDto: {
1221
- /** @description The list of Steam inventory items used for payment */
1222
- items: components["schemas"]["SteamSkinsInventoryItemDetailsDto"][];
1223
- };
1224
- SteamSkinsInventoryItemDetailsDto: {
1225
- /** @description The unique identifier of the Steam item */
1226
- id: string;
1227
- /**
1228
- * Format: int32
1229
- * @description The Steam app ID
1230
- * @example 730
1231
- */
1232
- app_id: number;
1233
- /**
1234
- * @description The name of the item
1235
- * @example AK-47 | Redline
1236
- */
1237
- name: string;
1238
- /**
1239
- * Format: int32
1240
- * @description The price of the item in the smallest currency unit
1241
- * @example 2500
1242
- */
1243
- price: number;
1244
- };
1245
- /** @description Represents a PayNow store and its associated configuration. */
1246
- StoreDto: {
1247
- id: components["schemas"]["FlakeId"];
1248
- owner_id: components["schemas"]["FlakeId"];
1249
- /** @description The URL-safe slug used to identify the store (e.g. "my-rust-server"). */
1250
- slug: string;
1251
- /** @description The display name of the store. */
1252
- name: string;
1253
- /** @description The platform this store is associated with (e.g. "rust", "minecraft"). */
1254
- platform: string;
1255
- /** @description Alias for PayNow.Services.HttpGateway.DataTransferObjects.V1.Stores.StoreDto.Platform. Returns the platform identifier as a game name. */
1256
- readonly game: string;
1257
- /** @description The ISO 4217 currency code used by this store for pricing (e.g. "usd", "eur") */
1258
- currency: string;
1259
- /** @description A human-readable description of the store shown to customers and PayNow. */
1260
- description: string;
1261
- /** @description The store's public website URL. */
1262
- website_url?: null | string;
1263
- /** @description General contact email address for the store. */
1264
- contact_email?: null | string;
1265
- /** @description Dedicated support email address for customer inquiries. */
1266
- support_email?: null | string;
1267
- /** @description URL to the store's support portal or help page. */
1268
- support_url?: null | string;
1269
- /** @description The integration type used by the store. */
1270
- integration_type?: null | string;
1271
- /** @description When set to true, the store is processing real transactions in live mode. */
1272
- live_mode: boolean;
1273
- /** @description URL of the store's full-size logo image. */
1274
- logo_url?: null | string;
1275
- /** @description URL of the store's square/icon logo image. */
1276
- logo_square_url?: null | string;
1277
- /** @description Username prefix used to identify Minecraft Bedrock players (e.g. "."). */
1278
- minecraft_bedrock_username_prefix?: null | string;
1279
- /**
1280
- * Format: date-time
1281
- * @description The UTC timestamp when the store was created.
1282
- */
1283
- created_at?: null | string;
1284
- /**
1285
- * Format: date-time
1286
- * @description The UTC timestamp when the store was last updated.
1287
- */
1288
- updated_at?: null | string;
1289
- /**
1290
- * Format: date-time
1291
- * @description The UTC timestamp when the store completed onboarding.
1292
- */
1293
- onboarding_completed_at?: null | string;
1294
- platform_store_type_association?: components["schemas"]["PlatformStoreTypeAssociationDetailsDto"];
1295
- };
1296
- /** @description Represents a member of a PayNow store. */
1297
- StoreMemberDto: {
1298
- id: components["schemas"]["FlakeId"];
1299
- user_id: components["schemas"]["FlakeId"];
1300
- user: components["schemas"]["StoreMemberUserDto"];
1301
- /**
1302
- * Format: date-time
1303
- * @description The UTC timestamp when the member was added to the store.
1304
- */
1305
- added_at?: null | string;
1306
- added_by?: components["schemas"]["ActorDto"];
1307
- role_id?: components["schemas"]["FlakeId"];
1308
- };
1309
- /** @description Represents identity and profile information for a store member. */
1310
- StoreMemberUserDto: {
1311
- type: components["schemas"]["PayNowActorType"];
1312
- id: components["schemas"]["FlakeId"];
1313
- /** @description The email address associated with the user.
1314
- * Only visible if you are the store owner. */
1315
- email?: null | string;
1316
- /** @description The first name of the actor.
1317
- * Hidden if the user has a set nickname, and you are not the store owner. */
1318
- first_name?: null | string;
1319
- /** @description The last name of the actor.
1320
- * Hidden if the user has a set nickname, and you are not the store owner. */
1321
- last_name?: null | string;
1322
- /** @description The nickname of the user. */
1323
- nickname?: null | string;
1324
- };
1325
- /**
1326
- * @description Determines the party that needs to perform or requests a verification
1327
- * @enum {string}
1328
- */
1329
- StoreRequirementActionParty: "invalid" | "store" | "paynow" | "payment_processor" | "payout_provider" | "kyc_provider" | "external";
1330
- /**
1331
- * @description Represents categories of requirements that must be fulfilled for store setup and compliance in the PayNow platform.
1332
- * @enum {string}
1333
- */
1334
- StoreRequirementCategory: "invalid" | "business" | "kyc" | "compliance" | "risk" | "technical" | "financial" | "legal" | "other";
1335
- /** @enum {string} */
1336
- StoreRequirementStatus: "invalid" | "pending" | "under_review" | "requires_revision" | "approved" | "expired" | "waived" | "rejected_final";
1337
- /** @enum {string} */
1338
- StoreRestrictionFlagDto: "none" | "payments_disabled" | "payouts_disabled";
1339
- StoreTrustDto: {
1340
- store_id: components["schemas"]["FlakeId"];
1341
- status: components["schemas"]["StoreTrustStatusDto"];
1342
- status_reason?: null | string;
1343
- restrictions: components["schemas"]["StoreRestrictionFlagDto"];
1344
- /** Format: date-time */
1345
- created_at: string;
1346
- /** Format: date-time */
1347
- updated_at?: null | string;
1348
- onboarding_steps?: components["schemas"]["StoreTrustOnboardingStepsDto"];
1349
- events: components["schemas"]["StoreTrustEventDto"][];
1350
- pending_requirements: components["schemas"]["TrustStoreRequirementDto"][];
1351
- };
1352
- StoreTrustEventDto: {
1353
- id: components["schemas"]["FlakeId"];
1354
- store_id: components["schemas"]["FlakeId"];
1355
- type: components["schemas"]["StoreTrustEventTypeDto"];
1356
- description?: null | string;
1357
- store_requirement_id?: components["schemas"]["FlakeId"];
1358
- store_review_id?: components["schemas"]["FlakeId"];
1359
- actor: components["schemas"]["ActorDto"];
1360
- /** Format: date-time */
1361
- created_at: string;
1362
- };
1363
- /** @enum {string} */
1364
- StoreTrustEventTypeDto: "invalid" | "onboarded" | "escalated_to_review" | "action_required" | "restricted" | "offboarded" | "reactivated" | "requirement_added" | "requirement_submitted" | "requirement_verified" | "requirement_rejected" | "requirement_deadline_missed" | "requirement_waived" | "requirement_requires_revision" | "restriction_added" | "restriction_lifted" | "review_scheduled" | "review_completed";
1365
- StoreTrustOnboardingStepsDto: {
1366
- store_id: components["schemas"]["FlakeId"];
1367
- store_owner_id: components["schemas"]["FlakeId"];
1368
- payout_onboarding_completed: boolean;
1369
- kyc_completed: boolean;
1370
- products_created: boolean;
1371
- gameserver_linked: boolean;
1372
- webhooks_active: boolean;
1373
- downloadable_files_added: boolean;
1374
- };
1375
- /** @enum {string} */
1376
- StoreTrustStatusDto: "invalid" | "pending_review" | "requires_action" | "under_review" | "active" | "restricted" | "offboarded";
1377
- StorefrontCustomVariableDto: {
1378
- /** @description Unique identifier string used to reference this custom variable programmatically.
1379
- * Must contain only letters, numbers, underscores, and hyphens. */
1380
- identifier: string;
1381
- /** @description Display name for the custom variable shown to customers. */
1382
- name: string;
1383
- /** @description Description explaining what this custom variable is for. Can be shown to customers. */
1384
- description: string;
1385
- type: components["schemas"]["CustomVariableType"];
1386
- /** @description Optional regex pattern to validate text/number input values.
1387
- * Only applies to text and number types.
1388
- * Uses RE2 syntax - does not support negative lookarounds, backreferences, or other advanced regex features. */
1389
- value_regex?: null | string;
1390
- /** @description Available options for dropdown type custom variables.
1391
- * Empty for text and number types. */
1392
- options: components["schemas"]["StorefrontCustomVariableOptionDto"][];
1393
- };
1394
- StorefrontCustomVariableOptionDto: {
1395
- /** @description Display name shown to customers for this option. */
1396
- name: string;
1397
- /** @description Internal value used for product command variable replacement, without brackets. */
1398
- value: string;
1399
- /**
1400
- * Format: int64
1401
- * @description Additional price in the lowest denominator (e.g. cents) when this option is selected.
1402
- */
1403
- price: number;
1404
- /** @description Whether this option is selected by default when the custom variable is presented.
1405
- * Only one option per custom variable should be marked as default. */
1406
- is_default: boolean;
1407
- /**
1408
- * Format: int32
1409
- * @description Sort order for displaying options to customers.
1410
- * Lower numbers appear first.
1411
- */
1412
- sort_order: number;
1413
- };
1414
- /** @description Represents a delivery item assigned to a customer */
1415
- StorefrontDeliveryItemDto: {
1416
- id: components["schemas"]["FlakeId"];
1417
- store_id: components["schemas"]["FlakeId"];
1418
- customer_id: components["schemas"]["FlakeId"];
1419
- order_id?: components["schemas"]["FlakeId"];
1420
- order_line_id?: components["schemas"]["FlakeId"];
1421
- subscription_id?: components["schemas"]["FlakeId"];
1422
- execute_on_gameserver_id?: components["schemas"]["FlakeId"];
1423
- /**
1424
- * Format: int32
1425
- * @description The index of the item when multiple quantities were assigned
1426
- */
1427
- quantity_index?: null | number;
1428
- product: components["schemas"]["DeliveryItemProductDto"];
1429
- state: components["schemas"]["DeliveryItemStateDto"];
1430
- /** @description Indicates whether the delivery item can expire */
1431
- expirable: boolean;
1432
- /** @description Indicates whether the item was given as a gift */
1433
- gift: boolean;
1434
- /**
1435
- * Format: date-time
1436
- * @description The date and time when the item was added
1437
- */
1438
- added_at: string;
1439
- /**
1440
- * Format: date-time
1441
- * @description The date and time when the item became active
1442
- */
1443
- active_at?: null | string;
1444
- /**
1445
- * Format: date-time
1446
- * @description The date and time when the item expires naturally
1447
- */
1448
- expires_at?: null | string;
1449
- /**
1450
- * Format: date-time
1451
- * @description The override expiry date for the delivery item
1452
- */
1453
- override_expires_at?: null | string;
1454
- /**
1455
- * Format: date-time
1456
- * @description The date and time when the item was removed
1457
- */
1458
- removed_at?: null | string;
1459
- /**
1460
- * Format: date-time
1461
- * @description The date and time when the item was revoked
1462
- */
1463
- revoked_at?: null | string;
1464
- /** @description The reason for revoking the delivery item */
1465
- revoke_reason?: null | string;
1466
- };
1467
- /** @description Represents a simplified view of a game server for storefront display purposes. */
1468
- StorefrontGameServerDto: {
1469
- id: components["schemas"]["FlakeId"];
1470
- store_id: components["schemas"]["FlakeId"];
1471
- /** @description The display name of the game server. */
1472
- name: string;
1473
- /** @description Indicates whether the game server is currently enabled. */
1474
- enabled: boolean;
1475
- };
1476
- StorefrontGiftCardDto: {
1477
- code: string;
1478
- /** Format: int32 */
1479
- balance: number;
1480
- /** Format: int32 */
1481
- starting_balance: number;
1482
- /** Format: date-time */
1483
- expires_at?: null | string;
1484
- };
1485
- /** @description Represents a navigation link in the storefront's hierarchical navigation structure. */
1486
- StorefrontNavLinkDto: {
1487
- /** @description The unique identifier for this navigation node in the navigation tree. */
1488
- node_id: string;
1489
- /** @description The identifier of the parent navigation node, if this is a child node. */
1490
- parent_node_id?: null | string;
1491
- tag_id: components["schemas"]["FlakeId"];
1492
- /**
1493
- * @description The URL-friendly slug for the tag associated with this navigation link.
1494
- * @example perks
1495
- */
1496
- tag_slug: string;
1497
- /**
1498
- * @description A list containing all parent tags and this node's tag, representing the complete path in the tag hierarchy.
1499
- * @example [
1500
- * "perks",
1501
- * "vip"
1502
- * ]
1503
- */
1504
- tag_query: string[];
1505
- /**
1506
- * @description The display name of the associated tag shown to users in the UI.
1507
- * @example Perks
1508
- */
1509
- name: string;
1510
- /**
1511
- * Format: int32
1512
- * @description The display order of this navigation link relative to its siblings.
1513
- */
1514
- order: number;
1515
- /** @description The collection of child navigation links that appear beneath this link in the hierarchy. */
1516
- children: components["schemas"]["StorefrontNavLinkDto"][];
1517
- };
1518
- StorefrontProductDto: {
1519
- id: components["schemas"]["FlakeId"];
1520
- store_id: components["schemas"]["FlakeId"];
1521
- version_id: components["schemas"]["FlakeId"];
1522
- /**
1523
- * @description The URL to the product image.
1524
- * @example https://cdn.paynow.gg/logo/full/logotype-color.svg
1525
- */
1526
- image_url?: null | string;
1527
- /**
1528
- * @description The unique slug for the product.
1529
- * @example premium-game-package
1530
- */
1531
- slug: string;
1532
- /**
1533
- * @description The display name of the product.
1534
- * @example Premium Game Package
1535
- */
1536
- name: string;
1537
- /**
1538
- * @description The detailed description of the product.
1539
- * @example This premium package includes exclusive in-game items, bonus currency, and early access to new content.
1540
- */
1541
- description: string;
1542
- /**
1543
- * Format: date-time
1544
- * @description The date and time when the product becomes enabled.
1545
- */
1546
- enabled_at?: null | string;
1547
- /**
1548
- * Format: date-time
1549
- * @description The date and time until which the product remains enabled.
1550
- */
1551
- enabled_until?: null | string;
1552
- /**
1553
- * @description The display label for the product.
1554
- * @example Premium Items
1555
- */
1556
- label?: null | string;
1557
- /**
1558
- * Format: int32
1559
- * @description The sort order for displaying the product.
1560
- */
1561
- sort_order: number;
1562
- /**
1563
- * Format: int64
1564
- * @description The price of the product, in the lowest denominator (e.g. cents).
1565
- * @example 1999
1566
- */
1567
- price: number;
1568
- /** @description The ISO three-letter lowercase currency code (e.g., usd, eur, gbp) the product is denominated in. */
1569
- currency: string;
1570
- /** @description Indicates whether the product is limited to a single game server. */
1571
- single_game_server_only: boolean;
1572
- /**
1573
- * @description Indicates whether one-time purchases are allowed.
1574
- * @example true
1575
- */
1576
- allow_one_time_purchase: boolean;
1577
- /**
1578
- * @description Indicates whether subscription purchases are allowed.
1579
- * @example true
1580
- */
1581
- allow_subscription: boolean;
1582
- /** @description Indicates whether gifting is disabled for this product. */
1583
- is_gifting_disabled: boolean;
1584
- /** @description Indicates whether gift cards are disabled entirely for the product. */
1585
- is_gift_cards_disabled: boolean;
1586
- /** @description Indicates whether coupons are disabled entirely for the product. */
1587
- is_coupons_disabled: boolean;
1588
- /** @description Indicates whether affiliate links are disabled entirely for the product. */
1589
- is_affiliate_links_disabled: boolean;
1590
- /**
1591
- * Format: int32
1592
- * @description The subscription interval value.
1593
- * @example 1
1594
- */
1595
- subscription_interval_value: number;
1596
- subscription_interval_scale: components["schemas"]["ProductSubscriptionIntervalScale"];
1597
- /**
1598
- * @description Indicates whether automatic removal is enabled.
1599
- * @example true
1600
- */
1601
- remove_after_enabled: boolean;
1602
- /**
1603
- * Format: int32
1604
- * @description The time value for automatic removal.
1605
- * @example 1
1606
- */
1607
- remove_after_time_value: number;
1608
- remove_after_time_scale: components["schemas"]["ProductRemoveAfterIntervalScale"];
1609
- pricing?: components["schemas"]["StorefrontProductPricingDetailsDto"];
1610
- stock?: components["schemas"]["StorefrontProductStockStatusDto"];
1611
- trial: components["schemas"]["StorefrontProductTrialDto"];
1612
- /** @description The tags associated with the product. */
1613
- tags: components["schemas"]["ProductTagDto"][];
1614
- /** @description The game servers associated with the product. */
1615
- gameservers: components["schemas"]["ProductGameServerDto"][];
1616
- /** @description Custom Variables associated with the product. */
1617
- custom_variables: components["schemas"]["StorefrontCustomVariableDto"][];
1618
- deliverable_actions?: components["schemas"]["ProductDeliverableActionsDto"];
1619
- /** @description Additional metadata for the product. */
1620
- metadata?: null | {
1621
- [key: string]: string;
1622
- };
1623
- /**
1624
- * Format: date-time
1625
- * @description The date and time when the product was created.
1626
- */
1627
- created_at?: null | string;
1628
- /**
1629
- * Format: date-time
1630
- * @description The date and time when the product was last updated.
1631
- */
1632
- updated_at?: null | string;
1633
- tier_group_id?: components["schemas"]["FlakeId"];
1634
- active_tier_group?: components["schemas"]["CustomerTierGroupDto"];
1635
- };
1636
- /** @description The pricing details for the product in the storefront. */
1637
- StorefrontProductPricingDetailsDto: {
1638
- active_sale?: components["schemas"]["StorefrontSaleDto"];
1639
- /**
1640
- * Format: int64
1641
- * @description The amount of the sale discount in the lowest denominator (e.g. cents).
1642
- * @example 500
1643
- */
1644
- sale_value?: null | number;
1645
- upsell_offer_id?: components["schemas"]["FlakeId"];
1646
- /** Format: int64 */
1647
- upsell_discount_amount: number;
1648
- vat_rate?: components["schemas"]["VatRateDto"];
1649
- regional_pricing?: components["schemas"]["StorefrontProductPricingDetailsRegionalPricingDto"];
1650
- /**
1651
- * Format: int64
1652
- * @description The original price of the product before any discounts, in the lowest denominator (e.g. cents).
1653
- * @example 1999
1654
- */
1655
- price_original: number;
1656
- /**
1657
- * Format: int64
1658
- * @description The final price of the product after all discounts, in the lowest denominator (e.g. cents).
1659
- * @example 1499
1660
- */
1661
- price_final: number;
1662
- };
1663
- /** @description Regional pricing information for this product.
1664
- * Only present if there is a regional pricing configured. */
1665
- StorefrontProductPricingDetailsRegionalPricingDto: {
1666
- /**
1667
- * @description The identifier for the region.
1668
- * @example eu
1669
- */
1670
- region_id: string;
1671
- /**
1672
- * @description The currency code used in the region.
1673
- * @example eur
1674
- */
1675
- currency: string;
1676
- /**
1677
- * @description Indicates whether the base price includes tax.
1678
- * @example true
1679
- */
1680
- tax_inclusive: boolean;
1681
- /**
1682
- * Format: int64
1683
- * @description The base price in the regional currency, in the lowest denominator (e.g. cents).
1684
- * @example 1799
1685
- */
1686
- base_price: number;
1687
- };
1688
- /** @description The stock status information for the product in the storefront. */
1689
- StorefrontProductStockStatusDto: {
1690
- /**
1691
- * @description Indicates whether the product is currently available for purchase (there is available stock).
1692
- * @example true
1693
- */
1694
- available_to_purchase: boolean;
1695
- /**
1696
- * Format: int32
1697
- * @description The number of items available for the customer to purchase (customer stock limit remaining).
1698
- * @example 5
1699
- */
1700
- customer_available: number;
1701
- };
1702
- StorefrontProductTrialDto: {
1703
- /** @description Indicates whether the trial period is enabled for this product. */
1704
- enabled: boolean;
1705
- /** @description Indicates whether the customer is eligible for the trial period. */
1706
- eligible: boolean;
1707
- /**
1708
- * Format: int32
1709
- * @description The duration value of the trial period.
1710
- */
1711
- period_value: number;
1712
- period_scale: components["schemas"]["ProductSubscriptionIntervalScale"];
1713
- };
1714
- StorefrontSaleDto: {
1715
- id: components["schemas"]["FlakeId"];
1716
- /**
1717
- * @description The name of the sale.
1718
- * @example Summer Sale
1719
- */
1720
- name: string;
1721
- discount_type: components["schemas"]["SaleDiscountType"];
1722
- /**
1723
- * Format: int64
1724
- * @description The amount of the discount, either as a percentage in permille or as an absolute value in cents.
1725
- * @example 2000
1726
- */
1727
- discount_amount: number;
1728
- /**
1729
- * Format: int64
1730
- * @description The minimum order value required to apply the discount, in the lowest denominator (e.g. cents).
1731
- * @example 0
1732
- */
1733
- minimum_order_value: number;
1734
- /**
1735
- * Format: date-time
1736
- * @description The date and time when the sale begins.
1737
- * @example 2025-06-01T00:00:00Z
1738
- */
1739
- begins_at: string;
1740
- /**
1741
- * Format: date-time
1742
- * @description The date and time when the sale ends, if applicable.
1743
- * @example 2025-06-30T23:59:59Z
1744
- */
1745
- ends_at?: null | string;
1746
- };
1747
- /** @description Represents a store entity within the storefront system. */
1748
- StorefrontStoreDto: {
1749
- id: components["schemas"]["FlakeId"];
1750
- /**
1751
- * @description The URL-friendly identifier for the store, used in store URLs.
1752
- * @example m0ukas-awesome-store
1753
- */
1754
- slug: string;
1755
- /**
1756
- * @description The display name of the store shown to customers.
1757
- * @example m0uka's awesome store
1758
- */
1759
- name: string;
1760
- /**
1761
- * @description The platform or the game of the store.
1762
- * @example rust
1763
- */
1764
- platform: string;
1765
- /** @description The game of the store. Equivalent to the `platform` for backwards compatibility. */
1766
- readonly game: string;
1767
- /**
1768
- * @description The three-letter ISO currency code used for pricing in this store.
1769
- * If using the Adaptive Currency feature, this will be updated to reflect customer's local currency
1770
- * (based on passed in IP / country headers).
1771
- * @example eur
1772
- */
1773
- currency: string;
1774
- /**
1775
- * @description The three-letter ISO currency code signifying the main currency of the store.
1776
- * @example usd
1777
- */
1778
- creator_currency: string;
1779
- /** @description A detailed description of the store. Only present for some platform types. */
1780
- description?: null | string;
1781
- /** @description The URL of the store's main website, if not using Hosted Webstores. */
1782
- website_url?: null | string;
1783
- /**
1784
- * @description The email address customers can use to contact store support.
1785
- * @example support@example.com
1786
- */
1787
- support_email?: null | string;
1788
- /** @description The URL of the store's support page. */
1789
- support_url?: null | string;
1790
- /** @description The type of integration this store uses with external systems. */
1791
- integration_type?: null | string;
1792
- /** @description Indicates whether the store is in live mode (true) or test mode (false). */
1793
- live_mode: boolean;
1794
- /** @description The URL to the store's main logo image. */
1795
- logo_url?: null | string;
1796
- /** @description The URL to the store's square logo image. */
1797
- logo_square_url?: null | string;
1798
- /**
1799
- * Format: date-time
1800
- * @description The date and time when the store was created.
1801
- */
1802
- created_at?: null | string;
1803
- /**
1804
- * Format: date-time
1805
- * @description The date and time when the store was last updated.
1806
- */
1807
- updated_at?: null | string;
1808
- };
1809
- /** @description Represents a tag entity used for categorizing and filtering products within a store. */
1810
- StorefrontTagDto: {
1811
- id: components["schemas"]["FlakeId"];
1812
- store_id: components["schemas"]["FlakeId"];
1813
- /** @description The URL-friendly identifier for the tag, used in category URLs. */
1814
- slug: string;
1815
- /** @description The display name of the tag shown to customers. */
1816
- name: string;
1817
- /** @description A detailed description of the tag's purpose or the category it represents. */
1818
- description?: null | string;
1819
- /**
1820
- * @description The URL to the tag image.
1821
- * @example https://cdn.paynow.gg/logo/full/logotype-color.svg
1822
- */
1823
- image_url?: null | string;
1824
- /** @description Indicates whether the tag is active and should be included in navigation and filtering. */
1825
- enabled: boolean;
1826
- /**
1827
- * Format: date-time
1828
- * @description The date and time when the tag was created.
1829
- */
1830
- created_at: string;
1831
- /**
1832
- * Format: date-time
1833
- * @description The date and time when the tag was last updated, if applicable.
1834
- */
1835
- updated_at?: null | string;
1836
- };
1837
- /** @description Represents a billing amount breakdown for a subscription. */
1838
- SubscriptionBillingAmountDto: {
1839
- /** @description ISO 4217 currency code, in lowercase. */
1840
- currency: string;
1841
- /**
1842
- * Format: int64
1843
- * @description Base amount before discounts or tax, in smallest currency units.
1844
- */
1845
- subtotal: number;
1846
- /**
1847
- * Format: int64
1848
- * @description Total discount applied, in smallest currency units.
1849
- */
1850
- discount: number;
1851
- /**
1852
- * Format: int64
1853
- * @description Tax amount, in smallest currency units.
1854
- */
1855
- tax: number;
1856
- /**
1857
- * Format: int64
1858
- * @description Amount due after discounts and tax, in smallest currency units.
1859
- */
1860
- total: number;
1861
- };
1862
- /** @description Pricing breakdown for a subscription change, in the smallest units of the given currency (e.g. cents). */
1863
- SubscriptionChangeAmountDto: {
1864
- /** @description ISO 4217 currency code, in lowercase. */
1865
- currency: string;
1866
- /**
1867
- * Format: int64
1868
- * @description Base amount before discounts or tax, in smallest currency units.
1869
- */
1870
- subtotal: number;
1871
- /**
1872
- * Format: int64
1873
- * @description Total discount applied, in smallest currency units.
1874
- */
1875
- discount: number;
1876
- /**
1877
- * Format: int64
1878
- * @description Tax amount, in smallest currency units.
1879
- */
1880
- tax: number;
1881
- /**
1882
- * Format: int64
1883
- * @description Amount due after discounts and tax, in smallest currency units.
1884
- */
1885
- total: number;
1886
- };
1887
- /** @description A pending or applied change to a subscription. */
1888
- SubscriptionChangeDto: {
1889
- id: components["schemas"]["FlakeId"];
1890
- subscription_id: components["schemas"]["FlakeId"];
1891
- prorated_order_id?: components["schemas"]["FlakeId"];
1892
- status: components["schemas"]["SubscriptionChangeStatusDto"];
1893
- proration_behavior: components["schemas"]["ProrationBehaviorDto"];
1894
- /** @description Whether this change was initiated without active customer interaction. */
1895
- off_session: boolean;
1896
- prorated_amount: components["schemas"]["SubscriptionChangeProratedAmountDto"];
1897
- /** Format: date-time */
1898
- created_at: string;
1899
- /** Format: date-time */
1900
- applied_at?: null | string;
1901
- lines: components["schemas"]["SubscriptionChangeLineDto"][];
1902
- next_billing_amount: components["schemas"]["SubscriptionChangeAmountDto"];
1903
- next_billing_presentment_amount: components["schemas"]["SubscriptionChangeAmountDto"];
1904
- };
1905
- /** @description Pricing breakdown for a single subscription change line, in the smallest units of the given currency (e.g. cents). */
1906
- SubscriptionChangeLineAmountDto: {
1907
- /** @description ISO 4217 currency code in lowercase. */
1908
- currency: string;
1909
- /**
1910
- * Format: int64
1911
- * @description Base amount before discounts or tax, in smallest currency units.
1912
- */
1913
- subtotal: number;
1914
- /**
1915
- * Format: int64
1916
- * @description Total discount applied, in smallest currency units.
1917
- */
1918
- discount: number;
1919
- /**
1920
- * Format: int64
1921
- * @description Tax amount, in smallest currency units.
1922
- */
1923
- tax: number;
1924
- /**
1925
- * Format: int64
1926
- * @description Amount due after discounts and tax, in smallest currency units.
1927
- */
1928
- total: number;
1929
- };
1930
- /** @description A single line item within a subscription change. */
1931
- SubscriptionChangeLineDto: {
1932
- id: components["schemas"]["FlakeId"];
1933
- subscription_line_id?: components["schemas"]["FlakeId"];
1934
- /** @description Whether this line is being removed by the change. */
1935
- is_deleted: boolean;
1936
- /** @description Whether tax is included in the base price. */
1937
- tax_inclusive: boolean;
1938
- /**
1939
- * Format: int64
1940
- * @description Base price in smallest settlement currency units.
1941
- */
1942
- price: number;
1943
- product: components["schemas"]["SubscriptionChangeLineProductDto"];
1944
- amount: components["schemas"]["SubscriptionChangeLineAmountDto"];
1945
- presentment_amount: components["schemas"]["SubscriptionChangeLineAmountDto"];
1946
- /**
1947
- * Format: int64
1948
- * @description Prorated charge for this line in smallest settlement currency units.
1949
- */
1950
- prorated_amount: number;
1951
- /**
1952
- * Format: int64
1953
- * @description Prorated charge for this line in smallest presentment currency units.
1954
- */
1955
- prorated_presentment_amount: number;
1956
- /**
1957
- * Format: int64
1958
- * @description Minutes remaining in the billing period at the time of change - used to calculate proration.
1959
- */
1960
- remaining_minutes: number;
1961
- /**
1962
- * Format: int64
1963
- * @description Total minutes in the billing period - used to calculate proration.
1964
- */
1965
- total_minutes: number;
1966
- };
1967
- /** @description The product associated with a subscription change line. */
1968
- SubscriptionChangeLineProductDto: {
1969
- id: components["schemas"]["FlakeId"];
1970
- version_id: components["schemas"]["FlakeId"];
1971
- /** @description Display name of the product. */
1972
- name: string;
1973
- /** @description URL of the product image, if set. */
1974
- image_url?: null | string;
1975
- selected_gameserver_id?: components["schemas"]["FlakeId"];
1976
- /** @description The pricing region used to determine the price, if applicable. */
1977
- pricing_region_id?: null | string;
1978
- /** @description Custom variables set on this line item, keyed by variable identifier. */
1979
- custom_variables: {
1980
- [key: string]: components["schemas"]["CustomVariableLineItemDto"];
1981
- };
1982
- };
1983
- /** @description The total prorated charge for a subscription change, expressed in both settlement and presentment currencies. */
1984
- SubscriptionChangeProratedAmountDto: {
1985
- /** @description ISO 4217 settlement currency code, in lowercase. */
1986
- currency: string;
1987
- /**
1988
- * Format: int64
1989
- * @description Total prorated charge in smallest settlement currency units, including tax.
1990
- */
1991
- prorated_amount: number;
1992
- /** @description ISO 4217 presentment currency code, in lowercase. */
1993
- presentment_currency: string;
1994
- /**
1995
- * Format: int64
1996
- * @description Total prorated charge in smallest presentment currency units, including tax.
1997
- */
1998
- presentment_prorated_amount: number;
1999
- };
2000
- /**
2001
- * @description Represents the status of a subscription change.
2002
- * @enum {string}
2003
- */
2004
- SubscriptionChangeStatusDto: "invalid" | "pending_payment" | "pending_renewal" | "applied" | "canceled" | "pending_verification";
2005
- /** @description Data transfer object representing a store subscription. */
2006
- SubscriptionDto: {
2007
- id: components["schemas"]["FlakeId"];
2008
- /** @description Human-readable identifier for the subscription. */
2009
- pretty_id: string;
2010
- store_id: components["schemas"]["FlakeId"];
2011
- customer: components["schemas"]["CustomerDto"];
2012
- payment_method_id?: components["schemas"]["FlakeId"];
2013
- payment_method?: components["schemas"]["PaymentMethodDto"];
2014
- pending_change?: components["schemas"]["SubscriptionChangeDto"];
2015
- next_billing_amount: components["schemas"]["SubscriptionBillingAmountDto"];
2016
- next_billing_presentment_amount: components["schemas"]["SubscriptionBillingAmountDto"];
2017
- status: components["schemas"]["SubscriptionStatus"];
2018
- coupon_id?: components["schemas"]["FlakeId"];
2019
- /** @description Identifiers of coupons applied to this subscription. */
2020
- coupon_ids: components["schemas"]["FlakeId"][];
2021
- /**
2022
- * Format: date-time
2023
- * @deprecated
2024
- * @description Date when a repeating coupon ends for this subscription.
2025
- */
2026
- coupon_repeating_ends_at?: null | string;
2027
- affiliate_id?: components["schemas"]["FlakeId"];
2028
- checkout_id?: components["schemas"]["FlakeId"];
2029
- checkout_line_id?: components["schemas"]["FlakeId"];
2030
- /** @description Name used for billing purposes. */
2031
- billing_name?: null | string;
2032
- /** @description Email used for billing purposes. */
2033
- billing_email?: null | string;
2034
- /** @description Country code used for billing purposes. */
2035
- billing_country?: null | string;
2036
- /** @description List of tax jurisdictions applicable to this subscription. */
2037
- tax_jurisdictions: components["schemas"]["SalesTaxJurisdictionDto"][];
2038
- /** @description IP address of the customer at the time of subscription. */
2039
- customer_ip?: null | string;
2040
- /**
2041
- * @deprecated
2042
- * @description Indicates whether this subscription is a gift.
2043
- */
2044
- readonly gift: boolean;
2045
- gift_to_customer_id?: components["schemas"]["FlakeId"];
2046
- gift_to_customer?: components["schemas"]["CustomerDto"];
2047
- product_id?: components["schemas"]["FlakeId"];
2048
- product_version_id?: components["schemas"]["FlakeId"];
2049
- /**
2050
- * @deprecated
2051
- * @description Name of the product associated with this subscription.
2052
- */
2053
- readonly product_name?: null | string;
2054
- /**
2055
- * @deprecated
2056
- * @description URL for the product image.
2057
- */
2058
- readonly product_image_url?: null | string;
2059
- /**
2060
- * Format: int32
2061
- * @description Numeric value of the billing interval.
2062
- */
2063
- interval_value: number;
2064
- interval_scale: components["schemas"]["ProductSubscriptionIntervalScale"];
2065
- /** @description Currency code used for billing this subscription. */
2066
- currency: string;
2067
- /**
2068
- * @deprecated
2069
- * @description Indicates whether tax is included in the base price itself.
2070
- */
2071
- readonly tax_inclusive: boolean;
2072
- /**
2073
- * Format: int64
2074
- * @deprecated
2075
- * @description Base price of the subscription in smallest currency units (e.g., cents).
2076
- */
2077
- readonly price: number;
2078
- /**
2079
- * @deprecated
2080
- * @description Formatted string representation of the price.
2081
- */
2082
- readonly price_str?: null | string;
2083
- /**
2084
- * Format: int64
2085
- * @description Amount of discount applied in smallest currency units.
2086
- */
2087
- discount_amount: number;
2088
- /** @description Formatted string representation of the discount amount. */
2089
- readonly discount_amount_str: string;
2090
- /**
2091
- * Format: int64
2092
- * @description Subtotal amount in smallest currency units.
2093
- */
2094
- subtotal_amount: number;
2095
- /** @description Formatted string representation of the subtotal amount. */
2096
- readonly subtotal_amount_str: string;
2097
- /**
2098
- * Format: int64
2099
- * @description Tax amount in smallest currency units.
2100
- */
2101
- tax_amount: number;
2102
- /** @description Formatted string representation of the tax amount. */
2103
- readonly tax_amount_str: string;
2104
- /**
2105
- * Format: int64
2106
- * @description Total amount in smallest currency units.
2107
- */
2108
- total_amount: number;
2109
- /** @description Formatted string representation of the total amount. */
2110
- readonly total_amount_str: string;
2111
- /**
2112
- * Format: int64
2113
- * @description Initial discount amount in smallest currency units for the first billing cycle.
2114
- */
2115
- initial_discount_amount: number;
2116
- /** @description Formatted string representation of the initial discount amount. */
2117
- readonly initial_discount_amount_str: string;
2118
- /**
2119
- * Format: int64
2120
- * @description Initial subtotal amount in smallest currency units for the first billing cycle.
2121
- */
2122
- initial_subtotal_amount: number;
2123
- /** @description Formatted string representation of the initial subtotal amount. */
2124
- readonly initial_subtotal_amount_str: string;
2125
- /**
2126
- * Format: int64
2127
- * @description Initial gift card usage amount in smallest currency units.
2128
- */
2129
- initial_giftcard_usage_amount: number;
2130
- /** @description Formatted string representation of the initial gift card usage amount. */
2131
- readonly initial_giftcard_usage_amount_str: string;
2132
- /**
2133
- * Format: int64
2134
- * @description Initial tax amount in smallest currency units for the first billing cycle.
2135
- */
2136
- initial_tax_amount: number;
2137
- /** @description Formatted string representation of the initial tax amount. */
2138
- readonly initial_tax_amount_str: string;
2139
- /**
2140
- * Format: int64
2141
- * @description Initial total amount in smallest currency units for the first billing cycle.
2142
- */
2143
- initial_total_amount: number;
2144
- /** @description Formatted string representation of the initial total amount. */
2145
- readonly initial_total_amount_str: string;
2146
- /** @description Presentment currency code (currency shown to customer). */
2147
- presentment_currency?: null | string;
2148
- /**
2149
- * Format: int64
2150
- * @description Presentment subtotal amount in smallest currency units.
2151
- */
2152
- presentment_subtotal_amount?: null | number;
2153
- /** @description Formatted string representation of the presentment subtotal amount. */
2154
- readonly presentment_subtotal_amount_str?: null | string;
2155
- /**
2156
- * Format: int64
2157
- * @description Presentment discount amount in smallest currency units.
2158
- */
2159
- presentment_discount_amount?: null | number;
2160
- /** @description Formatted string representation of the presentment discount amount. */
2161
- readonly presentment_discount_amount_str?: null | string;
2162
- /**
2163
- * Format: int64
2164
- * @description Presentment tax amount in smallest currency units.
2165
- */
2166
- presentment_tax_amount?: null | number;
2167
- /** @description Formatted string representation of the presentment tax amount. */
2168
- readonly presentment_tax_amount_str?: null | string;
2169
- /**
2170
- * Format: int64
2171
- * @description Presentment total amount in smallest currency units.
2172
- */
2173
- presentment_total_amount?: null | number;
2174
- /** @description Formatted string representation of the presentment total amount. */
2175
- readonly presentment_total_amount_str?: null | string;
2176
- /**
2177
- * Format: int64
2178
- * @description Initial presentment discount amount in smallest currency units for the first billing cycle.
2179
- */
2180
- initial_presentment_discount_amount?: null | number;
2181
- /** @description Formatted string representation of the initial presentment discount amount. */
2182
- readonly initial_presentment_discount_amount_str?: null | string;
2183
- /**
2184
- * Format: int64
2185
- * @description Initial presentment subtotal amount in smallest currency units for the first billing cycle.
2186
- */
2187
- initial_presentment_subtotal_amount?: null | number;
2188
- /** @description Formatted string representation of the initial presentment subtotal amount. */
2189
- readonly initial_presentment_subtotal_amount_str?: null | string;
2190
- /**
2191
- * Format: int64
2192
- * @description Initial presentment gift card usage amount in smallest currency units.
2193
- */
2194
- initial_presentment_giftcard_usage_amount?: null | number;
2195
- /** @description Formatted string representation of the initial presentment gift card usage amount. */
2196
- readonly initial_presentment_giftcard_usage_amount_str?: null | string;
2197
- /**
2198
- * Format: int64
2199
- * @description Initial presentment tax amount in smallest currency units for the first billing cycle.
2200
- */
2201
- initial_presentment_tax_amount?: null | number;
2202
- /** @description Formatted string representation of the initial presentment tax amount. */
2203
- readonly initial_presentment_tax_amount_str?: null | string;
2204
- /**
2205
- * Format: int64
2206
- * @description Initial presentment total amount in smallest currency units for the first billing cycle.
2207
- */
2208
- initial_presentment_total_amount?: null | number;
2209
- /** @description Formatted string representation of the initial presentment total amount. */
2210
- readonly initial_presentment_total_amount_str?: null | string;
2211
- /** @description The foreign exchange rate applied (if presentment currency differs from settlement currency). */
2212
- fx_rate?: null | string;
2213
- /**
2214
- * @deprecated
2215
- * @description Identifier for the pricing region associated with this subscription.
2216
- */
2217
- readonly pricing_region_id?: null | string;
2218
- /**
2219
- * Format: date-time
2220
- * @description Start date of the current billing period.
2221
- */
2222
- current_period_start?: null | string;
2223
- /**
2224
- * Format: date-time
2225
- * @description End date of the current billing period.
2226
- */
2227
- current_period_end?: null | string;
2228
- /**
2229
- * Format: int32
2230
- * @description Sequence number of the current billing cycle.
2231
- */
2232
- billing_cycle_sequence?: null | number;
2233
- /**
2234
- * Format: date-time
2235
- * @description Date and time when the next payment attempt will occur.
2236
- */
2237
- next_attempt_at?: null | string;
2238
- /**
2239
- * Format: int32
2240
- * @description Number of payment attempts made for the current billing cycle.
2241
- */
2242
- attempt_count?: null | number;
2243
- /**
2244
- * Format: date-time
2245
- * @description Date and time when the subscription was created.
2246
- */
2247
- created_at: string;
2248
- /**
2249
- * Format: date-time
2250
- * @description Date and time when the subscription was last updated.
2251
- */
2252
- updated_at?: null | string;
2253
- /**
2254
- * Format: date-time
2255
- * @description Date and time when the subscription became active.
2256
- */
2257
- active_at?: null | string;
2258
- /**
2259
- * Format: date-time
2260
- * @description Date and time when the subscription was canceled.
2261
- */
2262
- canceled_at?: null | string;
2263
- /** @description Reason provided for cancellation. */
2264
- cancel_reason?: null | string;
2265
- /** @description Line items associated with this subscription. */
2266
- lines: components["schemas"]["SubscriptionLineDto"][];
2267
- };
2268
- /** @description Represents a line item within a subscription. */
2269
- SubscriptionLineDto: {
2270
- id: components["schemas"]["FlakeId"];
2271
- store_id: components["schemas"]["FlakeId"];
2272
- subscription_id: components["schemas"]["FlakeId"];
2273
- checkout_line_id?: components["schemas"]["FlakeId"];
2274
- initial_order_line_id?: components["schemas"]["FlakeId"];
2275
- /** @description Identifier for the pricing region associated with this subscription line. */
2276
- pricing_region_id?: null | string;
2277
- gift_to_customer_id?: components["schemas"]["FlakeId"];
2278
- selected_gameserver_id?: components["schemas"]["FlakeId"];
2279
- sale_id?: components["schemas"]["FlakeId"];
2280
- trial_id?: components["schemas"]["FlakeId"];
2281
- product_id: components["schemas"]["FlakeId"];
2282
- product_version_id: components["schemas"]["FlakeId"];
2283
- /** @description Name of the product associated with this subscription line. */
2284
- product_name: string;
2285
- /** @description URL for the product image. */
2286
- product_image_url?: null | string;
2287
- /** @description Indicates whether tax is included in the base price itself. */
2288
- tax_inclusive: boolean;
2289
- /** @description Currency code for this subscription line. */
2290
- currency: string;
2291
- /**
2292
- * Format: int64
2293
- * @description Base price of the subscription line in smallest currency units (e.g., cents).
2294
- */
2295
- price: number;
2296
- /**
2297
- * Format: int64
2298
- * @description Amount of discount applied in smallest currency units.
2299
- */
2300
- discount_amount: number;
2301
- /** @description Formatted string representation of the discount amount. */
2302
- readonly discount_amount_str: string;
2303
- /**
2304
- * Format: int64
2305
- * @description Subtotal amount in smallest currency units.
2306
- */
2307
- subtotal_amount: number;
2308
- /** @description Formatted string representation of the subtotal amount. */
2309
- readonly subtotal_amount_str: string;
2310
- /**
2311
- * Format: int64
2312
- * @description Tax amount in smallest currency units.
2313
- */
2314
- tax_amount: number;
2315
- /** @description Formatted string representation of the tax amount. */
2316
- readonly tax_amount_str: string;
2317
- /**
2318
- * Format: int64
2319
- * @description Total amount in smallest currency units.
2320
- */
2321
- total_amount: number;
2322
- /** @description Formatted string representation of the total amount. */
2323
- readonly total_amount_str: string;
2324
- /**
2325
- * Format: int64
2326
- * @description Initial discount amount in smallest currency units for the first billing cycle.
2327
- */
2328
- initial_discount_amount: number;
2329
- /** @description Formatted string representation of the initial discount amount. */
2330
- readonly initial_discount_amount_str: string;
2331
- /**
2332
- * Format: int64
2333
- * @description Initial subtotal amount in smallest currency units for the first billing cycle.
2334
- */
2335
- initial_subtotal_amount: number;
2336
- /** @description Formatted string representation of the initial subtotal amount. */
2337
- readonly initial_subtotal_amount_str: string;
2338
- /**
2339
- * Format: int64
2340
- * @description Initial gift card usage amount in smallest currency units.
2341
- */
2342
- initial_giftcard_usage_amount: number;
2343
- /** @description Formatted string representation of the initial gift card usage amount. */
2344
- readonly initial_giftcard_usage_amount_str: string;
2345
- /**
2346
- * Format: int64
2347
- * @description Initial tax amount in smallest currency units for the first billing cycle.
2348
- */
2349
- initial_tax_amount: number;
2350
- /** @description Formatted string representation of the initial tax amount. */
2351
- readonly initial_tax_amount_str: string;
2352
- /**
2353
- * Format: int64
2354
- * @description Initial total amount in smallest currency units for the first billing cycle.
2355
- */
2356
- initial_total_amount: number;
2357
- /** @description Formatted string representation of the initial total amount. */
2358
- readonly initial_total_amount_str: string;
2359
- /** @description Presentment currency code (currency shown to customer). */
2360
- presentment_currency?: null | string;
2361
- /**
2362
- * Format: int64
2363
- * @description Presentment subtotal amount in smallest currency units.
2364
- */
2365
- presentment_subtotal_amount?: null | number;
2366
- /** @description Formatted string representation of the presentment subtotal amount. */
2367
- readonly presentment_subtotal_amount_str?: null | string;
2368
- /**
2369
- * Format: int64
2370
- * @description Presentment discount amount in smallest currency units.
2371
- */
2372
- presentment_discount_amount?: null | number;
2373
- /** @description Formatted string representation of the presentment discount amount. */
2374
- readonly presentment_discount_amount_str?: null | string;
2375
- /**
2376
- * Format: int64
2377
- * @description Presentment tax amount in smallest currency units.
2378
- */
2379
- presentment_tax_amount?: null | number;
2380
- /** @description Formatted string representation of the presentment tax amount. */
2381
- readonly presentment_tax_amount_str?: null | string;
2382
- /**
2383
- * Format: int64
2384
- * @description Presentment total amount in smallest currency units.
2385
- */
2386
- presentment_total_amount?: null | number;
2387
- /** @description Formatted string representation of the presentment total amount. */
2388
- readonly presentment_total_amount_str?: null | string;
2389
- /**
2390
- * Format: int64
2391
- * @description Initial presentment discount amount in smallest currency units for the first billing cycle.
2392
- */
2393
- initial_presentment_discount_amount?: null | number;
2394
- /** @description Formatted string representation of the initial presentment discount amount. */
2395
- readonly initial_presentment_discount_amount_str?: null | string;
2396
- /**
2397
- * Format: int64
2398
- * @description Initial presentment subtotal amount in smallest currency units for the first billing cycle.
2399
- */
2400
- initial_presentment_subtotal_amount?: null | number;
2401
- /** @description Formatted string representation of the initial presentment subtotal amount. */
2402
- readonly initial_presentment_subtotal_amount_str?: null | string;
2403
- /**
2404
- * Format: int64
2405
- * @description Initial presentment gift card usage amount in smallest currency units.
2406
- */
2407
- initial_presentment_giftcard_usage_amount?: null | number;
2408
- /** @description Formatted string representation of the initial presentment gift card usage amount. */
2409
- readonly initial_presentment_giftcard_usage_amount_str?: null | string;
2410
- /**
2411
- * Format: int64
2412
- * @description Initial presentment tax amount in smallest currency units for the first billing cycle.
2413
- */
2414
- initial_presentment_tax_amount?: null | number;
2415
- /** @description Formatted string representation of the initial presentment tax amount. */
2416
- readonly initial_presentment_tax_amount_str?: null | string;
2417
- /**
2418
- * Format: int64
2419
- * @description Initial presentment total amount in smallest currency units for the first billing cycle.
2420
- */
2421
- initial_presentment_total_amount?: null | number;
2422
- /** @description Formatted string representation of the initial presentment total amount. */
2423
- readonly initial_presentment_total_amount_str?: null | string;
2424
- };
2425
- /**
2426
- * @description Represents the current state of a subscription.
2427
- * @enum {string}
2428
- */
2429
- SubscriptionStatus: "invalid" | "created" | "active" | "canceled";
2430
- TrustStoreRequirementDto: {
2431
- id: components["schemas"]["FlakeId"];
2432
- store_id: components["schemas"]["FlakeId"];
2433
- /** @description Template ID if this requirement was created from a template. Null for ad-hoc requirements. */
2434
- template_id?: null | string;
2435
- originating_flag_id?: components["schemas"]["FlakeId"];
2436
- category: components["schemas"]["StoreRequirementCategory"];
2437
- /** @description Unique code identifying the type of requirement. Copied from template or custom for ad-hoc requirements. */
2438
- code: string;
2439
- /** @description Human-readable name of the requirement. Copied from template or custom for ad-hoc requirements. */
2440
- name: string;
2441
- /** @description Detailed description explaining what the store needs to provide. Copied from template or custom for ad-hoc requirements. */
2442
- description?: null | string;
2443
- /** @description JSON schema defining the form fields, validation rules, and document requirements */
2444
- schema?: null;
2445
- /** @description Additional metadata for this requirement (stored as JSON) */
2446
- metadata: {
2447
- [key: string]: string;
2448
- };
2449
- status: components["schemas"]["StoreRequirementStatus"];
2450
- requested_by: components["schemas"]["StoreRequirementActionParty"];
2451
- /** @description Specifies the specific requester entity (e.g., "stripe", "trolley", or admin user ID)
2452
- * Free-form string for internal records */
2453
- requested_by_detail?: null | string;
2454
- /**
2455
- * Format: date-time
2456
- * @description When this requirement was created
2457
- */
2458
- created_at: string;
2459
- /**
2460
- * Format: date-time
2461
- * @description When this requirement was last updated
2462
- */
2463
- updated_at?: null | string;
2464
- /**
2465
- * Format: date-time
2466
- * @description When this requirement must be completed by (optional)
2467
- */
2468
- deadline_at?: null | string;
2469
- /**
2470
- * Format: date-time
2471
- * @description When the store submitted their response to this requirement
2472
- */
2473
- submitted_at?: null | string;
2474
- /**
2475
- * Format: date-time
2476
- * @description When this requirement was verified and approved
2477
- */
2478
- verified_at?: null | string;
2479
- /**
2480
- * Format: date-time
2481
- * @description When this requirement was rejected for not meeting standards
2482
- */
2483
- rejected_at?: null | string;
2484
- /** @description Store capabilities that are restricted until this requirement is satisfied */
2485
- restricts_capabilities: string[];
2486
- /** @description Associated submissions for this requriement. */
2487
- submissions: components["schemas"]["TrustStoreRequirementSubmissionDto"][];
2488
- };
2489
- TrustStoreRequirementSubmissionDto: {
2490
- id: components["schemas"]["FlakeId"];
2491
- store_id: components["schemas"]["FlakeId"];
2492
- store_requirement_id: components["schemas"]["FlakeId"];
2493
- /** @description The identifier of the specific field within the store requirement. */
2494
- store_requirement_field_id: string;
2495
- /** @description The text value submitted for this field, if applicable. */
2496
- text_value?: null | string;
2497
- /** @description The identifier of the uploaded file, if a file was submitted. */
2498
- file_id?: null | string;
2499
- /** @description The original name of the uploaded file. */
2500
- file_name?: null | string;
2501
- /** @description The MIME content type of the uploaded file. */
2502
- file_content_type?: null | string;
2503
- /**
2504
- * Format: int64
2505
- * @description The size of the uploaded file in bytes.
2506
- */
2507
- file_size_bytes?: null | number;
2508
- /**
2509
- * Format: date-time
2510
- * @description The timestamp when this submission was made.
2511
- */
2512
- submitted_at: string;
2513
- submitted_by: components["schemas"]["ActorDto"];
2514
- /** @description The IP address from which the submission was made. */
2515
- submitted_by_ip_address?: null | string;
2516
- /** @description The user agent string of the client that made the submission. */
2517
- submitted_by_user_agent?: null | string;
2518
- };
2519
- /** @description Response returned after a subscription change is initiated. */
2520
- UpdateSubscriptionResponseDto: {
2521
- subscription_change: components["schemas"]["SubscriptionChangeDto"];
2522
- pending_payment?: components["schemas"]["CheckoutPaymentInfoDto"];
2523
- };
2524
- UpdateSubscriptionTierRequestDto: {
2525
- target_product_id: components["schemas"]["FlakeId"];
2526
- /** @description A verification code sent to the customer's subscription billing e-mail.
2527
- * Pass this if the `status` field on the `subscription_change` object equals `pending_verification`. */
2528
- verification_code?: null | string;
2529
- };
2530
- /** @description A validation error. */
2531
- ValidationError: {
2532
- /** @description The parseable error code. */
2533
- code: string;
2534
- /** @description The human-readable error message. */
2535
- message: string;
2536
- /** @description The path leading to the validation error. */
2537
- path: string;
2538
- /** @description Type of the validation that failed. */
2539
- validation: string;
2540
- };
2541
- /** @description The VAT rate estimation for the passed in customer country / IP.
2542
- * Include the VAT percentage + abbreviation in your product view to inform your customers about the tax. */
2543
- VatRateDto: {
2544
- /**
2545
- * @description The ISO country code.
2546
- * @example CZ
2547
- */
2548
- country_code: string;
2549
- /**
2550
- * @description The full name of the country.
2551
- * @example Czech Republic
2552
- */
2553
- country_name: string;
2554
- /**
2555
- * @description The local currency used in the country.
2556
- * @example CZK
2557
- */
2558
- currency: string;
2559
- /**
2560
- * @description The abbreviation of the VAT term in the local language.
2561
- * @example DPH
2562
- */
2563
- vat_abbreviation: string;
2564
- /**
2565
- * @description The full name of the VAT term in the local language.
2566
- * @example Daň z přidané hodnoty
2567
- */
2568
- vat_local_name: string;
2569
- /**
2570
- * @description Indicates whether the country is a member of the European Union.
2571
- * @example true
2572
- */
2573
- eu_member_state: boolean;
2574
- /**
2575
- * Format: double
2576
- * @description The VAT rate applicable for electronic services, as a percentage.
2577
- * @example 21
2578
- */
2579
- eservice_rate: number;
2580
- /**
2581
- * Format: double
2582
- * @description The VAT rate (synonym for EServiceRate).
2583
- * @example 21
2584
- */
2585
- readonly percentage: number;
2586
- };
2587
- };
2588
- responses: never;
2589
- parameters: never;
2590
- requestBodies: never;
2591
- headers: never;
2592
- pathItems: never;
2593
- }
2594
- export type $defs = Record<string, never>;
2595
- export interface operations {
2596
- Cart_GetCart: {
2597
- parameters: {
2598
- query?: {
2599
- /** @description The ISO three-letter lowercase currency code (e.g., usd, eur, gbp) to display prices in. If not provided, the store's default currency will be used. */
2600
- currency?: string;
2601
- };
2602
- header?: {
2603
- /** @description The IP address (IPv4 or IPv6) of the customer. Required if the request is not being made from the customer's browser. */
2604
- "x-paynow-customer-ip"?: string;
2605
- /** @description The customer's country code in ISO 3166-1 alpha-2 format. Optional, but recommended if you have this available. */
2606
- "x-paynow-customer-countrycode"?: string;
2607
- };
2608
- path?: never;
2609
- cookie?: never;
2610
- };
2611
- requestBody?: never;
2612
- responses: {
2613
- /** @description OK */
2614
- 200: {
2615
- headers: {
2616
- [name: string]: unknown;
2617
- };
2618
- content: {
2619
- "application/json": components["schemas"]["CartDto"];
2620
- };
2621
- };
2622
- /** @description Error response */
2623
- default: {
2624
- headers: {
2625
- [name: string]: unknown;
2626
- };
2627
- content: {
2628
- "application/json": components["schemas"]["PayNowError"];
2629
- };
2630
- };
2631
- };
2632
- };
2633
- Cart_ClearCart: {
2634
- parameters: {
2635
- query?: never;
2636
- header?: {
2637
- /** @description The IP address (IPv4 or IPv6) of the customer. Required if the request is not being made from the customer's browser. */
2638
- "x-paynow-customer-ip"?: string;
2639
- /** @description The customer's country code in ISO 3166-1 alpha-2 format. Optional, but recommended if you have this available. */
2640
- "x-paynow-customer-countrycode"?: string;
2641
- };
2642
- path?: never;
2643
- cookie?: never;
2644
- };
2645
- requestBody?: never;
2646
- responses: {
2647
- /** @description No Content */
2648
- 204: {
2649
- headers: {
2650
- [name: string]: unknown;
2651
- };
2652
- content?: never;
2653
- };
2654
- /** @description Error response */
2655
- default: {
2656
- headers: {
2657
- [name: string]: unknown;
2658
- };
2659
- content: {
2660
- "application/json": components["schemas"]["PayNowError"];
2661
- };
2662
- };
2663
- };
2664
- };
2665
- Cart_AddLine: {
2666
- parameters: {
2667
- query: {
2668
- /** @description The ID of the product that should be added to the cart. */
2669
- product_id: components["schemas"]["FlakeId"];
2670
- /** @description The quantity to set or increment. */
2671
- quantity?: number;
2672
- /** @description Set to either '1' or 'true' to store as a subscription line item. */
2673
- subscription?: string;
2674
- /** @description Set to either '1' or 'true' to indicate if the line should be trialed. */
2675
- trial?: string;
2676
- /** @description A game server ID, required if single_game_server_only is enabled for the product. */
2677
- gameserver_id?: components["schemas"]["FlakeId"];
2678
- /** @description Set to either '1' or 'true' to increment (add quantity instead of setting). */
2679
- increment?: string;
2680
- /** @description Dictionary of product custom variables where each entry consists of a string key (identifier)
2681
- * and its corresponding selected value. Use the following URL parameter format:
2682
- * ?custom_variables[IDENTIFIER]=VALUE */
2683
- custom_variables?: {
2684
- [key: string]: string;
2685
- };
2686
- /** @description The ID of the customer in which this line is a gift for. */
2687
- gift_to_customer_id?: components["schemas"]["FlakeId"];
2688
- /**
2689
- * @description The platform type
2690
- * @example Steam
2691
- */
2692
- "gift_to.platform"?: components["schemas"]["CustomerProfilePlatform"];
2693
- /**
2694
- * @description The account ID on the platform
2695
- * @example 76561198152492642
2696
- */
2697
- "gift_to.id"?: string;
2698
- };
2699
- header?: {
2700
- /** @description The IP address (IPv4 or IPv6) of the customer. Required if the request is not being made from the customer's browser. */
2701
- "x-paynow-customer-ip"?: string;
2702
- /** @description The customer's country code in ISO 3166-1 alpha-2 format. Optional, but recommended if you have this available. */
2703
- "x-paynow-customer-countrycode"?: string;
2704
- };
2705
- path?: never;
2706
- cookie?: never;
2707
- };
2708
- requestBody?: never;
2709
- responses: {
2710
- /** @description No Content */
2711
- 204: {
2712
- headers: {
2713
- [name: string]: unknown;
2714
- };
2715
- content?: never;
2716
- };
2717
- /** @description Error response */
2718
- default: {
2719
- headers: {
2720
- [name: string]: unknown;
2721
- };
2722
- content: {
2723
- "application/json": components["schemas"]["PayNowError"];
2724
- };
2725
- };
2726
- };
2727
- };
2728
- Cart_CreateCartCheckout: {
2729
- parameters: {
2730
- query?: never;
2731
- header?: {
2732
- /** @description The IP address (IPv4 or IPv6) of the customer. Required if the request is not being made from the customer's browser. */
2733
- "x-paynow-customer-ip"?: string;
2734
- /** @description The customer's country code in ISO 3166-1 alpha-2 format. Optional, but recommended if you have this available. */
2735
- "x-paynow-customer-countrycode"?: string;
2736
- };
2737
- path?: never;
2738
- cookie?: never;
2739
- };
2740
- requestBody?: {
2741
- content: {
2742
- "application/json": components["schemas"]["CreateCartCheckoutSessionDto"];
2743
- "text/json": components["schemas"]["CreateCartCheckoutSessionDto"];
2744
- "application/*+json": components["schemas"]["CreateCartCheckoutSessionDto"];
2745
- };
2746
- };
2747
- responses: {
2748
- /** @description OK */
2749
- 200: {
2750
- headers: {
2751
- [name: string]: unknown;
2752
- };
2753
- content: {
2754
- "application/json": components["schemas"]["CreateCheckoutSessionResponseDto"];
2755
- };
2756
- };
2757
- /** @description Error response */
2758
- default: {
2759
- headers: {
2760
- [name: string]: unknown;
2761
- };
2762
- content: {
2763
- "application/json": components["schemas"]["PayNowError"];
2764
- };
2765
- };
2766
- };
2767
- };
2768
- Checkout_CreateCheckoutSession: {
2769
- parameters: {
2770
- query?: never;
2771
- header?: {
2772
- /** @description The IP address (IPv4 or IPv6) of the customer. Required if the request is not being made from the customer's browser. */
2773
- "x-paynow-customer-ip"?: string;
2774
- /** @description The customer's country code in ISO 3166-1 alpha-2 format. Optional, but recommended if you have this available. */
2775
- "x-paynow-customer-countrycode"?: string;
2776
- };
2777
- path?: never;
2778
- cookie?: never;
2779
- };
2780
- requestBody?: {
2781
- content: {
2782
- "application/json": components["schemas"]["CreateCheckoutSessionRequestDto"];
2783
- "text/json": components["schemas"]["CreateCheckoutSessionRequestDto"];
2784
- "application/*+json": components["schemas"]["CreateCheckoutSessionRequestDto"];
2785
- };
2786
- };
2787
- responses: {
2788
- /** @description OK */
2789
- 200: {
2790
- headers: {
2791
- [name: string]: unknown;
2792
- };
2793
- content: {
2794
- "application/json": components["schemas"]["CreateCheckoutSessionResponseDto"];
2795
- };
2796
- };
2797
- /** @description Error response */
2798
- default: {
2799
- headers: {
2800
- [name: string]: unknown;
2801
- };
2802
- content: {
2803
- "application/json": components["schemas"]["PayNowError"];
2804
- };
2805
- };
2806
- };
2807
- };
2808
- Customer_AuthenticateStorefrontCustomer: {
2809
- parameters: {
2810
- query?: never;
2811
- header?: {
2812
- /** @description The IP address (IPv4 or IPv6) of the customer. Required if the request is not being made from the customer's browser. */
2813
- "x-paynow-customer-ip"?: string;
2814
- /** @description The customer's country code in ISO 3166-1 alpha-2 format. Optional, but recommended if you have this available. */
2815
- "x-paynow-customer-countrycode"?: string;
2816
- };
2817
- path?: never;
2818
- cookie?: never;
2819
- };
2820
- requestBody?: {
2821
- content: {
2822
- "application/json": components["schemas"]["AuthenticateStorefrontCustomerRequestDto"];
2823
- "text/json": components["schemas"]["AuthenticateStorefrontCustomerRequestDto"];
2824
- "application/*+json": components["schemas"]["AuthenticateStorefrontCustomerRequestDto"];
2825
- };
2826
- };
2827
- responses: {
2828
- /** @description OK */
2829
- 200: {
2830
- headers: {
2831
- [name: string]: unknown;
2832
- };
2833
- content: {
2834
- "application/json": components["schemas"]["AuthenticateStorefrontCustomerResponseDto"];
2835
- };
2836
- };
2837
- /** @description Error response */
2838
- default: {
2839
- headers: {
2840
- [name: string]: unknown;
2841
- };
2842
- content: {
2843
- "application/json": components["schemas"]["PayNowError"];
2844
- };
2845
- };
2846
- };
2847
- };
2848
- Customer_GetStorefrontCustomer: {
2849
- parameters: {
2850
- query?: never;
2851
- header?: never;
2852
- path?: never;
2853
- cookie?: never;
2854
- };
2855
- requestBody?: never;
2856
- responses: {
2857
- /** @description OK */
2858
- 200: {
2859
- headers: {
2860
- [name: string]: unknown;
2861
- };
2862
- content: {
2863
- "application/json": components["schemas"]["CustomerDto"];
2864
- };
2865
- };
2866
- /** @description Error response */
2867
- default: {
2868
- headers: {
2869
- [name: string]: unknown;
2870
- };
2871
- content: {
2872
- "application/json": components["schemas"]["PayNowError"];
2873
- };
2874
- };
2875
- };
2876
- };
2877
- Customer_GetStorefrontGiftCard: {
2878
- parameters: {
2879
- query?: never;
2880
- header?: never;
2881
- path: {
2882
- code: string;
2883
- };
2884
- cookie?: never;
2885
- };
2886
- requestBody?: never;
2887
- responses: {
2888
- /** @description OK */
2889
- 200: {
2890
- headers: {
2891
- [name: string]: unknown;
2892
- };
2893
- content: {
2894
- "application/json": components["schemas"]["StorefrontGiftCardDto"];
2895
- };
2896
- };
2897
- /** @description Error response */
2898
- default: {
2899
- headers: {
2900
- [name: string]: unknown;
2901
- };
2902
- content: {
2903
- "application/json": components["schemas"]["PayNowError"];
2904
- };
2905
- };
2906
- };
2907
- };
2908
- Delivery_GetStorefrontCustomerDeliveryItems: {
2909
- parameters: {
2910
- query?: {
2911
- /** @description The maximum number of items to return in a single request. */
2912
- limit?: number;
2913
- /**
2914
- * @description Returns items after the specified ID.
2915
- * Used for forward pagination through results.
2916
- * @example null
2917
- */
2918
- after?: components["schemas"]["FlakeId"];
2919
- /**
2920
- * @description Returns items before the specified ID.
2921
- * Used for backward pagination through results.
2922
- * @example null
2923
- */
2924
- before?: components["schemas"]["FlakeId"];
2925
- /** @description Determines the sort order of returned items.
2926
- * When true, items are returned in ascending order.
2927
- * When false, items are returned in descending order. */
2928
- asc?: boolean;
2929
- };
2930
- header?: never;
2931
- path?: never;
2932
- cookie?: never;
2933
- };
2934
- requestBody?: never;
2935
- responses: {
2936
- /** @description OK */
2937
- 200: {
2938
- headers: {
2939
- [name: string]: unknown;
2940
- };
2941
- content: {
2942
- "application/json": components["schemas"]["StorefrontDeliveryItemDto"][];
2943
- };
2944
- };
2945
- /** @description Error response */
2946
- default: {
2947
- headers: {
2948
- [name: string]: unknown;
2949
- };
2950
- content: {
2951
- "application/json": components["schemas"]["PayNowError"];
2952
- };
2953
- };
2954
- };
2955
- };
2956
- Discord_DoProductsHaveDiscordActions: {
2957
- parameters: {
2958
- query?: {
2959
- product_version_id?: components["schemas"]["FlakeId"][];
2960
- };
2961
- header?: never;
2962
- path?: never;
2963
- cookie?: never;
2964
- };
2965
- requestBody?: never;
2966
- responses: {
2967
- /** @description OK */
2968
- 200: {
2969
- headers: {
2970
- [name: string]: unknown;
2971
- };
2972
- content: {
2973
- "application/json": {
2974
- [key: string]: boolean;
2975
- };
2976
- };
2977
- };
2978
- /** @description Error response */
2979
- default: {
2980
- headers: {
2981
- [name: string]: unknown;
2982
- };
2983
- content: {
2984
- "application/json": components["schemas"]["PayNowError"];
2985
- };
2986
- };
2987
- };
2988
- };
2989
- Navlinks_GetStorefrontNavLinks: {
2990
- parameters: {
2991
- query?: never;
2992
- header?: never;
2993
- path?: never;
2994
- cookie?: never;
2995
- };
2996
- requestBody?: never;
2997
- responses: {
2998
- /** @description OK */
2999
- 200: {
3000
- headers: {
3001
- [name: string]: unknown;
3002
- };
3003
- content: {
3004
- "application/json": components["schemas"]["StorefrontNavLinkDto"][];
3005
- };
3006
- };
3007
- /** @description Error response */
3008
- default: {
3009
- headers: {
3010
- [name: string]: unknown;
3011
- };
3012
- content: {
3013
- "application/json": components["schemas"]["PayNowError"];
3014
- };
3015
- };
3016
- };
3017
- };
3018
- Products_GetStorefrontProducts: {
3019
- parameters: {
3020
- query?: {
3021
- /** @description Tag slugs to filter by. Each tag slug is a separate query parameter. */
3022
- tag?: string[];
3023
- /** @description The ISO three-letter lowercase currency code (e.g., usd, eur, gbp) to display prices in. If not provided, the store's default currency will be used. */
3024
- currency?: string;
3025
- };
3026
- header?: {
3027
- /** @description The IP address (IPv4 or IPv6) of the customer. Required if the request is not being made from the customer's browser. */
3028
- "x-paynow-customer-ip"?: string;
3029
- /** @description The customer's country code in ISO 3166-1 alpha-2 format. Optional, but recommended if you have this available. */
3030
- "x-paynow-customer-countrycode"?: string;
3031
- };
3032
- path?: never;
3033
- cookie?: never;
3034
- };
3035
- requestBody?: never;
3036
- responses: {
3037
- /** @description OK */
3038
- 200: {
3039
- headers: {
3040
- [name: string]: unknown;
3041
- };
3042
- content: {
3043
- "application/json": components["schemas"]["StorefrontProductDto"][];
3044
- };
3045
- };
3046
- /** @description Error response */
3047
- default: {
3048
- headers: {
3049
- [name: string]: unknown;
3050
- };
3051
- content: {
3052
- "application/json": components["schemas"]["PayNowError"];
3053
- };
3054
- };
3055
- };
3056
- };
3057
- Products_GetStorefrontProductByIdOrSlug: {
3058
- parameters: {
3059
- query?: {
3060
- /** @description The ISO three-letter lowercase currency code (e.g., usd, eur, gbp) to display prices in. If not provided, the store's default currency will be used. */
3061
- currency?: string;
3062
- };
3063
- header?: {
3064
- /** @description The IP address (IPv4 or IPv6) of the customer. Required if the request is not being made from the customer's browser. */
3065
- "x-paynow-customer-ip"?: string;
3066
- /** @description The customer's country code in ISO 3166-1 alpha-2 format. Optional, but recommended if you have this available. */
3067
- "x-paynow-customer-countrycode"?: string;
3068
- };
3069
- path: {
3070
- idOrSlug: string;
3071
- };
3072
- cookie?: never;
3073
- };
3074
- requestBody?: never;
3075
- responses: {
3076
- /** @description OK */
3077
- 200: {
3078
- headers: {
3079
- [name: string]: unknown;
3080
- };
3081
- content: {
3082
- "application/json": components["schemas"]["StorefrontProductDto"];
3083
- };
3084
- };
3085
- /** @description Error response */
3086
- default: {
3087
- headers: {
3088
- [name: string]: unknown;
3089
- };
3090
- content: {
3091
- "application/json": components["schemas"]["PayNowError"];
3092
- };
3093
- };
3094
- };
3095
- };
3096
- Store_GetStorefrontStore: {
3097
- parameters: {
3098
- query?: never;
3099
- header?: {
3100
- /** @description The IP address (IPv4 or IPv6) of the customer. Required if the request is not being made from the customer's browser. */
3101
- "x-paynow-customer-ip"?: string;
3102
- /** @description The customer's country code in ISO 3166-1 alpha-2 format. Optional, but recommended if you have this available. */
3103
- "x-paynow-customer-countrycode"?: string;
3104
- };
3105
- path?: never;
3106
- cookie?: never;
3107
- };
3108
- requestBody?: never;
3109
- responses: {
3110
- /** @description OK */
3111
- 200: {
3112
- headers: {
3113
- [name: string]: unknown;
3114
- };
3115
- content: {
3116
- "application/json": components["schemas"]["StorefrontStoreDto"];
3117
- };
3118
- };
3119
- /** @description Error response */
3120
- default: {
3121
- headers: {
3122
- [name: string]: unknown;
3123
- };
3124
- content: {
3125
- "application/json": components["schemas"]["PayNowError"];
3126
- };
3127
- };
3128
- };
3129
- };
3130
- Subscriptions_GetSubscriptions: {
3131
- parameters: {
3132
- query?: {
3133
- customer_id?: components["schemas"]["FlakeId"];
3134
- subscription_id?: components["schemas"]["FlakeId"];
3135
- billing_email?: string;
3136
- payment_method_id?: components["schemas"]["FlakeId"];
3137
- checkout_id?: components["schemas"]["FlakeId"];
3138
- trial_id?: components["schemas"]["FlakeId"];
3139
- status?: components["schemas"]["SubscriptionStatus"][];
3140
- /** @description The maximum number of items to return in a single request. */
3141
- limit?: number;
3142
- /**
3143
- * @description Returns items after the specified ID.
3144
- * Used for forward pagination through results.
3145
- * @example null
3146
- */
3147
- after?: components["schemas"]["FlakeId"];
3148
- /**
3149
- * @description Returns items before the specified ID.
3150
- * Used for backward pagination through results.
3151
- * @example null
3152
- */
3153
- before?: components["schemas"]["FlakeId"];
3154
- /** @description Determines the sort order of returned items.
3155
- * When true, items are returned in ascending order.
3156
- * When false, items are returned in descending order. */
3157
- asc?: boolean;
3158
- };
3159
- header?: never;
3160
- path?: never;
3161
- cookie?: never;
3162
- };
3163
- requestBody?: never;
3164
- responses: {
3165
- /** @description OK */
3166
- 200: {
3167
- headers: {
3168
- [name: string]: unknown;
3169
- };
3170
- content: {
3171
- "application/json": components["schemas"]["SubscriptionDto"][];
3172
- };
3173
- };
3174
- /** @description Error response */
3175
- default: {
3176
- headers: {
3177
- [name: string]: unknown;
3178
- };
3179
- content: {
3180
- "application/json": components["schemas"]["PayNowError"];
3181
- };
3182
- };
3183
- };
3184
- };
3185
- Subscriptions_GetSubscriptionById: {
3186
- parameters: {
3187
- query?: never;
3188
- header?: never;
3189
- path: {
3190
- subscriptionId: components["schemas"]["FlakeId"];
3191
- };
3192
- cookie?: never;
3193
- };
3194
- requestBody?: never;
3195
- responses: {
3196
- /** @description OK */
3197
- 200: {
3198
- headers: {
3199
- [name: string]: unknown;
3200
- };
3201
- content: {
3202
- "application/json": components["schemas"]["SubscriptionDto"];
3203
- };
3204
- };
3205
- /** @description Error response */
3206
- default: {
3207
- headers: {
3208
- [name: string]: unknown;
3209
- };
3210
- content: {
3211
- "application/json": components["schemas"]["PayNowError"];
3212
- };
3213
- };
3214
- };
3215
- };
3216
- Subscriptions_CancelSubscription: {
3217
- parameters: {
3218
- query?: never;
3219
- header?: never;
3220
- path: {
3221
- subscriptionId: components["schemas"]["FlakeId"];
3222
- };
3223
- cookie?: never;
3224
- };
3225
- requestBody?: never;
3226
- responses: {
3227
- /** @description No Content */
3228
- 204: {
3229
- headers: {
3230
- [name: string]: unknown;
3231
- };
3232
- content?: never;
3233
- };
3234
- /** @description Error response */
3235
- default: {
3236
- headers: {
3237
- [name: string]: unknown;
3238
- };
3239
- content: {
3240
- "application/json": components["schemas"]["PayNowError"];
3241
- };
3242
- };
3243
- };
3244
- };
3245
- Tags_GetStorefrontTags: {
3246
- parameters: {
3247
- query?: never;
3248
- header?: never;
3249
- path?: never;
3250
- cookie?: never;
3251
- };
3252
- requestBody?: never;
3253
- responses: {
3254
- /** @description OK */
3255
- 200: {
3256
- headers: {
3257
- [name: string]: unknown;
3258
- };
3259
- content: {
3260
- "application/json": components["schemas"]["StorefrontTagDto"][];
3261
- };
3262
- };
3263
- /** @description Error response */
3264
- default: {
3265
- headers: {
3266
- [name: string]: unknown;
3267
- };
3268
- content: {
3269
- "application/json": components["schemas"]["PayNowError"];
3270
- };
3271
- };
3272
- };
3273
- };
3274
- TierGroups_GetCustomerTierGroups: {
3275
- parameters: {
3276
- query?: never;
3277
- header?: never;
3278
- path?: never;
3279
- cookie?: never;
3280
- };
3281
- requestBody?: never;
3282
- responses: {
3283
- /** @description OK */
3284
- 200: {
3285
- headers: {
3286
- [name: string]: unknown;
3287
- };
3288
- content: {
3289
- "application/json": components["schemas"]["CustomerTierGroupDto"][];
3290
- };
3291
- };
3292
- /** @description Error response */
3293
- default: {
3294
- headers: {
3295
- [name: string]: unknown;
3296
- };
3297
- content: {
3298
- "application/json": components["schemas"]["PayNowError"];
3299
- };
3300
- };
3301
- };
3302
- };
3303
- TierGroups_UpdateSubscriptionTierGroup: {
3304
- parameters: {
3305
- query?: never;
3306
- header?: never;
3307
- path: {
3308
- id: components["schemas"]["FlakeId"];
3309
- };
3310
- cookie?: never;
3311
- };
3312
- requestBody?: {
3313
- content: {
3314
- "application/json": components["schemas"]["UpdateSubscriptionTierRequestDto"];
3315
- "text/json": components["schemas"]["UpdateSubscriptionTierRequestDto"];
3316
- "application/*+json": components["schemas"]["UpdateSubscriptionTierRequestDto"];
3317
- };
3318
- };
3319
- responses: {
3320
- /** @description OK */
3321
- 200: {
3322
- headers: {
3323
- [name: string]: unknown;
3324
- };
3325
- content: {
3326
- "application/json": components["schemas"]["UpdateSubscriptionResponseDto"];
3327
- };
3328
- };
3329
- /** @description Error response */
3330
- default: {
3331
- headers: {
3332
- [name: string]: unknown;
3333
- };
3334
- content: {
3335
- "application/json": components["schemas"]["PayNowError"];
3336
- };
3337
- };
3338
- };
3339
- };
3340
- TierGroups_UpdateSubscriptionTierGroupPreview: {
3341
- parameters: {
3342
- query?: never;
3343
- header?: never;
3344
- path: {
3345
- id: components["schemas"]["FlakeId"];
3346
- };
3347
- cookie?: never;
3348
- };
3349
- requestBody?: {
3350
- content: {
3351
- "application/json": components["schemas"]["UpdateSubscriptionTierRequestDto"];
3352
- "text/json": components["schemas"]["UpdateSubscriptionTierRequestDto"];
3353
- "application/*+json": components["schemas"]["UpdateSubscriptionTierRequestDto"];
3354
- };
3355
- };
3356
- responses: {
3357
- /** @description OK */
3358
- 200: {
3359
- headers: {
3360
- [name: string]: unknown;
3361
- };
3362
- content: {
3363
- "application/json": components["schemas"]["UpdateSubscriptionResponseDto"];
3364
- };
3365
- };
3366
- /** @description Error response */
3367
- default: {
3368
- headers: {
3369
- [name: string]: unknown;
3370
- };
3371
- content: {
3372
- "application/json": components["schemas"]["PayNowError"];
3373
- };
3374
- };
3375
- };
3376
- };
3377
- }
3378
- export declare const operationMappings: {
3379
- readonly Cart_GetCart: {
3380
- readonly method: "GET";
3381
- readonly path: "/v1/store/cart";
3382
- };
3383
- readonly Cart_ClearCart: {
3384
- readonly method: "DELETE";
3385
- readonly path: "/v1/store/cart";
3386
- };
3387
- readonly Cart_AddLine: {
3388
- readonly method: "PUT";
3389
- readonly path: "/v1/store/cart/lines";
3390
- };
3391
- readonly Cart_CreateCartCheckout: {
3392
- readonly method: "POST";
3393
- readonly path: "/v1/store/cart/checkout";
3394
- };
3395
- readonly Checkout_CreateCheckoutSession: {
3396
- readonly method: "POST";
3397
- readonly path: "/v1/checkouts";
3398
- };
3399
- readonly Customer_AuthenticateStorefrontCustomer: {
3400
- readonly method: "POST";
3401
- readonly path: "/v1/store/customer/auth";
3402
- };
3403
- readonly Customer_GetStorefrontCustomer: {
3404
- readonly method: "GET";
3405
- readonly path: "/v1/store/customer";
3406
- };
3407
- readonly Customer_GetStorefrontGiftCard: {
3408
- readonly method: "GET";
3409
- readonly path: "/v1/store/customer/giftcards/lookup/{code}";
3410
- };
3411
- readonly Delivery_GetStorefrontCustomerDeliveryItems: {
3412
- readonly method: "GET";
3413
- readonly path: "/v1/store/customer/delivery/items";
3414
- };
3415
- readonly Discord_DoProductsHaveDiscordActions: {
3416
- readonly method: "GET";
3417
- readonly path: "/v1/stores/{storeId}/product_versions/discord_actions";
3418
- };
3419
- readonly Navlinks_GetStorefrontNavLinks: {
3420
- readonly method: "GET";
3421
- readonly path: "/v1/store/navlinks";
3422
- };
3423
- readonly Products_GetStorefrontProducts: {
3424
- readonly method: "GET";
3425
- readonly path: "/v1/store/products";
3426
- };
3427
- readonly Products_GetStorefrontProductByIdOrSlug: {
3428
- readonly method: "GET";
3429
- readonly path: "/v1/store/products/{idOrSlug}";
3430
- };
3431
- readonly Store_GetStorefrontStore: {
3432
- readonly method: "GET";
3433
- readonly path: "/v1/store";
3434
- };
3435
- readonly Subscriptions_GetSubscriptions: {
3436
- readonly method: "GET";
3437
- readonly path: "/v1/store/customer/subscriptions";
3438
- };
3439
- readonly Subscriptions_GetSubscriptionById: {
3440
- readonly method: "GET";
3441
- readonly path: "/v1/store/customer/subscriptions/{subscriptionId}";
3442
- };
3443
- readonly Subscriptions_CancelSubscription: {
3444
- readonly method: "DELETE";
3445
- readonly path: "/v1/store/customer/subscriptions/{subscriptionId}";
3446
- };
3447
- readonly Tags_GetStorefrontTags: {
3448
- readonly method: "GET";
3449
- readonly path: "/v1/store/tags";
3450
- };
3451
- readonly TierGroups_GetCustomerTierGroups: {
3452
- readonly method: "GET";
3453
- readonly path: "/v1/store/tier-groups";
3454
- };
3455
- readonly TierGroups_UpdateSubscriptionTierGroup: {
3456
- readonly method: "POST";
3457
- readonly path: "/v1/store/tier-groups/{id}/change";
3458
- };
3459
- readonly TierGroups_UpdateSubscriptionTierGroupPreview: {
3460
- readonly method: "POST";
3461
- readonly path: "/v1/store/tier-groups/{id}/change/preview";
3462
- };
3463
- };
3464
- //# sourceMappingURL=storefront.d.ts.map