@paynow-gg/typescript-sdk 1.0.52 → 1.0.54

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -87,35 +87,38 @@ export interface paths {
87
87
  patch?: never;
88
88
  trace?: never;
89
89
  };
90
- "/v1/store/customer": {
90
+ "/v1/store/customer/auth": {
91
91
  parameters: {
92
92
  query?: never;
93
93
  header?: never;
94
94
  path?: never;
95
95
  cookie?: never;
96
96
  };
97
+ get?: never;
98
+ put?: never;
97
99
  /**
98
- * Get current customer
99
- * @description Retrieves the current customer from the passed Customer token.
100
+ * Authenticate customer
101
+ * @description Creates a customer and returns a customer token from a platform account.
100
102
  */
101
- get: operations["Customer_GetStorefrontCustomer"];
102
- put?: never;
103
- post?: never;
103
+ post: operations["Customer_AuthenticateStorefrontCustomer"];
104
104
  delete?: never;
105
105
  options?: never;
106
106
  head?: never;
107
107
  patch?: never;
108
108
  trace?: never;
109
109
  };
110
- "/v1/store/customer/giftcards/lookup/{code}": {
110
+ "/v1/store/customer": {
111
111
  parameters: {
112
112
  query?: never;
113
113
  header?: never;
114
114
  path?: never;
115
115
  cookie?: never;
116
116
  };
117
- /** Lookup a gift card by the code */
118
- get: operations["Customer_GetStorefrontGiftCard"];
117
+ /**
118
+ * Get current customer
119
+ * @description Retrieves the current customer from the passed Customer token.
120
+ */
121
+ get: operations["Customer_GetStorefrontCustomer"];
119
122
  put?: never;
120
123
  post?: never;
121
124
  delete?: never;
@@ -124,20 +127,17 @@ export interface paths {
124
127
  patch?: never;
125
128
  trace?: never;
126
129
  };
127
- "/v1/store/customer/auth": {
130
+ "/v1/store/customer/giftcards/lookup/{code}": {
128
131
  parameters: {
129
132
  query?: never;
130
133
  header?: never;
131
134
  path?: never;
132
135
  cookie?: never;
133
136
  };
134
- get?: never;
137
+ /** Lookup a gift card by the code */
138
+ get: operations["Customer_GetStorefrontGiftCard"];
135
139
  put?: never;
136
- /**
137
- * Authenticate customer
138
- * @description Creates a customer and returns a customer token from a platform account.
139
- */
140
- post: operations["Customer_AuthenticateStorefrontCustomer"];
140
+ post?: never;
141
141
  delete?: never;
142
142
  options?: never;
143
143
  head?: never;
@@ -276,6 +276,59 @@ export interface paths {
276
276
  patch?: never;
277
277
  trace?: never;
278
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
+ };
279
332
  "/v1/store/tags": {
280
333
  parameters: {
281
334
  query?: never;
@@ -304,6 +357,19 @@ export interface components {
304
357
  type: components["schemas"]["PayNowActorType"];
305
358
  id?: components["schemas"]["FlakeId"];
306
359
  };
360
+ /** @description Alipay payment method details */
361
+ AlipayDetailsDto: {
362
+ /**
363
+ * @description The Alipay buyer identifier
364
+ * @example buyer_abc123
365
+ */
366
+ buyer_id?: null | string;
367
+ /**
368
+ * @description A unique fingerprint for this Alipay account
369
+ * @example fingerprint_xyz789
370
+ */
371
+ fingerprint?: null | string;
372
+ };
307
373
  AuthenticateStorefrontCustomerRequestDto: {
308
374
  platform: components["schemas"]["CustomerProfilePlatform"];
309
375
  /**
@@ -316,6 +382,101 @@ export interface components {
316
382
  /** @description The token for the Customer */
317
383
  customer_token: string;
318
384
  };
385
+ /** @description Bancontact payment method details */
386
+ BancontactDetailsDto: {
387
+ /**
388
+ * @description The bank identifier
389
+ * @example bnp_paribas
390
+ */
391
+ bank?: null | string;
392
+ /**
393
+ * @description The bank name
394
+ * @example BNP Paribas
395
+ */
396
+ bank_name?: null | string;
397
+ /**
398
+ * @description The Bank Identifier Code
399
+ * @example GEBABEBB
400
+ */
401
+ bic?: null | string;
402
+ /**
403
+ * @description The last 4 digits of the IBAN
404
+ * @example 3456
405
+ */
406
+ iban_last4?: null | string;
407
+ /**
408
+ * @description The payer name
409
+ * @example Jean Dupont
410
+ */
411
+ payer_name?: null | string;
412
+ };
413
+ /** @description Card payment method details */
414
+ CardDetailsDto: {
415
+ /**
416
+ * @description The card brand
417
+ * @example visa
418
+ */
419
+ brand: string;
420
+ /**
421
+ * @description The country code where the card was issued
422
+ * @example US
423
+ */
424
+ country: string;
425
+ /**
426
+ * Format: int32
427
+ * @description The card expiration month
428
+ * @example 12
429
+ */
430
+ exp_month: number;
431
+ /**
432
+ * Format: int32
433
+ * @description The card expiration year
434
+ * @example 2028
435
+ */
436
+ exp_year: number;
437
+ /**
438
+ * @description A unique fingerprint for this card
439
+ * @example abc123def456
440
+ */
441
+ fingerprint: string;
442
+ /**
443
+ * @description The card funding type
444
+ * @example credit
445
+ */
446
+ funding: string;
447
+ /**
448
+ * @description The last 4 digits of the card number
449
+ * @example 4242
450
+ */
451
+ last4: string;
452
+ /**
453
+ * @description The Bank Identification Number (first 6/8 digits of card).
454
+ * Only available internally.
455
+ * @example 424242
456
+ */
457
+ bin?: null | string;
458
+ /**
459
+ * @description The card issuer/bank name.
460
+ * Only available internally.
461
+ * @example Chase Bank
462
+ */
463
+ issuer?: null | string;
464
+ /**
465
+ * @description The card description.
466
+ * Only available internally.
467
+ * @example Visa Signature
468
+ */
469
+ description?: null | string;
470
+ wallet?: components["schemas"]["CardWalletDto"];
471
+ };
472
+ /** @description Digital wallet details for a card */
473
+ CardWalletDto: {
474
+ /**
475
+ * @description The type of digital wallet
476
+ * @example apple_pay
477
+ */
478
+ type: string;
479
+ };
319
480
  /** @description Represents a customer's shopping cart */
320
481
  CartDto: {
321
482
  store_id: components["schemas"]["FlakeId"];
@@ -378,6 +539,19 @@ export interface components {
378
539
  gift_to_customer?: components["schemas"]["CustomerDto"];
379
540
  gift_to_customer_id?: components["schemas"]["FlakeId"];
380
541
  };
542
+ /** @description Cash App payment method details */
543
+ CashAppDetailsDto: {
544
+ /**
545
+ * @description The Cash App buyer identifier
546
+ * @example buyer_abc123
547
+ */
548
+ buyer_id: string;
549
+ /**
550
+ * @description The Cash App cashtag
551
+ * @example $johndoe
552
+ */
553
+ cashtag: string;
554
+ };
381
555
  /** @description Request to create a new checkout session from a cart */
382
556
  CreateCartCheckoutSessionDto: {
383
557
  coupon_id?: components["schemas"]["FlakeId"];
@@ -439,6 +613,46 @@ export interface components {
439
613
  /** @description The URL to redirect the customer to complete checkout */
440
614
  url: string;
441
615
  };
616
+ /** @description Cryptocurrency payment method details */
617
+ CryptoDetailsDto: {
618
+ /**
619
+ * @description The cryptocurrency used
620
+ * @example BTC
621
+ */
622
+ crypto_currency: string;
623
+ /**
624
+ * @description The amount in cryptocurrency
625
+ * @example 0.00150000
626
+ */
627
+ crypto_amount: string;
628
+ /**
629
+ * @description The total amount paid in cryptocurrency
630
+ * @example 0.00150000
631
+ */
632
+ total_paid: string;
633
+ /**
634
+ * Format: int32
635
+ * @description The number of blockchain confirmations
636
+ * @example 6
637
+ */
638
+ confirmations: number;
639
+ };
640
+ CustomVariableLineItemDto: {
641
+ id: components["schemas"]["FlakeId"];
642
+ /** @description The identifier used to reference this custom variable (e.g., "color", "size"). */
643
+ identifier: string;
644
+ /** @description The display name of the custom variable shown to users. */
645
+ name: string;
646
+ /** @description A detailed description of what this custom variable represents. */
647
+ description: string;
648
+ /**
649
+ * Format: int64
650
+ * @description The price associated with this custom variable in the smallest currency unit (e.g., cents).
651
+ */
652
+ price: number;
653
+ /** @description The selected value for this custom variable. */
654
+ value: string;
655
+ };
442
656
  /**
443
657
  * @description Defines the type of input method for a custom variable.
444
658
  * @enum {string}
@@ -536,6 +750,50 @@ export interface components {
536
750
  /** @description The URL to the user's avatar image on this platform. */
537
751
  avatar_url?: null | string;
538
752
  };
753
+ /** @description iDEAL payment method details */
754
+ IdealDetailsDto: {
755
+ /**
756
+ * @description The bank identifier
757
+ * @example abn_amro
758
+ */
759
+ bank: string;
760
+ /**
761
+ * @description The Bank Identifier Code
762
+ * @example ABNANL2A
763
+ */
764
+ bic: string;
765
+ /**
766
+ * @description The last 4 digits of the IBAN
767
+ * @example 1234
768
+ */
769
+ iban_last4?: null | string;
770
+ /**
771
+ * @description The payer name
772
+ * @example John Doe
773
+ */
774
+ payer_name?: null | string;
775
+ };
776
+ /** @description Klarna payment method details */
777
+ KlarnaDetailsDto: {
778
+ /**
779
+ * @description The country code
780
+ * @example SE
781
+ */
782
+ country?: null | string;
783
+ /**
784
+ * @description The Klarna payment method category
785
+ * @example pay_later
786
+ */
787
+ method_category?: null | string;
788
+ };
789
+ /** @description Link payment method details */
790
+ LinkDetailsDto: {
791
+ /**
792
+ * @description The email associated with the Link account
793
+ * @example john.doe@example.com
794
+ */
795
+ email: string;
796
+ };
539
797
  /** @description Represents a Minecraft profile for a customer. */
540
798
  MinecraftProfileDto: {
541
799
  /**
@@ -553,6 +811,42 @@ export interface components {
553
811
  /** @description The URL to the player's Minecraft skin rendered as an avatar. */
554
812
  avatar_url: string;
555
813
  };
814
+ /** @description Przelewy24 payment method details */
815
+ P24DetailsDto: {
816
+ /**
817
+ * @description The bank identifier
818
+ * @example ing
819
+ */
820
+ bank: string;
821
+ /**
822
+ * @description The payer name
823
+ * @example Jan Kowalski
824
+ */
825
+ payer_name?: null | string;
826
+ };
827
+ /** @description Pay by Bank payment method details */
828
+ PayByBankDetailsDto: {
829
+ /**
830
+ * @description The bank name
831
+ * @example Chase Bank
832
+ */
833
+ bank_name?: null | string;
834
+ /**
835
+ * @description The Bank Identifier Code
836
+ * @example CHASUS33
837
+ */
838
+ bic?: null | string;
839
+ /**
840
+ * @description The country code
841
+ * @example US
842
+ */
843
+ country?: null | string;
844
+ /**
845
+ * @description The payer name
846
+ * @example John Smith
847
+ */
848
+ payer_name?: null | string;
849
+ };
556
850
  /** @enum {string} */
557
851
  PayNowActorType: "anonymous" | "user" | "api_key" | "customer" | "game_server" | "internal" | "admin" | "platform" | "global_customer";
558
852
  /** @description Represents a PayNow error */
@@ -581,6 +875,115 @@ export interface components {
581
875
  /** @description An array of multiple errors. Only used by some API services. */
582
876
  errors?: null | components["schemas"]["ValidationError"][];
583
877
  };
878
+ /** @description PayPal payment method details */
879
+ PayPalDetailsDto: {
880
+ /**
881
+ * @description The PayPal payer identifier
882
+ * @example PAYERID123
883
+ */
884
+ payer_id: string;
885
+ /**
886
+ * @description The PayPal account email
887
+ * @example john.doe@example.com
888
+ */
889
+ payer_email: string;
890
+ /**
891
+ * @description The PayPal account holder name
892
+ * @example John Doe
893
+ */
894
+ payer_name: string;
895
+ /**
896
+ * @description The country code of the PayPal account
897
+ * @example US
898
+ */
899
+ country: string;
900
+ /**
901
+ * @description Indicates if this PayPal account is vaulted
902
+ * @example true
903
+ */
904
+ vault: boolean;
905
+ /**
906
+ * @description Indicates if vault approval is pending
907
+ * @example false
908
+ */
909
+ pending_vault_approval?: null | boolean;
910
+ /**
911
+ * @description Indicates if this is a standalone setup
912
+ * @example false
913
+ */
914
+ standalone_setup?: null | boolean;
915
+ };
916
+ /** @description Contains detailed information about a payment method.
917
+ * DISCLAIMER: These fields are not guaranteed to be backwards compatible and may change or be removed without notice. */
918
+ PaymentMethodDetailsDto: {
919
+ card?: components["schemas"]["CardDetailsDto"];
920
+ cashapp?: components["schemas"]["CashAppDetailsDto"];
921
+ paypal?: components["schemas"]["PayPalDetailsDto"];
922
+ link?: components["schemas"]["LinkDetailsDto"];
923
+ crypto?: components["schemas"]["CryptoDetailsDto"];
924
+ steamskins?: components["schemas"]["SteamSkinsDetailsDto"];
925
+ ideal?: components["schemas"]["IdealDetailsDto"];
926
+ p24?: components["schemas"]["P24DetailsDto"];
927
+ bancontact?: components["schemas"]["BancontactDetailsDto"];
928
+ klarna?: components["schemas"]["KlarnaDetailsDto"];
929
+ alipay?: components["schemas"]["AlipayDetailsDto"];
930
+ pay_by_bank?: components["schemas"]["PayByBankDetailsDto"];
931
+ pix?: components["schemas"]["PixDetailsDto"];
932
+ };
933
+ /** @description Represents a stored payment method */
934
+ PaymentMethodDto: {
935
+ id: components["schemas"]["FlakeId"];
936
+ customer_id: components["schemas"]["FlakeId"];
937
+ /** @description The payment gateway provider */
938
+ gateway: string;
939
+ /** @description The gateway's identifier for this payment method */
940
+ gateway_id: string;
941
+ /** @description The gateway's customer identifier */
942
+ gateway_customer_id: string;
943
+ /**
944
+ * @description The gateway-specific type identifier
945
+ * @example card
946
+ */
947
+ gateway_type: string;
948
+ /**
949
+ * @description The payment method type
950
+ * @example card
951
+ */
952
+ method_type: string;
953
+ method_details: components["schemas"]["PaymentMethodDetailsDto"];
954
+ /**
955
+ * Format: date-time
956
+ * @description The date and time when this payment method was created
957
+ * @example 2025-03-15T10:20:30Z
958
+ */
959
+ created_at: string;
960
+ /** @description The gateway entity identifier */
961
+ gateway_entity_identifier: string;
962
+ /**
963
+ * Format: date-time
964
+ * @description The date and time when this payment method was last updated
965
+ * @example 2025-03-20T14:30:00Z
966
+ */
967
+ updated_at?: null | string;
968
+ };
969
+ /** @description Pix payment method details */
970
+ PixDetailsDto: {
971
+ /**
972
+ * @description The bank name
973
+ * @example Banco do Brasil
974
+ */
975
+ bank_name?: null | string;
976
+ /**
977
+ * @description The bank account number
978
+ * @example 12345-6
979
+ */
980
+ bank_account_number?: null | string;
981
+ /**
982
+ * @description The payer name
983
+ * @example João Silva
984
+ */
985
+ payer_name?: null | string;
986
+ };
584
987
  /** @enum {string} */
585
988
  PlatformCapability: "invalid" | "connected_users";
586
989
  PlatformStoreTypeAssociationDetailsDto: {
@@ -645,6 +1048,11 @@ export interface components {
645
1048
  */
646
1049
  name: string;
647
1050
  };
1051
+ /**
1052
+ * @description Describes how proration is handled when a subscription change is applied.
1053
+ * @enum {string}
1054
+ */
1055
+ ProrationBehaviorDto: "invalid" | "immediate" | "next_billing_period" | "none";
648
1056
  PublicPlatformDto: {
649
1057
  id: components["schemas"]["FlakeId"];
650
1058
  slug: string;
@@ -666,6 +1074,30 @@ export interface components {
666
1074
  };
667
1075
  /** @enum {string} */
668
1076
  SaleDiscountType: "percent" | "amount";
1077
+ /** @description Object representing a sales tax jurisdiction and its associated taxes. */
1078
+ SalesTaxJurisdictionDto: {
1079
+ /**
1080
+ * @description The name of the tax jurisdiction.
1081
+ * @example EU OSS
1082
+ */
1083
+ name: string;
1084
+ /** @description List of taxes applied within this jurisdiction. */
1085
+ taxes: components["schemas"]["SalesTaxJurisdictionTaxDto"][];
1086
+ /** @description Explanation for why taxes are not applied, if applicable.
1087
+ * This property is null when taxes are applied. */
1088
+ not_taxed_reason?: null | string;
1089
+ };
1090
+ /** @description Object representing a specific tax within a sales tax jurisdiction. */
1091
+ SalesTaxJurisdictionTaxDto: {
1092
+ /** @description The name of the tax. */
1093
+ tax_name: string;
1094
+ /** @description The amount subject to taxation, formatted as a string. */
1095
+ taxable_amount: string;
1096
+ /** @description The calculated tax amount, formatted as a string. */
1097
+ tax_amount: string;
1098
+ /** @description The rate at which the tax is applied, formatted as a string. */
1099
+ tax_rate: string;
1100
+ };
669
1101
  /**
670
1102
  * Format: steam-id
671
1103
  * @description A 64-bit Steam account identifier. Accepts string or numeric format.
@@ -680,6 +1112,32 @@ export interface components {
680
1112
  /** @description The URL to the user's Steam avatar image. */
681
1113
  avatar_url: string;
682
1114
  };
1115
+ /** @description Steam Skins payment method details */
1116
+ SteamSkinsDetailsDto: {
1117
+ /** @description The list of Steam inventory items used for payment */
1118
+ items: components["schemas"]["SteamSkinsInventoryItemDetailsDto"][];
1119
+ };
1120
+ SteamSkinsInventoryItemDetailsDto: {
1121
+ /** @description The unique identifier of the Steam item */
1122
+ id: string;
1123
+ /**
1124
+ * Format: int32
1125
+ * @description The Steam app ID
1126
+ * @example 730
1127
+ */
1128
+ app_id: number;
1129
+ /**
1130
+ * @description The name of the item
1131
+ * @example AK-47 | Redline
1132
+ */
1133
+ name: string;
1134
+ /**
1135
+ * Format: int32
1136
+ * @description The price of the item in the smallest currency unit
1137
+ * @example 2500
1138
+ */
1139
+ price: number;
1140
+ };
683
1141
  /** @description Represents a PayNow store and its associated configuration. */
684
1142
  StoreDto: {
685
1143
  id: components["schemas"]["FlakeId"];
@@ -1273,48 +1731,639 @@ export interface components {
1273
1731
  */
1274
1732
  updated_at?: null | string;
1275
1733
  };
1276
- TrustStoreRequirementDto: {
1277
- id: components["schemas"]["FlakeId"];
1278
- store_id: components["schemas"]["FlakeId"];
1279
- /** @description Template ID if this requirement was created from a template. Null for ad-hoc requirements. */
1280
- template_id?: null | string;
1281
- originating_flag_id?: components["schemas"]["FlakeId"];
1282
- category: components["schemas"]["StoreRequirementCategory"];
1283
- /** @description Unique code identifying the type of requirement. Copied from template or custom for ad-hoc requirements. */
1284
- code: string;
1285
- /** @description Human-readable name of the requirement. Copied from template or custom for ad-hoc requirements. */
1286
- name: string;
1287
- /** @description Detailed description explaining what the store needs to provide. Copied from template or custom for ad-hoc requirements. */
1288
- description?: null | string;
1289
- /** @description JSON schema defining the form fields, validation rules, and document requirements */
1290
- schema?: null;
1291
- /** @description Additional metadata for this requirement (stored as JSON) */
1292
- metadata: {
1293
- [key: string]: string;
1294
- };
1295
- status: components["schemas"]["StoreRequirementStatus"];
1296
- requested_by: components["schemas"]["StoreRequirementActionParty"];
1297
- /** @description Specifies the specific requester entity (e.g., "stripe", "trolley", or admin user ID)
1298
- * Free-form string for internal records */
1299
- requested_by_detail?: null | string;
1734
+ /** @description Represents a billing amount breakdown for a subscription. */
1735
+ SubscriptionBillingAmountDto: {
1736
+ /** @description ISO 4217 currency code, in lowercase. */
1737
+ currency: string;
1300
1738
  /**
1301
- * Format: date-time
1302
- * @description When this requirement was created
1739
+ * Format: int64
1740
+ * @description Base amount before discounts or tax, in smallest currency units.
1303
1741
  */
1304
- created_at: string;
1742
+ subtotal: number;
1305
1743
  /**
1306
- * Format: date-time
1307
- * @description When this requirement was last updated
1744
+ * Format: int64
1745
+ * @description Total discount applied, in smallest currency units.
1308
1746
  */
1309
- updated_at?: null | string;
1747
+ discount: number;
1310
1748
  /**
1311
- * Format: date-time
1312
- * @description When this requirement must be completed by (optional)
1749
+ * Format: int64
1750
+ * @description Tax amount, in smallest currency units.
1313
1751
  */
1314
- deadline_at?: null | string;
1752
+ tax: number;
1315
1753
  /**
1316
- * Format: date-time
1317
- * @description When the store submitted their response to this requirement
1754
+ * Format: int64
1755
+ * @description Amount due after discounts and tax, in smallest currency units.
1756
+ */
1757
+ total: number;
1758
+ };
1759
+ /** @description Pricing breakdown for a subscription change, in the smallest units of the given currency (e.g. cents). */
1760
+ SubscriptionChangeAmountDto: {
1761
+ /** @description ISO 4217 currency code, in lowercase. */
1762
+ currency: string;
1763
+ /**
1764
+ * Format: int64
1765
+ * @description Base amount before discounts or tax, in smallest currency units.
1766
+ */
1767
+ subtotal: number;
1768
+ /**
1769
+ * Format: int64
1770
+ * @description Total discount applied, in smallest currency units.
1771
+ */
1772
+ discount: number;
1773
+ /**
1774
+ * Format: int64
1775
+ * @description Tax amount, in smallest currency units.
1776
+ */
1777
+ tax: number;
1778
+ /**
1779
+ * Format: int64
1780
+ * @description Amount due after discounts and tax, in smallest currency units.
1781
+ */
1782
+ total: number;
1783
+ };
1784
+ /** @description A pending or applied change to a subscription. */
1785
+ SubscriptionChangeDto: {
1786
+ id: components["schemas"]["FlakeId"];
1787
+ subscription_id: components["schemas"]["FlakeId"];
1788
+ prorated_order_id?: components["schemas"]["FlakeId"];
1789
+ status: components["schemas"]["SubscriptionChangeStatusDto"];
1790
+ proration_behavior: components["schemas"]["ProrationBehaviorDto"];
1791
+ /** @description Whether this change was initiated without active customer interaction. */
1792
+ off_session: boolean;
1793
+ prorated_amount: components["schemas"]["SubscriptionChangeProratedAmountDto"];
1794
+ /** Format: date-time */
1795
+ created_at: string;
1796
+ /** Format: date-time */
1797
+ applied_at?: null | string;
1798
+ lines: components["schemas"]["SubscriptionChangeLineDto"][];
1799
+ next_billing_amount: components["schemas"]["SubscriptionChangeAmountDto"];
1800
+ next_billing_presentment_amount: components["schemas"]["SubscriptionChangeAmountDto"];
1801
+ };
1802
+ /** @description Pricing breakdown for a single subscription change line, in the smallest units of the given currency (e.g. cents). */
1803
+ SubscriptionChangeLineAmountDto: {
1804
+ /** @description ISO 4217 currency code in lowercase. */
1805
+ currency: string;
1806
+ /**
1807
+ * Format: int64
1808
+ * @description Base amount before discounts or tax, in smallest currency units.
1809
+ */
1810
+ subtotal: number;
1811
+ /**
1812
+ * Format: int64
1813
+ * @description Total discount applied, in smallest currency units.
1814
+ */
1815
+ discount: number;
1816
+ /**
1817
+ * Format: int64
1818
+ * @description Tax amount, in smallest currency units.
1819
+ */
1820
+ tax: number;
1821
+ /**
1822
+ * Format: int64
1823
+ * @description Amount due after discounts and tax, in smallest currency units.
1824
+ */
1825
+ total: number;
1826
+ };
1827
+ /** @description A single line item within a subscription change. */
1828
+ SubscriptionChangeLineDto: {
1829
+ id: components["schemas"]["FlakeId"];
1830
+ subscription_line_id?: components["schemas"]["FlakeId"];
1831
+ /** @description Whether this line is being removed by the change. */
1832
+ is_deleted: boolean;
1833
+ /** @description Whether tax is included in the base price. */
1834
+ tax_inclusive: boolean;
1835
+ /**
1836
+ * Format: int64
1837
+ * @description Base price in smallest settlement currency units.
1838
+ */
1839
+ price: number;
1840
+ product: components["schemas"]["SubscriptionChangeLineProductDto"];
1841
+ amount: components["schemas"]["SubscriptionChangeLineAmountDto"];
1842
+ presentment_amount: components["schemas"]["SubscriptionChangeLineAmountDto"];
1843
+ /**
1844
+ * Format: int64
1845
+ * @description Prorated charge for this line in smallest settlement currency units.
1846
+ */
1847
+ prorated_amount: number;
1848
+ /**
1849
+ * Format: int64
1850
+ * @description Prorated charge for this line in smallest presentment currency units.
1851
+ */
1852
+ prorated_presentment_amount: number;
1853
+ /**
1854
+ * Format: int64
1855
+ * @description Minutes remaining in the billing period at the time of change - used to calculate proration.
1856
+ */
1857
+ remaining_minutes: number;
1858
+ /**
1859
+ * Format: int64
1860
+ * @description Total minutes in the billing period - used to calculate proration.
1861
+ */
1862
+ total_minutes: number;
1863
+ };
1864
+ /** @description The product associated with a subscription change line. */
1865
+ SubscriptionChangeLineProductDto: {
1866
+ id: components["schemas"]["FlakeId"];
1867
+ version_id: components["schemas"]["FlakeId"];
1868
+ /** @description Display name of the product. */
1869
+ name: string;
1870
+ /** @description URL of the product image, if set. */
1871
+ image_url?: null | string;
1872
+ selected_gameserver_id?: components["schemas"]["FlakeId"];
1873
+ /** @description The pricing region used to determine the price, if applicable. */
1874
+ pricing_region_id?: null | string;
1875
+ /** @description Custom variables set on this line item, keyed by variable identifier. */
1876
+ custom_variables: {
1877
+ [key: string]: components["schemas"]["CustomVariableLineItemDto"];
1878
+ };
1879
+ };
1880
+ /** @description The total prorated charge for a subscription change, expressed in both settlement and presentment currencies. */
1881
+ SubscriptionChangeProratedAmountDto: {
1882
+ /** @description ISO 4217 settlement currency code, in lowercase. */
1883
+ currency: string;
1884
+ /**
1885
+ * Format: int64
1886
+ * @description Total prorated charge in smallest settlement currency units, including tax.
1887
+ */
1888
+ prorated_amount: number;
1889
+ /** @description ISO 4217 presentment currency code, in lowercase. */
1890
+ presentment_currency: string;
1891
+ /**
1892
+ * Format: int64
1893
+ * @description Total prorated charge in smallest presentment currency units, including tax.
1894
+ */
1895
+ presentment_prorated_amount: number;
1896
+ };
1897
+ /**
1898
+ * @description Represents the status of a subscription change.
1899
+ * @enum {string}
1900
+ */
1901
+ SubscriptionChangeStatusDto: "invalid" | "pending_payment" | "pending_renewal" | "applied" | "canceled";
1902
+ /** @description Data transfer object representing a store subscription. */
1903
+ SubscriptionDto: {
1904
+ id: components["schemas"]["FlakeId"];
1905
+ /** @description Human-readable identifier for the subscription. */
1906
+ pretty_id: string;
1907
+ store_id: components["schemas"]["FlakeId"];
1908
+ store?: components["schemas"]["StorefrontStoreDto"];
1909
+ customer: components["schemas"]["CustomerDto"];
1910
+ payment_method_id?: components["schemas"]["FlakeId"];
1911
+ payment_method?: components["schemas"]["PaymentMethodDto"];
1912
+ pending_change?: components["schemas"]["SubscriptionChangeDto"];
1913
+ next_billing_amount: components["schemas"]["SubscriptionBillingAmountDto"];
1914
+ next_billing_presentment_amount: components["schemas"]["SubscriptionBillingAmountDto"];
1915
+ status: components["schemas"]["SubscriptionStatus"];
1916
+ coupon_id?: components["schemas"]["FlakeId"];
1917
+ /**
1918
+ * Format: date-time
1919
+ * @description Date when a repeating coupon ends for this subscription.
1920
+ */
1921
+ coupon_repeating_ends_at?: null | string;
1922
+ affiliate_id?: components["schemas"]["FlakeId"];
1923
+ checkout_id?: components["schemas"]["FlakeId"];
1924
+ checkout_line_id?: components["schemas"]["FlakeId"];
1925
+ /** @description Name used for billing purposes. */
1926
+ billing_name?: null | string;
1927
+ /** @description Email used for billing purposes. */
1928
+ billing_email?: null | string;
1929
+ /** @description Country code used for billing purposes. */
1930
+ billing_country?: null | string;
1931
+ /** @description List of tax jurisdictions applicable to this subscription. */
1932
+ tax_jurisdictions: components["schemas"]["SalesTaxJurisdictionDto"][];
1933
+ /** @description IP address of the customer at the time of subscription. */
1934
+ customer_ip?: null | string;
1935
+ /**
1936
+ * @deprecated
1937
+ * @description Indicates whether this subscription is a gift.
1938
+ */
1939
+ readonly gift: boolean;
1940
+ gift_to_customer_id?: components["schemas"]["FlakeId"];
1941
+ gift_to_customer?: components["schemas"]["CustomerDto"];
1942
+ product_id?: components["schemas"]["FlakeId"];
1943
+ product_version_id?: components["schemas"]["FlakeId"];
1944
+ /**
1945
+ * @deprecated
1946
+ * @description Name of the product associated with this subscription.
1947
+ */
1948
+ readonly product_name?: null | string;
1949
+ /**
1950
+ * @deprecated
1951
+ * @description URL for the product image.
1952
+ */
1953
+ readonly product_image_url?: null | string;
1954
+ /**
1955
+ * Format: int32
1956
+ * @description Numeric value of the billing interval.
1957
+ */
1958
+ interval_value: number;
1959
+ interval_scale: components["schemas"]["ProductSubscriptionIntervalScale"];
1960
+ /** @description Currency code used for billing this subscription. */
1961
+ currency: string;
1962
+ /**
1963
+ * @deprecated
1964
+ * @description Indicates whether tax is included in the base price itself.
1965
+ */
1966
+ readonly tax_inclusive: boolean;
1967
+ /**
1968
+ * Format: int64
1969
+ * @deprecated
1970
+ * @description Base price of the subscription in smallest currency units (e.g., cents).
1971
+ */
1972
+ readonly price: number;
1973
+ /**
1974
+ * @deprecated
1975
+ * @description Formatted string representation of the price.
1976
+ */
1977
+ readonly price_str?: null | string;
1978
+ /**
1979
+ * Format: int64
1980
+ * @description Amount of discount applied in smallest currency units.
1981
+ */
1982
+ discount_amount: number;
1983
+ /** @description Formatted string representation of the discount amount. */
1984
+ readonly discount_amount_str: string;
1985
+ /**
1986
+ * Format: int64
1987
+ * @description Subtotal amount in smallest currency units.
1988
+ */
1989
+ subtotal_amount: number;
1990
+ /** @description Formatted string representation of the subtotal amount. */
1991
+ readonly subtotal_amount_str: string;
1992
+ /**
1993
+ * Format: int64
1994
+ * @description Tax amount in smallest currency units.
1995
+ */
1996
+ tax_amount: number;
1997
+ /** @description Formatted string representation of the tax amount. */
1998
+ readonly tax_amount_str: string;
1999
+ /**
2000
+ * Format: int64
2001
+ * @description Total amount in smallest currency units.
2002
+ */
2003
+ total_amount: number;
2004
+ /** @description Formatted string representation of the total amount. */
2005
+ readonly total_amount_str: string;
2006
+ /**
2007
+ * Format: int64
2008
+ * @description Initial discount amount in smallest currency units for the first billing cycle.
2009
+ */
2010
+ initial_discount_amount: number;
2011
+ /** @description Formatted string representation of the initial discount amount. */
2012
+ readonly initial_discount_amount_str: string;
2013
+ /**
2014
+ * Format: int64
2015
+ * @description Initial subtotal amount in smallest currency units for the first billing cycle.
2016
+ */
2017
+ initial_subtotal_amount: number;
2018
+ /** @description Formatted string representation of the initial subtotal amount. */
2019
+ readonly initial_subtotal_amount_str: string;
2020
+ /**
2021
+ * Format: int64
2022
+ * @description Initial gift card usage amount in smallest currency units.
2023
+ */
2024
+ initial_giftcard_usage_amount: number;
2025
+ /** @description Formatted string representation of the initial gift card usage amount. */
2026
+ readonly initial_giftcard_usage_amount_str: string;
2027
+ /**
2028
+ * Format: int64
2029
+ * @description Initial tax amount in smallest currency units for the first billing cycle.
2030
+ */
2031
+ initial_tax_amount: number;
2032
+ /** @description Formatted string representation of the initial tax amount. */
2033
+ readonly initial_tax_amount_str: string;
2034
+ /**
2035
+ * Format: int64
2036
+ * @description Initial total amount in smallest currency units for the first billing cycle.
2037
+ */
2038
+ initial_total_amount: number;
2039
+ /** @description Formatted string representation of the initial total amount. */
2040
+ readonly initial_total_amount_str: string;
2041
+ /** @description Presentment currency code (currency shown to customer). */
2042
+ presentment_currency?: null | string;
2043
+ /**
2044
+ * Format: int64
2045
+ * @description Presentment subtotal amount in smallest currency units.
2046
+ */
2047
+ presentment_subtotal_amount?: null | number;
2048
+ /** @description Formatted string representation of the presentment subtotal amount. */
2049
+ readonly presentment_subtotal_amount_str?: null | string;
2050
+ /**
2051
+ * Format: int64
2052
+ * @description Presentment discount amount in smallest currency units.
2053
+ */
2054
+ presentment_discount_amount?: null | number;
2055
+ /** @description Formatted string representation of the presentment discount amount. */
2056
+ readonly presentment_discount_amount_str?: null | string;
2057
+ /**
2058
+ * Format: int64
2059
+ * @description Presentment tax amount in smallest currency units.
2060
+ */
2061
+ presentment_tax_amount?: null | number;
2062
+ /** @description Formatted string representation of the presentment tax amount. */
2063
+ readonly presentment_tax_amount_str?: null | string;
2064
+ /**
2065
+ * Format: int64
2066
+ * @description Presentment total amount in smallest currency units.
2067
+ */
2068
+ presentment_total_amount?: null | number;
2069
+ /** @description Formatted string representation of the presentment total amount. */
2070
+ readonly presentment_total_amount_str?: null | string;
2071
+ /**
2072
+ * Format: int64
2073
+ * @description Initial presentment discount amount in smallest currency units for the first billing cycle.
2074
+ */
2075
+ initial_presentment_discount_amount?: null | number;
2076
+ /** @description Formatted string representation of the initial presentment discount amount. */
2077
+ readonly initial_presentment_discount_amount_str?: null | string;
2078
+ /**
2079
+ * Format: int64
2080
+ * @description Initial presentment subtotal amount in smallest currency units for the first billing cycle.
2081
+ */
2082
+ initial_presentment_subtotal_amount?: null | number;
2083
+ /** @description Formatted string representation of the initial presentment subtotal amount. */
2084
+ readonly initial_presentment_subtotal_amount_str?: null | string;
2085
+ /**
2086
+ * Format: int64
2087
+ * @description Initial presentment gift card usage amount in smallest currency units.
2088
+ */
2089
+ initial_presentment_giftcard_usage_amount?: null | number;
2090
+ /** @description Formatted string representation of the initial presentment gift card usage amount. */
2091
+ readonly initial_presentment_giftcard_usage_amount_str?: null | string;
2092
+ /**
2093
+ * Format: int64
2094
+ * @description Initial presentment tax amount in smallest currency units for the first billing cycle.
2095
+ */
2096
+ initial_presentment_tax_amount?: null | number;
2097
+ /** @description Formatted string representation of the initial presentment tax amount. */
2098
+ readonly initial_presentment_tax_amount_str?: null | string;
2099
+ /**
2100
+ * Format: int64
2101
+ * @description Initial presentment total amount in smallest currency units for the first billing cycle.
2102
+ */
2103
+ initial_presentment_total_amount?: null | number;
2104
+ /** @description Formatted string representation of the initial presentment total amount. */
2105
+ readonly initial_presentment_total_amount_str?: null | string;
2106
+ /** @description The foreign exchange rate applied (if presentment currency differs from settlement currency). */
2107
+ fx_rate?: null | string;
2108
+ /**
2109
+ * @deprecated
2110
+ * @description Identifier for the pricing region associated with this subscription.
2111
+ */
2112
+ readonly pricing_region_id?: null | string;
2113
+ /**
2114
+ * Format: date-time
2115
+ * @description Start date of the current billing period.
2116
+ */
2117
+ current_period_start?: null | string;
2118
+ /**
2119
+ * Format: date-time
2120
+ * @description End date of the current billing period.
2121
+ */
2122
+ current_period_end?: null | string;
2123
+ /**
2124
+ * Format: int32
2125
+ * @description Sequence number of the current billing cycle.
2126
+ */
2127
+ billing_cycle_sequence?: null | number;
2128
+ /**
2129
+ * Format: date-time
2130
+ * @description Date and time when the next payment attempt will occur.
2131
+ */
2132
+ next_attempt_at?: null | string;
2133
+ /**
2134
+ * Format: int32
2135
+ * @description Number of payment attempts made for the current billing cycle.
2136
+ */
2137
+ attempt_count?: null | number;
2138
+ /**
2139
+ * Format: date-time
2140
+ * @description Date and time when the subscription was created.
2141
+ */
2142
+ created_at: string;
2143
+ /**
2144
+ * Format: date-time
2145
+ * @description Date and time when the subscription was last updated.
2146
+ */
2147
+ updated_at?: null | string;
2148
+ /**
2149
+ * Format: date-time
2150
+ * @description Date and time when the subscription became active.
2151
+ */
2152
+ active_at?: null | string;
2153
+ /**
2154
+ * Format: date-time
2155
+ * @description Date and time when the subscription was canceled.
2156
+ */
2157
+ canceled_at?: null | string;
2158
+ /** @description Reason provided for cancellation. */
2159
+ cancel_reason?: null | string;
2160
+ /** @description Line items associated with this subscription. */
2161
+ lines: components["schemas"]["SubscriptionLineDto"][];
2162
+ };
2163
+ /** @description Represents a line item within a subscription. */
2164
+ SubscriptionLineDto: {
2165
+ id: components["schemas"]["FlakeId"];
2166
+ subscription_id: components["schemas"]["FlakeId"];
2167
+ checkout_line_id?: components["schemas"]["FlakeId"];
2168
+ initial_order_line_id?: components["schemas"]["FlakeId"];
2169
+ /** @description Identifier for the pricing region associated with this subscription line. */
2170
+ pricing_region_id?: null | string;
2171
+ gift_to_customer_id?: components["schemas"]["FlakeId"];
2172
+ gift_to_customer?: components["schemas"]["CustomerDto"];
2173
+ selected_gameserver_id?: components["schemas"]["FlakeId"];
2174
+ sale_id?: components["schemas"]["FlakeId"];
2175
+ trial_id?: components["schemas"]["FlakeId"];
2176
+ product_id: components["schemas"]["FlakeId"];
2177
+ product_version_id: components["schemas"]["FlakeId"];
2178
+ /** @description Name of the product associated with this subscription line. */
2179
+ product_name: string;
2180
+ /** @description URL for the product image. */
2181
+ product_image_url?: null | string;
2182
+ /** @description Indicates whether tax is included in the base price itself. */
2183
+ tax_inclusive: boolean;
2184
+ /** @description Currency code for this subscription line. */
2185
+ currency: string;
2186
+ /**
2187
+ * Format: int64
2188
+ * @description Base price of the subscription line in smallest currency units (e.g., cents).
2189
+ */
2190
+ price: number;
2191
+ /**
2192
+ * Format: int64
2193
+ * @description Amount of discount applied in smallest currency units.
2194
+ */
2195
+ discount_amount: number;
2196
+ /** @description Formatted string representation of the discount amount. */
2197
+ readonly discount_amount_str: string;
2198
+ /**
2199
+ * Format: int64
2200
+ * @description Subtotal amount in smallest currency units.
2201
+ */
2202
+ subtotal_amount: number;
2203
+ /** @description Formatted string representation of the subtotal amount. */
2204
+ readonly subtotal_amount_str: string;
2205
+ /**
2206
+ * Format: int64
2207
+ * @description Tax amount in smallest currency units.
2208
+ */
2209
+ tax_amount: number;
2210
+ /** @description Formatted string representation of the tax amount. */
2211
+ readonly tax_amount_str: string;
2212
+ /**
2213
+ * Format: int64
2214
+ * @description Total amount in smallest currency units.
2215
+ */
2216
+ total_amount: number;
2217
+ /** @description Formatted string representation of the total amount. */
2218
+ readonly total_amount_str: string;
2219
+ /**
2220
+ * Format: int64
2221
+ * @description Initial discount amount in smallest currency units for the first billing cycle.
2222
+ */
2223
+ initial_discount_amount: number;
2224
+ /** @description Formatted string representation of the initial discount amount. */
2225
+ readonly initial_discount_amount_str: string;
2226
+ /**
2227
+ * Format: int64
2228
+ * @description Initial subtotal amount in smallest currency units for the first billing cycle.
2229
+ */
2230
+ initial_subtotal_amount: number;
2231
+ /** @description Formatted string representation of the initial subtotal amount. */
2232
+ readonly initial_subtotal_amount_str: string;
2233
+ /**
2234
+ * Format: int64
2235
+ * @description Initial gift card usage amount in smallest currency units.
2236
+ */
2237
+ initial_giftcard_usage_amount: number;
2238
+ /** @description Formatted string representation of the initial gift card usage amount. */
2239
+ readonly initial_giftcard_usage_amount_str: string;
2240
+ /**
2241
+ * Format: int64
2242
+ * @description Initial tax amount in smallest currency units for the first billing cycle.
2243
+ */
2244
+ initial_tax_amount: number;
2245
+ /** @description Formatted string representation of the initial tax amount. */
2246
+ readonly initial_tax_amount_str: string;
2247
+ /**
2248
+ * Format: int64
2249
+ * @description Initial total amount in smallest currency units for the first billing cycle.
2250
+ */
2251
+ initial_total_amount: number;
2252
+ /** @description Formatted string representation of the initial total amount. */
2253
+ readonly initial_total_amount_str: string;
2254
+ /** @description Presentment currency code (currency shown to customer). */
2255
+ presentment_currency?: null | string;
2256
+ /**
2257
+ * Format: int64
2258
+ * @description Presentment subtotal amount in smallest currency units.
2259
+ */
2260
+ presentment_subtotal_amount?: null | number;
2261
+ /** @description Formatted string representation of the presentment subtotal amount. */
2262
+ readonly presentment_subtotal_amount_str?: null | string;
2263
+ /**
2264
+ * Format: int64
2265
+ * @description Presentment discount amount in smallest currency units.
2266
+ */
2267
+ presentment_discount_amount?: null | number;
2268
+ /** @description Formatted string representation of the presentment discount amount. */
2269
+ readonly presentment_discount_amount_str?: null | string;
2270
+ /**
2271
+ * Format: int64
2272
+ * @description Presentment tax amount in smallest currency units.
2273
+ */
2274
+ presentment_tax_amount?: null | number;
2275
+ /** @description Formatted string representation of the presentment tax amount. */
2276
+ readonly presentment_tax_amount_str?: null | string;
2277
+ /**
2278
+ * Format: int64
2279
+ * @description Presentment total amount in smallest currency units.
2280
+ */
2281
+ presentment_total_amount?: null | number;
2282
+ /** @description Formatted string representation of the presentment total amount. */
2283
+ readonly presentment_total_amount_str?: null | string;
2284
+ /**
2285
+ * Format: int64
2286
+ * @description Initial presentment discount amount in smallest currency units for the first billing cycle.
2287
+ */
2288
+ initial_presentment_discount_amount?: null | number;
2289
+ /** @description Formatted string representation of the initial presentment discount amount. */
2290
+ readonly initial_presentment_discount_amount_str?: null | string;
2291
+ /**
2292
+ * Format: int64
2293
+ * @description Initial presentment subtotal amount in smallest currency units for the first billing cycle.
2294
+ */
2295
+ initial_presentment_subtotal_amount?: null | number;
2296
+ /** @description Formatted string representation of the initial presentment subtotal amount. */
2297
+ readonly initial_presentment_subtotal_amount_str?: null | string;
2298
+ /**
2299
+ * Format: int64
2300
+ * @description Initial presentment gift card usage amount in smallest currency units.
2301
+ */
2302
+ initial_presentment_giftcard_usage_amount?: null | number;
2303
+ /** @description Formatted string representation of the initial presentment gift card usage amount. */
2304
+ readonly initial_presentment_giftcard_usage_amount_str?: null | string;
2305
+ /**
2306
+ * Format: int64
2307
+ * @description Initial presentment tax amount in smallest currency units for the first billing cycle.
2308
+ */
2309
+ initial_presentment_tax_amount?: null | number;
2310
+ /** @description Formatted string representation of the initial presentment tax amount. */
2311
+ readonly initial_presentment_tax_amount_str?: null | string;
2312
+ /**
2313
+ * Format: int64
2314
+ * @description Initial presentment total amount in smallest currency units for the first billing cycle.
2315
+ */
2316
+ initial_presentment_total_amount?: null | number;
2317
+ /** @description Formatted string representation of the initial presentment total amount. */
2318
+ readonly initial_presentment_total_amount_str?: null | string;
2319
+ };
2320
+ /**
2321
+ * @description Represents the current state of a subscription.
2322
+ * @enum {string}
2323
+ */
2324
+ SubscriptionStatus: "invalid" | "created" | "active" | "canceled";
2325
+ TrustStoreRequirementDto: {
2326
+ id: components["schemas"]["FlakeId"];
2327
+ store_id: components["schemas"]["FlakeId"];
2328
+ /** @description Template ID if this requirement was created from a template. Null for ad-hoc requirements. */
2329
+ template_id?: null | string;
2330
+ originating_flag_id?: components["schemas"]["FlakeId"];
2331
+ category: components["schemas"]["StoreRequirementCategory"];
2332
+ /** @description Unique code identifying the type of requirement. Copied from template or custom for ad-hoc requirements. */
2333
+ code: string;
2334
+ /** @description Human-readable name of the requirement. Copied from template or custom for ad-hoc requirements. */
2335
+ name: string;
2336
+ /** @description Detailed description explaining what the store needs to provide. Copied from template or custom for ad-hoc requirements. */
2337
+ description?: null | string;
2338
+ /** @description JSON schema defining the form fields, validation rules, and document requirements */
2339
+ schema?: null;
2340
+ /** @description Additional metadata for this requirement (stored as JSON) */
2341
+ metadata: {
2342
+ [key: string]: string;
2343
+ };
2344
+ status: components["schemas"]["StoreRequirementStatus"];
2345
+ requested_by: components["schemas"]["StoreRequirementActionParty"];
2346
+ /** @description Specifies the specific requester entity (e.g., "stripe", "trolley", or admin user ID)
2347
+ * Free-form string for internal records */
2348
+ requested_by_detail?: null | string;
2349
+ /**
2350
+ * Format: date-time
2351
+ * @description When this requirement was created
2352
+ */
2353
+ created_at: string;
2354
+ /**
2355
+ * Format: date-time
2356
+ * @description When this requirement was last updated
2357
+ */
2358
+ updated_at?: null | string;
2359
+ /**
2360
+ * Format: date-time
2361
+ * @description When this requirement must be completed by (optional)
2362
+ */
2363
+ deadline_at?: null | string;
2364
+ /**
2365
+ * Format: date-time
2366
+ * @description When the store submitted their response to this requirement
1318
2367
  */
1319
2368
  submitted_at?: null | string;
1320
2369
  /**
@@ -1640,14 +2689,25 @@ export interface operations {
1640
2689
  };
1641
2690
  };
1642
2691
  };
1643
- Customer_GetStorefrontCustomer: {
2692
+ Customer_AuthenticateStorefrontCustomer: {
1644
2693
  parameters: {
1645
2694
  query?: never;
1646
- header?: never;
2695
+ header?: {
2696
+ /** @description The IP address (IPv4 or IPv6) of the customer. Required if the request is not being made from the customer's browser. */
2697
+ "x-paynow-customer-ip"?: string;
2698
+ /** @description The customer's country code in ISO 3166-1 alpha-2 format. Optional, but recommended if you have this available. */
2699
+ "x-paynow-customer-countrycode"?: string;
2700
+ };
1647
2701
  path?: never;
1648
2702
  cookie?: never;
1649
2703
  };
1650
- requestBody?: never;
2704
+ requestBody?: {
2705
+ content: {
2706
+ "application/json": components["schemas"]["AuthenticateStorefrontCustomerRequestDto"];
2707
+ "text/json": components["schemas"]["AuthenticateStorefrontCustomerRequestDto"];
2708
+ "application/*+json": components["schemas"]["AuthenticateStorefrontCustomerRequestDto"];
2709
+ };
2710
+ };
1651
2711
  responses: {
1652
2712
  /** @description OK */
1653
2713
  200: {
@@ -1655,7 +2715,7 @@ export interface operations {
1655
2715
  [name: string]: unknown;
1656
2716
  };
1657
2717
  content: {
1658
- "application/json": components["schemas"]["CustomerDto"];
2718
+ "application/json": components["schemas"]["AuthenticateStorefrontCustomerResponseDto"];
1659
2719
  };
1660
2720
  };
1661
2721
  /** @description Error response */
@@ -1669,13 +2729,11 @@ export interface operations {
1669
2729
  };
1670
2730
  };
1671
2731
  };
1672
- Customer_GetStorefrontGiftCard: {
2732
+ Customer_GetStorefrontCustomer: {
1673
2733
  parameters: {
1674
2734
  query?: never;
1675
2735
  header?: never;
1676
- path: {
1677
- code: string;
1678
- };
2736
+ path?: never;
1679
2737
  cookie?: never;
1680
2738
  };
1681
2739
  requestBody?: never;
@@ -1686,7 +2744,7 @@ export interface operations {
1686
2744
  [name: string]: unknown;
1687
2745
  };
1688
2746
  content: {
1689
- "application/json": components["schemas"]["StorefrontGiftCardDto"];
2747
+ "application/json": components["schemas"]["CustomerDto"];
1690
2748
  };
1691
2749
  };
1692
2750
  /** @description Error response */
@@ -1700,25 +2758,16 @@ export interface operations {
1700
2758
  };
1701
2759
  };
1702
2760
  };
1703
- Customer_AuthenticateStorefrontCustomer: {
2761
+ Customer_GetStorefrontGiftCard: {
1704
2762
  parameters: {
1705
2763
  query?: never;
1706
- header?: {
1707
- /** @description The IP address (IPv4 or IPv6) of the customer. Required if the request is not being made from the customer's browser. */
1708
- "x-paynow-customer-ip"?: string;
1709
- /** @description The customer's country code in ISO 3166-1 alpha-2 format. Optional, but recommended if you have this available. */
1710
- "x-paynow-customer-countrycode"?: string;
2764
+ header?: never;
2765
+ path: {
2766
+ code: string;
1711
2767
  };
1712
- path?: never;
1713
2768
  cookie?: never;
1714
2769
  };
1715
- requestBody?: {
1716
- content: {
1717
- "application/json": components["schemas"]["AuthenticateStorefrontCustomerRequestDto"];
1718
- "text/json": components["schemas"]["AuthenticateStorefrontCustomerRequestDto"];
1719
- "application/*+json": components["schemas"]["AuthenticateStorefrontCustomerRequestDto"];
1720
- };
1721
- };
2770
+ requestBody?: never;
1722
2771
  responses: {
1723
2772
  /** @description OK */
1724
2773
  200: {
@@ -1726,7 +2775,7 @@ export interface operations {
1726
2775
  [name: string]: unknown;
1727
2776
  };
1728
2777
  content: {
1729
- "application/json": components["schemas"]["AuthenticateStorefrontCustomerResponseDto"];
2778
+ "application/json": components["schemas"]["StorefrontGiftCardDto"];
1730
2779
  };
1731
2780
  };
1732
2781
  /** @description Error response */
@@ -1962,6 +3011,121 @@ export interface operations {
1962
3011
  };
1963
3012
  };
1964
3013
  };
3014
+ Subscriptions_GetSubscriptions: {
3015
+ parameters: {
3016
+ query?: {
3017
+ customer_id?: components["schemas"]["FlakeId"];
3018
+ subscription_id?: components["schemas"]["FlakeId"];
3019
+ billing_email?: string;
3020
+ payment_method_id?: components["schemas"]["FlakeId"];
3021
+ checkout_id?: components["schemas"]["FlakeId"];
3022
+ trial_id?: components["schemas"]["FlakeId"];
3023
+ status?: components["schemas"]["SubscriptionStatus"][];
3024
+ /** @description The maximum number of items to return in a single request. */
3025
+ limit?: number;
3026
+ /**
3027
+ * @description Returns items after the specified ID.
3028
+ * Used for forward pagination through results.
3029
+ * @example null
3030
+ */
3031
+ after?: components["schemas"]["FlakeId"];
3032
+ /**
3033
+ * @description Returns items before the specified ID.
3034
+ * Used for backward pagination through results.
3035
+ * @example null
3036
+ */
3037
+ before?: components["schemas"]["FlakeId"];
3038
+ /** @description Determines the sort order of returned items.
3039
+ * When true, items are returned in ascending order.
3040
+ * When false, items are returned in descending order. */
3041
+ asc?: boolean;
3042
+ };
3043
+ header?: never;
3044
+ path?: never;
3045
+ cookie?: never;
3046
+ };
3047
+ requestBody?: never;
3048
+ responses: {
3049
+ /** @description OK */
3050
+ 200: {
3051
+ headers: {
3052
+ [name: string]: unknown;
3053
+ };
3054
+ content: {
3055
+ "application/json": components["schemas"]["SubscriptionDto"][];
3056
+ };
3057
+ };
3058
+ /** @description Error response */
3059
+ default: {
3060
+ headers: {
3061
+ [name: string]: unknown;
3062
+ };
3063
+ content: {
3064
+ "application/json": components["schemas"]["PayNowError"];
3065
+ };
3066
+ };
3067
+ };
3068
+ };
3069
+ Subscriptions_GetSubscriptionById: {
3070
+ parameters: {
3071
+ query?: never;
3072
+ header?: never;
3073
+ path: {
3074
+ subscriptionId: components["schemas"]["FlakeId"];
3075
+ };
3076
+ cookie?: never;
3077
+ };
3078
+ requestBody?: never;
3079
+ responses: {
3080
+ /** @description OK */
3081
+ 200: {
3082
+ headers: {
3083
+ [name: string]: unknown;
3084
+ };
3085
+ content: {
3086
+ "application/json": components["schemas"]["SubscriptionDto"];
3087
+ };
3088
+ };
3089
+ /** @description Error response */
3090
+ default: {
3091
+ headers: {
3092
+ [name: string]: unknown;
3093
+ };
3094
+ content: {
3095
+ "application/json": components["schemas"]["PayNowError"];
3096
+ };
3097
+ };
3098
+ };
3099
+ };
3100
+ Subscriptions_CancelSubscription: {
3101
+ parameters: {
3102
+ query?: never;
3103
+ header?: never;
3104
+ path: {
3105
+ subscriptionId: components["schemas"]["FlakeId"];
3106
+ };
3107
+ cookie?: never;
3108
+ };
3109
+ requestBody?: never;
3110
+ responses: {
3111
+ /** @description No Content */
3112
+ 204: {
3113
+ headers: {
3114
+ [name: string]: unknown;
3115
+ };
3116
+ content?: never;
3117
+ };
3118
+ /** @description Error response */
3119
+ default: {
3120
+ headers: {
3121
+ [name: string]: unknown;
3122
+ };
3123
+ content: {
3124
+ "application/json": components["schemas"]["PayNowError"];
3125
+ };
3126
+ };
3127
+ };
3128
+ };
1965
3129
  Tags_GetStorefrontTags: {
1966
3130
  parameters: {
1967
3131
  query?: never;
@@ -2013,6 +3177,10 @@ export declare const operationMappings: {
2013
3177
  readonly method: "POST";
2014
3178
  readonly path: "/v1/checkouts";
2015
3179
  };
3180
+ readonly Customer_AuthenticateStorefrontCustomer: {
3181
+ readonly method: "POST";
3182
+ readonly path: "/v1/store/customer/auth";
3183
+ };
2016
3184
  readonly Customer_GetStorefrontCustomer: {
2017
3185
  readonly method: "GET";
2018
3186
  readonly path: "/v1/store/customer";
@@ -2021,10 +3189,6 @@ export declare const operationMappings: {
2021
3189
  readonly method: "GET";
2022
3190
  readonly path: "/v1/store/customer/giftcards/lookup/{code}";
2023
3191
  };
2024
- readonly Customer_AuthenticateStorefrontCustomer: {
2025
- readonly method: "POST";
2026
- readonly path: "/v1/store/customer/auth";
2027
- };
2028
3192
  readonly Delivery_GetStorefrontCustomerDeliveryItems: {
2029
3193
  readonly method: "GET";
2030
3194
  readonly path: "/v1/store/customer/delivery/items";
@@ -2049,6 +3213,18 @@ export declare const operationMappings: {
2049
3213
  readonly method: "GET";
2050
3214
  readonly path: "/v1/store";
2051
3215
  };
3216
+ readonly Subscriptions_GetSubscriptions: {
3217
+ readonly method: "GET";
3218
+ readonly path: "/v1/store/customer/subscriptions";
3219
+ };
3220
+ readonly Subscriptions_GetSubscriptionById: {
3221
+ readonly method: "GET";
3222
+ readonly path: "/v1/store/customer/subscriptions/{subscriptionId}";
3223
+ };
3224
+ readonly Subscriptions_CancelSubscription: {
3225
+ readonly method: "DELETE";
3226
+ readonly path: "/v1/store/customer/subscriptions/{subscriptionId}";
3227
+ };
2052
3228
  readonly Tags_GetStorefrontTags: {
2053
3229
  readonly method: "GET";
2054
3230
  readonly path: "/v1/store/tags";