@paynow-gg/typescript-sdk 2.1.2 → 2.1.3

package/dist/esm/generated/management/types.d.ts

@@ -363,7 +363,7 @@ export type BanType = "unknown" | "steam" | "ip" | "customer" | "customer_name"
 /**
  * Query parameters
  */
-export type BillingGetStoreInvoicesQuery = {
+export type BillingGetStoreBillingOrdersQuery = {
     /**
      * The maximum number of items to return in a single request.
      * @format int32
@@ -2971,15 +2971,6 @@ export type InvoicesListInvoicesQuery = {
 };
 export type InvoiceStatusDto = "invalid" | "pending" | "generated" | "failed";
 export type InvoiceTypeDto = "invalid" | "invoice" | "credit_note";
-/**
- * Represents a freshly issued link to a hosted invoice.
- */
-export interface InvoiceUrlDto {
-    /**
-     * The hosted invoice URL.
-     */
-    url: string;
-}
 /**
  * Klarna payment method details
  */
@@ -4168,6 +4159,16 @@ export interface PaymentMethodTypeFeeOverrideDto {
      */
     ends_at?: string | null;
 }
+/**
+ * A customer portal session scoped to updating the payment method of the store's
+ * active subscription.
+ */
+export interface PaymentMethodUpdateSessionDto {
+    /**
+     * The URL the store owner has to visit to update the subscription's payment method.
+     */
+    session_url: string;
+}
 /**
  * Represents payout split results for multi-party payments
  */
@@ -4424,6 +4425,7 @@ export interface PlanDto {
     name: string;
     description?: string | null;
     is_custom: boolean;
+    inherits_from_plan_id?: string | null;
 }
 /**
  * Represents a publicly listed plan a store can subscribe to.
@@ -4488,6 +4490,7 @@ export interface PlanPricingDto {
      * @format date-time
      */
     ends_at?: string | null;
+    revenue_limit_exceeded?: boolean | null;
 }
 export type PlatformCapability = "invalid" | "connected_users";
 export interface PlatformStoreTypeAssociationDetailsDto {
@@ -5828,11 +5831,11 @@ export interface StoreBillingStatusDto {
     revenue_usage: number;
     plan_limits: Record<string, number>;
     feature_flags: Array<string>;
+    alerts: Array<StoreAlertDto>;
     plan: PlanDto;
     plan_pricing: PlanPricingDto;
     subscription?: StoreSubscriptionDto;
-    alerts: Array<StoreAlertDto>;
-    payment_method?: SubscriptionPaymentMethodDto;
+    payment_method?: PaymentMethodDto;
 }
 /**
  * Query parameters
@@ -5927,6 +5930,420 @@ export interface StoreDto {
     onboarding_completed_at?: string | null;
     platform_store_type_association?: PlatformStoreTypeAssociationDetailsDto;
 }
+/**
+ * A storefront representation of a customer in the PayNow system with their associated profiles and metadata.
+ */
+export interface StorefrontCustomerDto {
+    id: FlakeId;
+    store_id: FlakeId;
+    profile?: CustomerGenericProfileDto;
+    steam_id?: SteamId;
+    steam?: StorefrontCustomerSteamProfileDto;
+    /**
+     * The customer's Minecraft UUID, if they have linked their Minecraft account.
+     * Not set for offline Minecraft stores. If the platform type is Minecraft - Geyser,
+     * and the profile is a bedrock account, this will be a UUID generated from the Xbox XUID.
+     * @example "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2"
+     */
+    minecraft_uuid?: string | null;
+    minecraft?: StorefrontCustomerMinecraftProfileDto;
+    minecraft_platform?: CustomerMinecraftPlatform;
+    /**
+     * The customer's Xbox XUID, if available.
+     */
+    xbox_xuid?: string | null;
+    /**
+     * The display name for the customer.
+     * @example "m0uka"
+     */
+    name?: string | null;
+}
+/**
+ * A storefront representation of a customers Minecraft profile.
+ */
+export interface StorefrontCustomerMinecraftProfileDto {
+    /**
+     * The UUID of the Minecraft player.
+     * If the platform is Minecraft Offline, this will be the name itself.
+     * If the platform is Minecraft Geyser, and this is a Bedrock account, this ID will be an Xbox XUID.
+     * @example "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2"
+     */
+    id: string;
+    /**
+     * The username of the Minecraft player.
+     * @example "notch"
+     */
+    name: string;
+    /**
+     * The URL to the player's Minecraft skin rendered as an avatar.
+     */
+    avatar_url: string;
+}
+/**
+ * A storefront representation of a customers Steam profile.
+ */
+export interface StorefrontCustomerSteamProfileDto {
+    id: SteamId;
+    /**
+     * The display name of the user on Steam.
+     */
+    name: string;
+    /**
+     * The URL to the user's Steam avatar image.
+     */
+    avatar_url: string;
+}
+/**
+ * Data transfer object representing a store order.
+ */
+export interface StorefrontOrderDto {
+    id: FlakeId;
+    /**
+     * Human-readable identifier for the order.
+     * @readonly Set by the API; ignored on write.
+     */
+    pretty_id: string;
+    store_id: FlakeId;
+    customer_id: FlakeId;
+    customer: StorefrontCustomerDto;
+    status: OrderStatus;
+    type: OrderType;
+    checkout_id?: FlakeId;
+    subscription_id?: FlakeId;
+    /**
+     * Indicates whether this order is a subscription order.
+     */
+    is_subscription: boolean;
+    /**
+     * Currency code used for this order.
+     */
+    currency: string;
+    /**
+     * The total discount amount applied to this order in smallest currency unit
+     * @format int32
+     * @example 500
+     */
+    discount_amount: number;
+    /**
+     * The discount amount formatted as a string
+     * @example "$5.00"
+     */
+    discount_amount_str: string;
+    /**
+     * The subtotal amount for this order in smallest currency unit
+     * @format int32
+     * @example 9995
+     */
+    subtotal_amount: number;
+    /**
+     * The subtotal amount formatted as a string
+     * @example "$99.95"
+     */
+    subtotal_amount_str: string;
+    /**
+     * The tax amount for this order in smallest currency unit
+     * @format int32
+     * @example 999
+     */
+    tax_amount: number;
+    /**
+     * The tax amount formatted as a string
+     * @example "$9.99"
+     */
+    tax_amount_str: string;
+    /**
+     * The total amount for this order in smallest currency unit
+     * @format int32
+     * @example 10494
+     */
+    total_amount: number;
+    /**
+     * The total amount formatted as a string
+     * @example "$104.94"
+     */
+    total_amount_str: string;
+    /**
+     * The amount of gift card value used for this order in smallest currency unit
+     * @format int32
+     * @example 0
+     */
+    giftcard_usage_amount: number;
+    /**
+     * The gift card usage amount formatted as a string
+     * @example "$0.00"
+     */
+    giftcard_usage_amount_str: string;
+    /**
+     * The presentment currency code used for this order (currency shown to customer)
+     * @example "eur"
+     */
+    presentment_currency: string;
+    /**
+     * The presentment subtotal amount in smallest currency unit
+     * @format int32
+     * @example 9995
+     */
+    presentment_subtotal_amount: number;
+    /**
+     * The presentment subtotal amount formatted as a string
+     * @example "€99.95"
+     * @readonly Set by the API; ignored on write.
+     */
+    presentment_subtotal_amount_str: string;
+    /**
+     * The presentment discount amount in smallest currency unit
+     * @format int32
+     * @example 500
+     */
+    presentment_discount_amount: number;
+    /**
+     * The presentment discount amount formatted as a string
+     * @example "€5.00"
+     * @readonly Set by the API; ignored on write.
+     */
+    presentment_discount_amount_str: string;
+    /**
+     * The presentment gift card usage amount in the smallest currency unit
+     * @format int32
+     * @example 0
+     */
+    presentment_giftcard_usage_amount: number;
+    /**
+     * The presentment gift card usage amount formatted as a string
+     * @example "€0.00"
+     * @readonly Set by the API; ignored on write.
+     */
+    presentment_giftcard_usage_amount_str: string;
+    /**
+     * The presentment tax amount in smallest currency unit
+     * @format int32
+     * @example 999
+     */
+    presentment_tax_amount: number;
+    /**
+     * The presentment tax amount formatted as a string
+     * @example "€9.99"
+     * @readonly Set by the API; ignored on write.
+     */
+    presentment_tax_amount_str: string;
+    /**
+     * The presentment total amount in the smallest currency unit
+     * @format int32
+     * @example 10494
+     */
+    presentment_total_amount: number;
+    /**
+     * The presentment total amount formatted as a string
+     * @example "€104.94"
+     * @readonly Set by the API; ignored on write.
+     */
+    presentment_total_amount_str: string;
+    /**
+     * Sequence number of the billing cycle, if this order is associated with a subscription.
+     * @format int32
+     */
+    billing_cycle_sequence?: number | null;
+    /**
+     * Line items associated with this order.
+     */
+    lines: Array<StorefrontOrderLineDto>;
+    /**
+     * Date and time when the order was created.
+     * @format date-time
+     */
+    created_at?: string | null;
+    /**
+     * Date and time when the order was completed.
+     * @format date-time
+     */
+    completed_at?: string | null;
+    /**
+     * Date and time when the order was canceled.
+     * @format date-time
+     */
+    canceled_at?: string | null;
+}
+/**
+ * Represents a line item within an order.
+ */
+export interface StorefrontOrderLineDto {
+    id: FlakeId;
+    checkout_line_id: FlakeId;
+    subscription_line_id?: FlakeId;
+    trial_id?: FlakeId;
+    product_id: FlakeId;
+    product_version_id: FlakeId;
+    /**
+     * Name of the product associated with this order line.
+     */
+    product_name: string;
+    /**
+     * URL for the product image.
+     */
+    product_image_url: string;
+    /**
+     * Numeric value of the subscription billing interval, if this line is a subscription.
+     * @format int32
+     */
+    subscription_interval_value?: number | null;
+    /**
+     * Scale of the subscription billing interval (e.g., "day", "month", "year"), if applicable.
+     */
+    subscription_interval_scale?: string | null;
+    /**
+     * Indicates whether this order line is a gift to another customer.
+     */
+    gift: boolean;
+    gift_to_customer_id?: FlakeId;
+    gift_to_customer?: StorefrontCustomerDto;
+    /**
+     * The unit price of the product in the smallest currency unit (e.g., cents)
+     * @format int32
+     * @example 1999
+     */
+    price: number;
+    /**
+     * The unit price of the product formatted as a string
+     * @example "$19.99"
+     */
+    price_str: string;
+    /**
+     * The quantity of the product in this order line
+     * @format int32
+     * @example 1
+     */
+    quantity: number;
+    /**
+     * The discount amount (from sales, coupons, and affiliate links) applied to this order line
+     * @format int32
+     * @example 0
+     */
+    discount_amount: number;
+    /**
+     * The discount amount formatted as a string
+     * @example "$0.00"
+     */
+    discount_amount_str: string;
+    /**
+     * The amount of gift card used for this order line
+     * @format int32
+     * @example 0
+     */
+    giftcard_usage_amount: number;
+    /**
+     * The gift card usage amount formatted as a string
+     * @example "$0.00"
+     */
+    giftcard_usage_amount_str: string;
+    /**
+     * The subtotal amount for this order line
+     * @format int32
+     * @example 1999
+     */
+    subtotal_amount: number;
+    /**
+     * The subtotal amount formatted as a string
+     * @example "$19.99"
+     */
+    subtotal_amount_str: string;
+    /**
+     * The tax amount for this order line
+     * @format int32
+     * @example 200
+     */
+    tax_amount: number;
+    /**
+     * The tax amount formatted as a string
+     * @example "$2.00"
+     */
+    tax_amount_str: string;
+    /**
+     * The total amount for this order line
+     * @format int32
+     * @example 2199
+     */
+    total_amount: number;
+    /**
+     * The total amount formatted as a string
+     * @example "$21.99"
+     */
+    total_amount_str: string;
+    /**
+     * The presentment subtotal amount for this order line
+     * @format int32
+     * @example 1999
+     */
+    presentment_subtotal_amount: number;
+    /**
+     * The presentment subtotal amount formatted as a string
+     * @example "€19.99"
+     * @readonly Set by the API; ignored on write.
+     */
+    presentment_subtotal_amount_str: string;
+    /**
+     * The presentment discount amount for this order line
+     * @format int32
+     * @example 0
+     */
+    presentment_discount_amount: number;
+    /**
+     * The presentment discount amount formatted as a string
+     * @example "€0.00"
+     * @readonly Set by the API; ignored on write.
+     */
+    presentment_discount_amount_str: string;
+    /**
+     * The presentment tax amount for this order line
+     * @format int32
+     * @example 200
+     */
+    presentment_tax_amount: number;
+    /**
+     * The presentment tax amount formatted as a string
+     * @example "€2.00"
+     * @readonly Set by the API; ignored on write.
+     */
+    presentment_tax_amount_str: string;
+    /**
+     * The presentment gift card usage amount for this order line
+     * @format int32
+     * @example 0
+     */
+    presentment_giftcard_usage_amount: number;
+    /**
+     * The presentment gift card usage amount formatted as a string
+     * @example "€0.00"
+     * @readonly Set by the API; ignored on write.
+     */
+    presentment_giftcard_usage_amount_str: string;
+    /**
+     * The presentment total amount for this order line
+     * @format int32
+     * @example 2199
+     */
+    presentment_total_amount: number;
+    /**
+     * The presentment total amount formatted as a string
+     * @example "€21.99"
+     * @readonly Set by the API; ignored on write.
+     */
+    presentment_total_amount_str: string;
+    selected_gameserver_id?: FlakeId;
+    /**
+     * Indicates whether tax is included in the base price, or added on top
+     * @example false
+     */
+    tax_inclusive: boolean;
+    /**
+     * The regional pricing region ID for this order line, null if no regional pricing set
+     * @example "eu"
+     */
+    pricing_region_id?: string | null;
+    /**
+     * Key-value pair of selected custom variables for this order.
+     */
+    custom_variables?: Record<string, CustomVariableLineItemDto> | null;
+}
 /**
  * Represents a store entity within the storefront system.
  */
@@ -6008,54 +6425,6 @@ export interface StorefrontStoreDto {
      */
     updated_at?: string | null;
 }
-/**
- * Represents an invoice raised against a store's own subscription.
- */
-export interface StoreInvoiceDto {
-    id: FlakeId;
-    subscription_id: FlakeId;
-    plan_pricing_id: FlakeId;
-    /**
-     * The payment gateway that issued the invoice.
-     */
-    gateway: string;
-    /**
-     * The identifier of the invoice within the payment gateway.
-     */
-    gateway_invoice_id: string;
-    /**
-     * The hosted invoice URL recorded when the invoice was raised. May expire; request
-     * 'invoices/{invoice_id}/url' for a freshly issued link.
-     */
-    invoice_url: string;
-    /**
-     * The description of what was billed.
-     */
-    description: string;
-    /**
-     * The currency the invoice was issued in.
-     */
-    currency: string;
-    /**
-     * The invoiced total, in the smallest currency unit.
-     * @format int64
-     */
-    total: number;
-    /**
-     * Whether the invoice has been paid.
-     */
-    is_paid: boolean;
-    /**
-     * When the invoice was raised.
-     * @format date-time
-     */
-    created_at: string;
-    /**
-     * When the invoice was last updated.
-     * @format date-time
-     */
-    updated_at?: string | null;
-}
 /**
  * Represents a member of a PayNow store.
  */
@@ -6210,6 +6579,7 @@ export interface StoreResult {
 export interface StoreSubscriptionDto {
     id: FlakeId;
     store_id: FlakeId;
+    user_id: FlakeId;
     plan_id: string;
     gateway: string;
     gateway_subscription_id: string;
@@ -6217,6 +6587,7 @@ export interface StoreSubscriptionDto {
     gateway_payment_method_id: string;
     currency: string;
     status: StoreSubscriptionStatus;
+    renewal_period: StoreSubscriptionRenewalPeriod;
     downgrade_period_end_plan_id?: string | null;
     cancel_at_period_end: boolean;
     /**
@@ -6238,12 +6609,13 @@ export interface StoreSubscriptionDto {
     /**
      * @format date-time
      */
-    current_period_start: string;
+    current_period_start?: string | null;
     /**
      * @format date-time
      */
-    current_period_end: string;
+    current_period_end?: string | null;
 }
+export type StoreSubscriptionRenewalPeriod = "monthly" | "annually";
 export type StoreSubscriptionStatus = "incomplete" | "trialing" | "active" | "requires_action" | "canceled";
 export interface StoreTrustDto {
     store_id: FlakeId;
@@ -7135,37 +7507,6 @@ export interface SubscriptionLineDto {
      */
     initial_presentment_total_amount_str?: string | null;
 }
-/**
- * Represents the payment method a store's subscription is billed to.
- */
-export interface SubscriptionPaymentMethodDto {
-    /**
-     * The identifier of the payment method within the payment gateway.
-     */
-    id: string;
-    /**
-     * The kind of payment method, such as a card.
-     */
-    type: string;
-    /**
-     * The card network, when the payment method is a card.
-     */
-    card_brand?: string | null;
-    /**
-     * The month the card expires, when the payment method is a card.
-     * @format int64
-     */
-    card_exp_month?: number | null;
-    /**
-     * The year the card expires, when the payment method is a card.
-     * @format int64
-     */
-    card_exp_year?: number | null;
-    /**
-     * The last four digits of the card, when the payment method is a card.
-     */
-    card_last4?: string | null;
-}
 /**
  * Portal flow for updating the payment method of a specific subscription
  */