@paynow-gg/typescript-sdk 1.0.53 → 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.
@@ -1620,6 +1620,80 @@ export interface paths {
1620
1620
  patch?: never;
1621
1621
  trace?: never;
1622
1622
  };
1623
+ "/v1/stores/{storeId}/subscriptions/{subscriptionId}/change": {
1624
+ parameters: {
1625
+ query?: never;
1626
+ header?: never;
1627
+ path?: never;
1628
+ cookie?: never;
1629
+ };
1630
+ get?: never;
1631
+ put?: never;
1632
+ /**
1633
+ * Update items on a subscription
1634
+ * @description Updates the subscription lines, including the pricing, on an active subscription. The subscription must not be within 1 hour of its
1635
+ * next renewal, and only one change can be pending at a time.
1636
+ *
1637
+ * **Access**
1638
+ *
1639
+ * This endpoint requires the Subscription Updates API feature flag to be enabled on your store. Contact
1640
+ * PayNow to request access.
1641
+ *
1642
+ * **Proration behavior**
1643
+ *
1644
+ * Controlled by the `proration_behavior` field on the request:
1645
+ *
1646
+ * - `immediate` - the change is applied as soon as possible.
1647
+ * Proration is calculated for the remaining period. If the prorated amount is ≥ $0.50 (or equivalent in other currencies), an order is
1648
+ * initiated against the subscription's payment method; the change is applied once the payment succeeds.
1649
+ * If the prorated amount is below $0.50, no order is created and the change is
1650
+ * applied instantly.
1651
+ * Only one proration order is allowed per billing cycle - a second immediate change in the same
1652
+ * period will be rejected if a proration was already charged.
1653
+ * When a payment is triggered, the response will include a `pending_payment` object. The payment result
1654
+ * is synchronous - check `pending_payment.declined` to determine whether the charge succeeded. If
1655
+ * declined, `pending_payment.decline_code` contains the reason.
1656
+ *
1657
+ * - `next_billing_period` - no payment is created. The change is queued and will be applied automatically
1658
+ * at the start of the next renewal cycle. Ideal for downgrades.
1659
+ *
1660
+ * - `none` - the change is applied instantly with no proration calculated or charged.
1661
+ *
1662
+ * **Reverting a pending change**
1663
+ *
1664
+ * If a `next_billing_period` change is pending and the new request specifies the same product versions
1665
+ * that are already on the subscription (i.e. reverting back to the current state), the pending change
1666
+ * is canceled rather than rejected. The canceled change record is returned in the response.
1667
+ */
1668
+ post: operations["Subscriptions_UpdateSubscription"];
1669
+ delete?: never;
1670
+ options?: never;
1671
+ head?: never;
1672
+ patch?: never;
1673
+ trace?: never;
1674
+ };
1675
+ "/v1/stores/{storeId}/subscriptions/{subscriptionId}/change/preview": {
1676
+ parameters: {
1677
+ query?: never;
1678
+ header?: never;
1679
+ path?: never;
1680
+ cookie?: never;
1681
+ };
1682
+ get?: never;
1683
+ put?: never;
1684
+ /**
1685
+ * Preview a subscription change
1686
+ * @description Simulates a subscription change and returns the pricing breakdown without creating any records or
1687
+ * initiating a payment. Accepts the same request body as `POST change` — see that endpoint for
1688
+ * full parameter documentation. Does not return the `pending_payment` field.
1689
+ */
1690
+ post: operations["Subscriptions_PreviewSubscriptionChange"];
1691
+ delete?: never;
1692
+ options?: never;
1693
+ head?: never;
1694
+ patch?: never;
1695
+ trace?: never;
1696
+ };
1623
1697
  "/v1/stores/{storeId}/tags": {
1624
1698
  parameters: {
1625
1699
  query?: never;
@@ -2192,6 +2266,16 @@ export interface components {
2192
2266
  is_banned: boolean;
2193
2267
  ban_id?: components["schemas"]["FlakeId"];
2194
2268
  };
2269
+ /** @description Payment outcome information returned after a subscription change triggers an immediate charge. */
2270
+ CheckoutPaymentInfoDto: {
2271
+ /** @description Status string from the payment provider. */
2272
+ status: string;
2273
+ /** @description Indicates whether the payment was declined. */
2274
+ declined: boolean;
2275
+ decline_code: components["schemas"]["PaymentDeclineCode"];
2276
+ /** @description Client-side payment token for completing 3DS or other redirect-based flows. */
2277
+ payment_token?: null | string;
2278
+ };
2195
2279
  CommandAttemptDto: {
2196
2280
  id: components["schemas"]["FlakeId"];
2197
2281
  store_id: components["schemas"]["FlakeId"];
@@ -3547,7 +3631,7 @@ export interface components {
3547
3631
  /** @description Represents an order line item in a customer's order */
3548
3632
  OrderLineDto: {
3549
3633
  id: components["schemas"]["FlakeId"];
3550
- checkout_line_id: components["schemas"]["FlakeId"];
3634
+ checkout_line_id?: components["schemas"]["FlakeId"];
3551
3635
  product_id: components["schemas"]["FlakeId"];
3552
3636
  product_version_id: components["schemas"]["FlakeId"];
3553
3637
  /**
@@ -3560,9 +3644,13 @@ export interface components {
3560
3644
  * @example https://cdn.example.com/images/premium-game-pass.jpg
3561
3645
  */
3562
3646
  product_image_url?: null | string;
3647
+ /** @description Customer-presentable description of the order line. */
3648
+ description?: null | string;
3563
3649
  /** @description The Gift Card ID of that product in this order line */
3564
3650
  created_giftcard_id?: null | string;
3565
3651
  subscription_id?: components["schemas"]["FlakeId"];
3652
+ subscription_line_id?: components["schemas"]["FlakeId"];
3653
+ subscription_change_line_id?: components["schemas"]["FlakeId"];
3566
3654
  trial_id?: components["schemas"]["FlakeId"];
3567
3655
  /**
3568
3656
  * Format: int32
@@ -3745,7 +3833,7 @@ export interface components {
3745
3833
  * @description Defines the type of items contained in an order
3746
3834
  * @enum {string}
3747
3835
  */
3748
- OrderType: "one_time" | "subscription" | "mixed";
3836
+ OrderType: "one_time" | "subscription_initial" | "subscription_renewal" | "subscription_proration" | "mixed";
3749
3837
  /** @description Przelewy24 payment method details */
3750
3838
  P24DetailsDto: {
3751
3839
  /**
@@ -4572,6 +4660,11 @@ export interface components {
4572
4660
  quantity_to_add?: null | number;
4573
4661
  prefer_as_subscription: boolean;
4574
4662
  };
4663
+ /**
4664
+ * @description Describes how proration is handled when a subscription change is applied.
4665
+ * @enum {string}
4666
+ */
4667
+ ProrationBehaviorDto: "invalid" | "immediate" | "next_billing_period" | "none";
4575
4668
  PublicPlatformDto: {
4576
4669
  id: components["schemas"]["FlakeId"];
4577
4670
  slug: string;
@@ -5111,15 +5204,314 @@ export interface components {
5111
5204
  StoreRequirementStatus: "invalid" | "pending" | "under_review" | "requires_revision" | "approved" | "expired" | "waived" | "rejected_final";
5112
5205
  /** @enum {string} */
5113
5206
  StoreRestrictionFlagDto: "none" | "payments_disabled" | "payouts_disabled";
5207
+ StoreTrustDto: {
5208
+ store_id: components["schemas"]["FlakeId"];
5209
+ status: components["schemas"]["StoreTrustStatusDto"];
5210
+ status_reason?: null | string;
5211
+ restrictions: components["schemas"]["StoreRestrictionFlagDto"];
5212
+ /** Format: date-time */
5213
+ created_at: string;
5214
+ /** Format: date-time */
5215
+ updated_at?: null | string;
5216
+ onboarding_steps?: components["schemas"]["StoreTrustOnboardingStepsDto"];
5217
+ events: components["schemas"]["StoreTrustEventDto"][];
5218
+ pending_requirements: components["schemas"]["TrustStoreRequirementDto"][];
5219
+ };
5220
+ StoreTrustEventDto: {
5221
+ id: components["schemas"]["FlakeId"];
5222
+ store_id: components["schemas"]["FlakeId"];
5223
+ type: components["schemas"]["StoreTrustEventTypeDto"];
5224
+ description?: null | string;
5225
+ store_requirement_id?: components["schemas"]["FlakeId"];
5226
+ store_review_id?: components["schemas"]["FlakeId"];
5227
+ actor: components["schemas"]["ActorDto"];
5228
+ /** Format: date-time */
5229
+ created_at: string;
5230
+ };
5231
+ /** @enum {string} */
5232
+ 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";
5233
+ StoreTrustOnboardingStepsDto: {
5234
+ store_id: components["schemas"]["FlakeId"];
5235
+ store_owner_id: components["schemas"]["FlakeId"];
5236
+ payout_onboarding_completed: boolean;
5237
+ kyc_completed: boolean;
5238
+ products_created: boolean;
5239
+ gameserver_linked: boolean;
5240
+ webhooks_active: boolean;
5241
+ downloadable_files_added: boolean;
5242
+ };
5243
+ /** @enum {string} */
5244
+ StoreTrustStatusDto: "invalid" | "pending_review" | "requires_action" | "under_review" | "active" | "restricted" | "offboarded";
5245
+ /** @enum {string} */
5246
+ StoreUpsellCheckoutStyleDto: "unknown" | "inline" | "inline_and_prepayment_dialog" | "dedicated_step";
5247
+ StoreUpsellRecommendationDto: {
5248
+ recommended_product_id: components["schemas"]["FlakeId"];
5249
+ type: components["schemas"]["UpsellTypeDto"];
5250
+ discount_type: components["schemas"]["UpsellDiscountTypeDto"];
5251
+ /** Format: int64 */
5252
+ discount_amount: number;
5253
+ /** Format: int32 */
5254
+ minimum_base_product_quantity?: null | number;
5255
+ /** Format: int32 */
5256
+ quantity_to_add?: null | number;
5257
+ prefer_as_subscription: boolean;
5258
+ };
5259
+ StoreUpsellSettingsDto: {
5260
+ enabled: boolean;
5261
+ automatic_recommendations_enabled: boolean;
5262
+ automatic_recommendations_discount_type: components["schemas"]["UpsellDiscountType"];
5263
+ /** Format: int64 */
5264
+ automatic_recommendations_discount_amount: number;
5265
+ recommendation_overrides_enabled: boolean;
5266
+ recommendation_overrides: components["schemas"]["StoreUpsellRecommendationDto"][];
5267
+ checkout_style: components["schemas"]["StoreUpsellCheckoutStyleDto"];
5268
+ /** Format: date-time */
5269
+ updated_at: string;
5270
+ updated_by: components["schemas"]["ActorDto"];
5271
+ };
5272
+ /** @description Represents a store entity within the storefront system. */
5273
+ StorefrontStoreDto: {
5274
+ id: components["schemas"]["FlakeId"];
5275
+ /**
5276
+ * @description The URL-friendly identifier for the store, used in store URLs.
5277
+ * @example m0ukas-awesome-store
5278
+ */
5279
+ slug: string;
5280
+ /**
5281
+ * @description The display name of the store shown to customers.
5282
+ * @example m0uka's awesome store
5283
+ */
5284
+ name: string;
5285
+ /**
5286
+ * @description The platform or the game of the store.
5287
+ * @example rust
5288
+ */
5289
+ platform: string;
5290
+ /** @description The game of the store. Equivalent to the `platform` for backwards compatibility. */
5291
+ readonly game: string;
5292
+ /**
5293
+ * @description The three-letter ISO currency code used for pricing in this store.
5294
+ * If using the Adaptive Currency feature, this will be updated to reflect customer's local currency
5295
+ * (based on passed in IP / country headers).
5296
+ * @example eur
5297
+ */
5298
+ currency: string;
5299
+ /**
5300
+ * @description The three-letter ISO currency code signifying the main currency of the store.
5301
+ * @example usd
5302
+ */
5303
+ creator_currency: string;
5304
+ /** @description A detailed description of the store. Only present for some platform types. */
5305
+ description?: null | string;
5306
+ /** @description The URL of the store's main website, if not using Hosted Webstores. */
5307
+ website_url?: null | string;
5308
+ /**
5309
+ * @description The email address customers can use to contact store support.
5310
+ * @example support@example.com
5311
+ */
5312
+ support_email?: null | string;
5313
+ /** @description The URL of the store's support page. */
5314
+ support_url?: null | string;
5315
+ /** @description The type of integration this store uses with external systems. */
5316
+ integration_type?: null | string;
5317
+ /** @description Indicates whether the store is in live mode (true) or test mode (false). */
5318
+ live_mode: boolean;
5319
+ /** @description The URL to the store's main logo image. */
5320
+ logo_url?: null | string;
5321
+ /** @description The URL to the store's square logo image. */
5322
+ logo_square_url?: null | string;
5323
+ /**
5324
+ * Format: date-time
5325
+ * @description The date and time when the store was created.
5326
+ */
5327
+ created_at?: null | string;
5328
+ /**
5329
+ * Format: date-time
5330
+ * @description The date and time when the store was last updated.
5331
+ */
5332
+ updated_at?: null | string;
5333
+ };
5334
+ /** @description Represents a billing amount breakdown for a subscription. */
5335
+ SubscriptionBillingAmountDto: {
5336
+ /** @description ISO 4217 currency code, in lowercase. */
5337
+ currency: string;
5338
+ /**
5339
+ * Format: int64
5340
+ * @description Base amount before discounts or tax, in smallest currency units.
5341
+ */
5342
+ subtotal: number;
5343
+ /**
5344
+ * Format: int64
5345
+ * @description Total discount applied, in smallest currency units.
5346
+ */
5347
+ discount: number;
5348
+ /**
5349
+ * Format: int64
5350
+ * @description Tax amount, in smallest currency units.
5351
+ */
5352
+ tax: number;
5353
+ /**
5354
+ * Format: int64
5355
+ * @description Amount due after discounts and tax, in smallest currency units.
5356
+ */
5357
+ total: number;
5358
+ };
5359
+ /** @description Pricing breakdown for a subscription change, in the smallest units of the given currency (e.g. cents). */
5360
+ SubscriptionChangeAmountDto: {
5361
+ /** @description ISO 4217 currency code, in lowercase. */
5362
+ currency: string;
5363
+ /**
5364
+ * Format: int64
5365
+ * @description Base amount before discounts or tax, in smallest currency units.
5366
+ */
5367
+ subtotal: number;
5368
+ /**
5369
+ * Format: int64
5370
+ * @description Total discount applied, in smallest currency units.
5371
+ */
5372
+ discount: number;
5373
+ /**
5374
+ * Format: int64
5375
+ * @description Tax amount, in smallest currency units.
5376
+ */
5377
+ tax: number;
5378
+ /**
5379
+ * Format: int64
5380
+ * @description Amount due after discounts and tax, in smallest currency units.
5381
+ */
5382
+ total: number;
5383
+ };
5384
+ /** @description A pending or applied change to a subscription. */
5385
+ SubscriptionChangeDto: {
5386
+ id: components["schemas"]["FlakeId"];
5387
+ subscription_id: components["schemas"]["FlakeId"];
5388
+ prorated_order_id?: components["schemas"]["FlakeId"];
5389
+ status: components["schemas"]["SubscriptionChangeStatusDto"];
5390
+ proration_behavior: components["schemas"]["ProrationBehaviorDto"];
5391
+ /** @description Whether this change was initiated without active customer interaction. */
5392
+ off_session: boolean;
5393
+ prorated_amount: components["schemas"]["SubscriptionChangeProratedAmountDto"];
5394
+ /** Format: date-time */
5395
+ created_at: string;
5396
+ /** Format: date-time */
5397
+ applied_at?: null | string;
5398
+ lines: components["schemas"]["SubscriptionChangeLineDto"][];
5399
+ next_billing_amount: components["schemas"]["SubscriptionChangeAmountDto"];
5400
+ next_billing_presentment_amount: components["schemas"]["SubscriptionChangeAmountDto"];
5401
+ };
5402
+ /** @description Pricing breakdown for a single subscription change line, in the smallest units of the given currency (e.g. cents). */
5403
+ SubscriptionChangeLineAmountDto: {
5404
+ /** @description ISO 4217 currency code in lowercase. */
5405
+ currency: string;
5406
+ /**
5407
+ * Format: int64
5408
+ * @description Base amount before discounts or tax, in smallest currency units.
5409
+ */
5410
+ subtotal: number;
5411
+ /**
5412
+ * Format: int64
5413
+ * @description Total discount applied, in smallest currency units.
5414
+ */
5415
+ discount: number;
5416
+ /**
5417
+ * Format: int64
5418
+ * @description Tax amount, in smallest currency units.
5419
+ */
5420
+ tax: number;
5421
+ /**
5422
+ * Format: int64
5423
+ * @description Amount due after discounts and tax, in smallest currency units.
5424
+ */
5425
+ total: number;
5426
+ };
5427
+ /** @description A single line item within a subscription change. */
5428
+ SubscriptionChangeLineDto: {
5429
+ id: components["schemas"]["FlakeId"];
5430
+ subscription_line_id?: components["schemas"]["FlakeId"];
5431
+ /** @description Whether this line is being removed by the change. */
5432
+ is_deleted: boolean;
5433
+ /** @description Whether tax is included in the base price. */
5434
+ tax_inclusive: boolean;
5435
+ /**
5436
+ * Format: int64
5437
+ * @description Base price in smallest settlement currency units.
5438
+ */
5439
+ price: number;
5440
+ product: components["schemas"]["SubscriptionChangeLineProductDto"];
5441
+ amount: components["schemas"]["SubscriptionChangeLineAmountDto"];
5442
+ presentment_amount: components["schemas"]["SubscriptionChangeLineAmountDto"];
5443
+ /**
5444
+ * Format: int64
5445
+ * @description Prorated charge for this line in smallest settlement currency units.
5446
+ */
5447
+ prorated_amount: number;
5448
+ /**
5449
+ * Format: int64
5450
+ * @description Prorated charge for this line in smallest presentment currency units.
5451
+ */
5452
+ prorated_presentment_amount: number;
5453
+ /**
5454
+ * Format: int64
5455
+ * @description Minutes remaining in the billing period at the time of change - used to calculate proration.
5456
+ */
5457
+ remaining_minutes: number;
5458
+ /**
5459
+ * Format: int64
5460
+ * @description Total minutes in the billing period - used to calculate proration.
5461
+ */
5462
+ total_minutes: number;
5463
+ };
5464
+ /** @description The product associated with a subscription change line. */
5465
+ SubscriptionChangeLineProductDto: {
5466
+ id: components["schemas"]["FlakeId"];
5467
+ version_id: components["schemas"]["FlakeId"];
5468
+ /** @description Display name of the product. */
5469
+ name: string;
5470
+ /** @description URL of the product image, if set. */
5471
+ image_url?: null | string;
5472
+ selected_gameserver_id?: components["schemas"]["FlakeId"];
5473
+ /** @description The pricing region used to determine the price, if applicable. */
5474
+ pricing_region_id?: null | string;
5475
+ /** @description Custom variables set on this line item, keyed by variable identifier. */
5476
+ custom_variables: {
5477
+ [key: string]: components["schemas"]["CustomVariableLineItemDto"];
5478
+ };
5479
+ };
5480
+ /** @description The total prorated charge for a subscription change, expressed in both settlement and presentment currencies. */
5481
+ SubscriptionChangeProratedAmountDto: {
5482
+ /** @description ISO 4217 settlement currency code, in lowercase. */
5483
+ currency: string;
5484
+ /**
5485
+ * Format: int64
5486
+ * @description Total prorated charge in smallest settlement currency units, including tax.
5487
+ */
5488
+ prorated_amount: number;
5489
+ /** @description ISO 4217 presentment currency code, in lowercase. */
5490
+ presentment_currency: string;
5491
+ /**
5492
+ * Format: int64
5493
+ * @description Total prorated charge in smallest presentment currency units, including tax.
5494
+ */
5495
+ presentment_prorated_amount: number;
5496
+ };
5497
+ /**
5498
+ * @description Represents the status of a subscription change.
5499
+ * @enum {string}
5500
+ */
5501
+ SubscriptionChangeStatusDto: "invalid" | "pending_payment" | "pending_renewal" | "applied" | "canceled";
5114
5502
  /** @description Data transfer object representing a store subscription. */
5115
- StoreSubscriptionDto: {
5503
+ SubscriptionDto: {
5116
5504
  id: components["schemas"]["FlakeId"];
5117
5505
  /** @description Human-readable identifier for the subscription. */
5118
5506
  pretty_id: string;
5119
5507
  store_id: components["schemas"]["FlakeId"];
5508
+ store?: components["schemas"]["StorefrontStoreDto"];
5120
5509
  customer: components["schemas"]["CustomerDto"];
5121
5510
  payment_method_id?: components["schemas"]["FlakeId"];
5122
5511
  payment_method?: components["schemas"]["PaymentMethodDto"];
5512
+ pending_change?: components["schemas"]["SubscriptionChangeDto"];
5513
+ next_billing_amount: components["schemas"]["SubscriptionBillingAmountDto"];
5514
+ next_billing_presentment_amount: components["schemas"]["SubscriptionBillingAmountDto"];
5123
5515
  status: components["schemas"]["SubscriptionStatus"];
5124
5516
  coupon_id?: components["schemas"]["FlakeId"];
5125
5517
  /**
@@ -5144,20 +5536,21 @@ export interface components {
5144
5536
  * @deprecated
5145
5537
  * @description Indicates whether this subscription is a gift.
5146
5538
  */
5147
- gift: boolean;
5539
+ readonly gift: boolean;
5540
+ gift_to_customer_id?: components["schemas"]["FlakeId"];
5148
5541
  gift_to_customer?: components["schemas"]["CustomerDto"];
5149
- product_id: components["schemas"]["FlakeId"];
5150
- product_version_id: components["schemas"]["FlakeId"];
5542
+ product_id?: components["schemas"]["FlakeId"];
5543
+ product_version_id?: components["schemas"]["FlakeId"];
5151
5544
  /**
5152
5545
  * @deprecated
5153
5546
  * @description Name of the product associated with this subscription.
5154
5547
  */
5155
- product_name: string;
5548
+ readonly product_name?: null | string;
5156
5549
  /**
5157
5550
  * @deprecated
5158
5551
  * @description URL for the product image.
5159
5552
  */
5160
- product_image_url?: null | string;
5553
+ readonly product_image_url?: null | string;
5161
5554
  /**
5162
5555
  * Format: int32
5163
5556
  * @description Numeric value of the billing interval.
@@ -5170,81 +5563,81 @@ export interface components {
5170
5563
  * @deprecated
5171
5564
  * @description Indicates whether tax is included in the base price itself.
5172
5565
  */
5173
- tax_inclusive: boolean;
5566
+ readonly tax_inclusive: boolean;
5174
5567
  /**
5175
5568
  * Format: int64
5176
5569
  * @deprecated
5177
5570
  * @description Base price of the subscription in smallest currency units (e.g., cents).
5178
5571
  */
5179
- price: number;
5572
+ readonly price: number;
5180
5573
  /**
5181
5574
  * @deprecated
5182
5575
  * @description Formatted string representation of the price.
5183
5576
  */
5184
- price_str: string;
5577
+ readonly price_str?: null | string;
5185
5578
  /**
5186
5579
  * Format: int64
5187
5580
  * @description Amount of discount applied in smallest currency units.
5188
5581
  */
5189
5582
  discount_amount: number;
5190
5583
  /** @description Formatted string representation of the discount amount. */
5191
- discount_amount_str: string;
5584
+ readonly discount_amount_str: string;
5192
5585
  /**
5193
5586
  * Format: int64
5194
5587
  * @description Subtotal amount in smallest currency units.
5195
5588
  */
5196
5589
  subtotal_amount: number;
5197
5590
  /** @description Formatted string representation of the subtotal amount. */
5198
- subtotal_amount_str: string;
5591
+ readonly subtotal_amount_str: string;
5199
5592
  /**
5200
5593
  * Format: int64
5201
5594
  * @description Tax amount in smallest currency units.
5202
5595
  */
5203
5596
  tax_amount: number;
5204
5597
  /** @description Formatted string representation of the tax amount. */
5205
- tax_amount_str: string;
5598
+ readonly tax_amount_str: string;
5206
5599
  /**
5207
5600
  * Format: int64
5208
5601
  * @description Total amount in smallest currency units.
5209
5602
  */
5210
5603
  total_amount: number;
5211
5604
  /** @description Formatted string representation of the total amount. */
5212
- total_amount_str: string;
5605
+ readonly total_amount_str: string;
5213
5606
  /**
5214
5607
  * Format: int64
5215
5608
  * @description Initial discount amount in smallest currency units for the first billing cycle.
5216
5609
  */
5217
5610
  initial_discount_amount: number;
5218
5611
  /** @description Formatted string representation of the initial discount amount. */
5219
- initial_discount_amount_str: string;
5612
+ readonly initial_discount_amount_str: string;
5220
5613
  /**
5221
5614
  * Format: int64
5222
5615
  * @description Initial subtotal amount in smallest currency units for the first billing cycle.
5223
5616
  */
5224
5617
  initial_subtotal_amount: number;
5225
5618
  /** @description Formatted string representation of the initial subtotal amount. */
5226
- initial_subtotal_amount_str: string;
5619
+ readonly initial_subtotal_amount_str: string;
5227
5620
  /**
5228
5621
  * Format: int64
5229
5622
  * @description Initial gift card usage amount in smallest currency units.
5230
5623
  */
5231
5624
  initial_giftcard_usage_amount: number;
5232
5625
  /** @description Formatted string representation of the initial gift card usage amount. */
5233
- initial_giftcard_usage_amount_str: string;
5626
+ readonly initial_giftcard_usage_amount_str: string;
5234
5627
  /**
5235
5628
  * Format: int64
5236
5629
  * @description Initial tax amount in smallest currency units for the first billing cycle.
5237
5630
  */
5238
5631
  initial_tax_amount: number;
5239
5632
  /** @description Formatted string representation of the initial tax amount. */
5240
- initial_tax_amount_str: string;
5633
+ readonly initial_tax_amount_str: string;
5241
5634
  /**
5242
5635
  * Format: int64
5243
5636
  * @description Initial total amount in smallest currency units for the first billing cycle.
5244
5637
  */
5245
5638
  initial_total_amount: number;
5246
5639
  /** @description Formatted string representation of the initial total amount. */
5247
- initial_total_amount_str: string;
5640
+ readonly initial_total_amount_str: string;
5248
5641
  /** @description Presentment currency code (currency shown to customer). */
5249
5642
  presentment_currency?: null | string;
5250
5643
  /**
@@ -5316,7 +5709,7 @@ export interface components {
5316
5709
  * @deprecated
5317
5710
  * @description Identifier for the pricing region associated with this subscription.
5318
5711
  */
5319
- pricing_region_id?: null | string;
5712
+ readonly pricing_region_id?: null | string;
5320
5713
  /**
5321
5714
  * Format: date-time
5322
5715
  * @description Start date of the current billing period.
@@ -5364,73 +5757,8 @@ export interface components {
5364
5757
  canceled_at?: null | string;
5365
5758
  /** @description Reason provided for cancellation. */
5366
5759
  cancel_reason?: null | string;
5367
- /** @description Associated subscription lines. */
5368
- readonly lines: components["schemas"]["SubscriptionLineDto"][];
5369
- };
5370
- StoreTrustDto: {
5371
- store_id: components["schemas"]["FlakeId"];
5372
- status: components["schemas"]["StoreTrustStatusDto"];
5373
- status_reason?: null | string;
5374
- restrictions: components["schemas"]["StoreRestrictionFlagDto"];
5375
- /** Format: date-time */
5376
- created_at: string;
5377
- /** Format: date-time */
5378
- updated_at?: null | string;
5379
- onboarding_steps?: components["schemas"]["StoreTrustOnboardingStepsDto"];
5380
- events: components["schemas"]["StoreTrustEventDto"][];
5381
- pending_requirements: components["schemas"]["TrustStoreRequirementDto"][];
5382
- };
5383
- StoreTrustEventDto: {
5384
- id: components["schemas"]["FlakeId"];
5385
- store_id: components["schemas"]["FlakeId"];
5386
- type: components["schemas"]["StoreTrustEventTypeDto"];
5387
- description?: null | string;
5388
- store_requirement_id?: components["schemas"]["FlakeId"];
5389
- store_review_id?: components["schemas"]["FlakeId"];
5390
- actor: components["schemas"]["ActorDto"];
5391
- /** Format: date-time */
5392
- created_at: string;
5393
- };
5394
- /** @enum {string} */
5395
- 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";
5396
- StoreTrustOnboardingStepsDto: {
5397
- store_id: components["schemas"]["FlakeId"];
5398
- store_owner_id: components["schemas"]["FlakeId"];
5399
- payout_onboarding_completed: boolean;
5400
- kyc_completed: boolean;
5401
- products_created: boolean;
5402
- gameserver_linked: boolean;
5403
- webhooks_active: boolean;
5404
- downloadable_files_added: boolean;
5405
- };
5406
- /** @enum {string} */
5407
- StoreTrustStatusDto: "invalid" | "pending_review" | "requires_action" | "under_review" | "active" | "restricted" | "offboarded";
5408
- /** @enum {string} */
5409
- StoreUpsellCheckoutStyleDto: "unknown" | "inline" | "inline_and_prepayment_dialog" | "dedicated_step";
5410
- StoreUpsellRecommendationDto: {
5411
- recommended_product_id: components["schemas"]["FlakeId"];
5412
- type: components["schemas"]["UpsellTypeDto"];
5413
- discount_type: components["schemas"]["UpsellDiscountTypeDto"];
5414
- /** Format: int64 */
5415
- discount_amount: number;
5416
- /** Format: int32 */
5417
- minimum_base_product_quantity?: null | number;
5418
- /** Format: int32 */
5419
- quantity_to_add?: null | number;
5420
- prefer_as_subscription: boolean;
5421
- };
5422
- StoreUpsellSettingsDto: {
5423
- enabled: boolean;
5424
- automatic_recommendations_enabled: boolean;
5425
- automatic_recommendations_discount_type: components["schemas"]["UpsellDiscountType"];
5426
- /** Format: int64 */
5427
- automatic_recommendations_discount_amount: number;
5428
- recommendation_overrides_enabled: boolean;
5429
- recommendation_overrides: components["schemas"]["StoreUpsellRecommendationDto"][];
5430
- checkout_style: components["schemas"]["StoreUpsellCheckoutStyleDto"];
5431
- /** Format: date-time */
5432
- updated_at: string;
5433
- updated_by: components["schemas"]["ActorDto"];
5760
+ /** @description Line items associated with this subscription. */
5761
+ lines: components["schemas"]["SubscriptionLineDto"][];
5434
5762
  };
5435
5763
  /** @description Represents a line item within a subscription. */
5436
5764
  SubscriptionLineDto: {
@@ -5441,6 +5769,7 @@ export interface components {
5441
5769
  /** @description Identifier for the pricing region associated with this subscription line. */
5442
5770
  pricing_region_id?: null | string;
5443
5771
  gift_to_customer_id?: components["schemas"]["FlakeId"];
5772
+ gift_to_customer?: components["schemas"]["CustomerDto"];
5444
5773
  selected_gameserver_id?: components["schemas"]["FlakeId"];
5445
5774
  sale_id?: components["schemas"]["FlakeId"];
5446
5775
  trial_id?: components["schemas"]["FlakeId"];
@@ -5592,7 +5921,7 @@ export interface components {
5592
5921
  * @description Represents the current state of a subscription.
5593
5922
  * @enum {string}
5594
5923
  */
5595
- SubscriptionStatus: "created" | "active" | "canceled";
5924
+ SubscriptionStatus: "invalid" | "created" | "active" | "canceled";
5596
5925
  TagDto: {
5597
5926
  id: components["schemas"]["FlakeId"];
5598
5927
  store_id: components["schemas"]["FlakeId"];
@@ -5933,6 +6262,25 @@ export interface components {
5933
6262
  recommendation_overrides?: components["schemas"]["StoreUpsellRecommendationDto"][];
5934
6263
  checkout_style?: components["schemas"]["StoreUpsellCheckoutStyleDto"];
5935
6264
  };
6265
+ UpdateSubscriptionLineRequestDto: {
6266
+ product_id?: components["schemas"]["FlakeId"];
6267
+ product_version_id?: components["schemas"]["FlakeId"];
6268
+ /** @description Custom variable values keyed by variable name. */
6269
+ custom_variables: {
6270
+ [key: string]: string;
6271
+ };
6272
+ selected_gameserver_id?: components["schemas"]["FlakeId"];
6273
+ };
6274
+ UpdateSubscriptionRequestDto: {
6275
+ /** @description The line items describing the desired state of the subscription after the change. */
6276
+ lines: components["schemas"]["UpdateSubscriptionLineRequestDto"][];
6277
+ proration_behavior: components["schemas"]["ProrationBehaviorDto"];
6278
+ };
6279
+ /** @description Response returned after a subscription change is initiated. */
6280
+ UpdateSubscriptionResponseDto: {
6281
+ subscription_change: components["schemas"]["SubscriptionChangeDto"];
6282
+ pending_payment?: components["schemas"]["CheckoutPaymentInfoDto"];
6283
+ };
5936
6284
  UpdateTrialEligibilityOverrideDto: {
5937
6285
  product_id?: components["schemas"]["FlakeId"];
5938
6286
  /** Format: date-time */
@@ -10618,7 +10966,7 @@ export interface operations {
10618
10966
  [name: string]: unknown;
10619
10967
  };
10620
10968
  content: {
10621
- "application/json": components["schemas"]["StoreSubscriptionDto"][];
10969
+ "application/json": components["schemas"]["SubscriptionDto"][];
10622
10970
  };
10623
10971
  };
10624
10972
  /** @description Error response */
@@ -10650,7 +10998,7 @@ export interface operations {
10650
10998
  [name: string]: unknown;
10651
10999
  };
10652
11000
  content: {
10653
- "application/json": components["schemas"]["StoreSubscriptionDto"];
11001
+ "application/json": components["schemas"]["SubscriptionDto"];
10654
11002
  };
10655
11003
  };
10656
11004
  /** @description Error response */
@@ -10694,6 +11042,80 @@ export interface operations {
10694
11042
  };
10695
11043
  };
10696
11044
  };
11045
+ Subscriptions_UpdateSubscription: {
11046
+ parameters: {
11047
+ query?: never;
11048
+ header?: never;
11049
+ path: {
11050
+ subscriptionId: components["schemas"]["FlakeId"];
11051
+ };
11052
+ cookie?: never;
11053
+ };
11054
+ requestBody?: {
11055
+ content: {
11056
+ "application/json": components["schemas"]["UpdateSubscriptionRequestDto"];
11057
+ "text/json": components["schemas"]["UpdateSubscriptionRequestDto"];
11058
+ "application/*+json": components["schemas"]["UpdateSubscriptionRequestDto"];
11059
+ };
11060
+ };
11061
+ responses: {
11062
+ /** @description OK */
11063
+ 200: {
11064
+ headers: {
11065
+ [name: string]: unknown;
11066
+ };
11067
+ content: {
11068
+ "application/json": components["schemas"]["UpdateSubscriptionResponseDto"];
11069
+ };
11070
+ };
11071
+ /** @description Error response */
11072
+ default: {
11073
+ headers: {
11074
+ [name: string]: unknown;
11075
+ };
11076
+ content: {
11077
+ "application/json": components["schemas"]["PayNowError"];
11078
+ };
11079
+ };
11080
+ };
11081
+ };
11082
+ Subscriptions_PreviewSubscriptionChange: {
11083
+ parameters: {
11084
+ query?: never;
11085
+ header?: never;
11086
+ path: {
11087
+ subscriptionId: components["schemas"]["FlakeId"];
11088
+ };
11089
+ cookie?: never;
11090
+ };
11091
+ requestBody?: {
11092
+ content: {
11093
+ "application/json": components["schemas"]["UpdateSubscriptionRequestDto"];
11094
+ "text/json": components["schemas"]["UpdateSubscriptionRequestDto"];
11095
+ "application/*+json": components["schemas"]["UpdateSubscriptionRequestDto"];
11096
+ };
11097
+ };
11098
+ responses: {
11099
+ /** @description OK */
11100
+ 200: {
11101
+ headers: {
11102
+ [name: string]: unknown;
11103
+ };
11104
+ content: {
11105
+ "application/json": components["schemas"]["UpdateSubscriptionResponseDto"];
11106
+ };
11107
+ };
11108
+ /** @description Error response */
11109
+ default: {
11110
+ headers: {
11111
+ [name: string]: unknown;
11112
+ };
11113
+ content: {
11114
+ "application/json": components["schemas"]["PayNowError"];
11115
+ };
11116
+ };
11117
+ };
11118
+ };
10697
11119
  Tags_GetTags: {
10698
11120
  parameters: {
10699
11121
  query?: never;
@@ -11966,6 +12388,14 @@ export declare const operationMappings: {
11966
12388
  readonly method: "POST";
11967
12389
  readonly path: "/v1/stores/{storeId}/subscriptions/{subscriptionId}/cancel";
11968
12390
  };
12391
+ readonly Subscriptions_UpdateSubscription: {
12392
+ readonly method: "POST";
12393
+ readonly path: "/v1/stores/{storeId}/subscriptions/{subscriptionId}/change";
12394
+ };
12395
+ readonly Subscriptions_PreviewSubscriptionChange: {
12396
+ readonly method: "POST";
12397
+ readonly path: "/v1/stores/{storeId}/subscriptions/{subscriptionId}/change/preview";
12398
+ };
11969
12399
  readonly Tags_GetTags: {
11970
12400
  readonly method: "GET";
11971
12401
  readonly path: "/v1/stores/{storeId}/tags";