@paynow-gg/typescript-sdk 1.0.61 → 2.0.2

package/dist/cjs/generated/storefront/types.d.ts

@@ -0,0 +1,3076 @@
+export interface ActorDto {
+    type: PayNowActorType;
+    id?: FlakeId;
+}
+export interface AuthenticateStorefrontCustomerRequestDto {
+    platform: CustomerProfilePlatform;
+    /**
+     * The account ID on the platform
+     * @example "76561198152492642"
+     */
+    id: string;
+}
+export interface AuthenticateStorefrontCustomerResponseDto {
+    /**
+     * The token for the Customer
+     */
+    customer_token: string;
+}
+/**
+ * Request headers
+ */
+export type CartAddLineHeaders = {
+    /**
+     * The IP address (IPv4 or IPv6) of the customer. Required if the request is not being made from the customer's browser.
+     * @format ipv4
+     */
+    "x-paynow-customer-ip"?: string;
+    /**
+     * The customer's country code in ISO 3166-1 alpha-2 format. Optional, but recommended if you have this available.
+     * @pattern ^[A-Z]{2}$
+     */
+    "x-paynow-customer-countrycode"?: string;
+};
+/**
+ * Query parameters
+ */
+export type CartAddLineQuery = {
+    /**
+     * The ID of the product that should be added to the cart.
+     */
+    product_id: FlakeId;
+    /**
+     * The quantity to set or increment.
+     * @format int32
+     */
+    quantity?: number;
+    /**
+     * Set to either '1' or 'true' to store as a subscription line item.
+     */
+    subscription?: string;
+    /**
+     * Set to either '1' or 'true' to indicate if the line should be trialed.
+     */
+    trial?: string;
+    /**
+     * A game server ID, required if single_game_server_only is enabled for the product.
+     */
+    gameserver_id?: FlakeId;
+    /**
+     * Set to either '1' or 'true' to increment (add quantity instead of setting).
+     */
+    increment?: string;
+    /**
+     * Dictionary of product custom variables where each entry consists of a string key (identifier)
+     * and its corresponding selected value. Use the following URL parameter format:
+     * ?custom_variables[IDENTIFIER]=VALUE
+     */
+    custom_variables?: Record<string, string>;
+    /**
+     * The ID of the customer in which this line is a gift for.
+     */
+    gift_to_customer_id?: FlakeId;
+    /**
+     * The platform type
+     */
+    "gift_to.platform"?: CustomerProfilePlatform;
+    /**
+     * The account ID on the platform
+     * @example "76561198152492642"
+     */
+    "gift_to.id"?: string;
+};
+/**
+ * Request headers
+ */
+export type CartClearCartHeaders = {
+    /**
+     * The IP address (IPv4 or IPv6) of the customer. Required if the request is not being made from the customer's browser.
+     * @format ipv4
+     */
+    "x-paynow-customer-ip"?: string;
+    /**
+     * The customer's country code in ISO 3166-1 alpha-2 format. Optional, but recommended if you have this available.
+     * @pattern ^[A-Z]{2}$
+     */
+    "x-paynow-customer-countrycode"?: string;
+};
+/**
+ * Request headers
+ */
+export type CartCreateCartCheckoutHeaders = {
+    /**
+     * The IP address (IPv4 or IPv6) of the customer. Required if the request is not being made from the customer's browser.
+     * @format ipv4
+     */
+    "x-paynow-customer-ip"?: string;
+    /**
+     * The customer's country code in ISO 3166-1 alpha-2 format. Optional, but recommended if you have this available.
+     * @pattern ^[A-Z]{2}$
+     */
+    "x-paynow-customer-countrycode"?: string;
+};
+/**
+ * Represents a customer's shopping cart
+ */
+export interface CartDto {
+    store_id: FlakeId;
+    customer_id: FlakeId;
+    /**
+     * The line items in the cart
+     */
+    lines: Array<CartLineDto>;
+    /**
+     * The total price of all items in the cart in the smallest currency unit (e.g., cents)
+     * @format int64
+     */
+    total: number;
+    /**
+     * The currency code (e.g., usd, eur, gbp)
+     */
+    currency: string;
+}
+/**
+ * Request headers
+ */
+export type CartGetCartHeaders = {
+    /**
+     * The IP address (IPv4 or IPv6) of the customer. Required if the request is not being made from the customer's browser.
+     * @format ipv4
+     */
+    "x-paynow-customer-ip"?: string;
+    /**
+     * The customer's country code in ISO 3166-1 alpha-2 format. Optional, but recommended if you have this available.
+     * @pattern ^[A-Z]{2}$
+     */
+    "x-paynow-customer-countrycode"?: string;
+};
+/**
+ * Query parameters
+ */
+export type CartGetCartQuery = {
+    /**
+     * The ISO three-letter lowercase currency code (e.g., usd, eur, gbp) to display prices in. If not provided, the store's default currency will be used.
+     */
+    currency?: string;
+};
+export interface CartLineCustomVariableDto {
+    id: FlakeId;
+    /**
+     * The display name of the custom variable
+     */
+    name: string;
+    /**
+     * The unique identifier string for the custom variable
+     */
+    identifier: string;
+    /**
+     * The description of the custom variable
+     */
+    description: string;
+    type: CustomVariableType;
+    /**
+     * The selected value of the custom variable
+     */
+    value: string;
+    /**
+     * The collection of available options for this custom variable. Only present for dropdown type
+     */
+    options: Array<StorefrontCustomVariableOptionDto>;
+    selected_option?: StorefrontCustomVariableOptionDto;
+}
+/**
+ * Represents a line item in a cart
+ */
+export interface CartLineDto {
+    /**
+     * The unique key for this line item
+     */
+    line_key: string;
+    product_id: FlakeId;
+    /**
+     * The name of the product
+     */
+    name: string;
+    /**
+     * The slug of the product
+     */
+    slug: string;
+    /**
+     * The price of the product in the smallest currency unit (e.g., cents)
+     * @format int64
+     */
+    price: number;
+    /**
+     * The quantity of this product in the cart
+     * @format int32
+     */
+    quantity: number;
+    /**
+     * Indicates whether this line item should be a subscription
+     */
+    subscription: boolean;
+    /**
+     * Indicates whether this line will be trialied by the customer.
+     */
+    trial: boolean;
+    /**
+     * The URL to the product image
+     */
+    image_url?: string | null;
+    selected_gameserver_id?: FlakeId;
+    selected_gameserver?: StorefrontGameServerDto;
+    pricing: StorefrontProductPricingDto;
+    /**
+     * Selected custom variables for this cart line.
+     */
+    custom_variables: Array<CartLineCustomVariableDto>;
+    gift_to_customer?: StorefrontCustomerDto;
+    gift_to_customer_id?: FlakeId;
+}
+/**
+ * Request headers
+ */
+export type CheckoutCreateCheckoutSessionHeaders = {
+    /**
+     * The IP address (IPv4 or IPv6) of the customer. Required if the request is not being made from the customer's browser.
+     * @format ipv4
+     */
+    "x-paynow-customer-ip"?: string;
+    /**
+     * The customer's country code in ISO 3166-1 alpha-2 format. Optional, but recommended if you have this available.
+     * @pattern ^[A-Z]{2}$
+     */
+    "x-paynow-customer-countrycode"?: string;
+};
+/**
+ * Payment outcome information returned after a subscription change triggers an immediate charge.
+ */
+export interface CheckoutPaymentInfoDto {
+    /**
+     * Status string from the payment provider.
+     */
+    status: string;
+    /**
+     * Indicates whether the payment was declined.
+     */
+    declined: boolean;
+    /**
+     * The customer readable decline reason, if the payment was declined.
+     */
+    decline_message?: string | null;
+    /**
+     * Checkout URL to redirect to for on-session payments.
+     */
+    checkout_url?: string | null;
+}
+/**
+ * Request to create a new checkout session from a cart
+ */
+export interface CreateCartCheckoutSessionDto {
+    coupon_id?: FlakeId;
+    /**
+     * Optional array of promo codes (coupons, gift cards, affiliates) to apply.
+     * An invalid promo code will cause an error.
+     */
+    promo_codes?: Array<string> | null;
+    /**
+     * Optional affiliate code to track referrals.
+     * An invalid affiliate code will NOT cause an error.
+     */
+    affiliate_code?: string | null;
+    /**
+     * Optional URL to redirect to after successful checkout
+     */
+    return_url?: string | null;
+    /**
+     * Optional URL to redirect to if checkout is canceled
+     */
+    cancel_url?: string | null;
+    /**
+     * Whether to automatically redirect the customer (return_url must be set)
+     */
+    auto_redirect?: boolean | null;
+}
+/**
+ * Represents a line item in a checkout session request
+ */
+export interface CreateCheckoutSessionLineDto {
+    product_id: FlakeId;
+    /**
+     * Determines whether this line should create a subscription
+     */
+    subscription?: boolean | null;
+    /**
+     * Indicates whether the product should be trialed
+     */
+    trial?: boolean | null;
+    gift_to?: CustomerPlatformAccountDto;
+    gift_to_customer_id?: FlakeId;
+    /**
+     * The quantity of this product to purchase
+     * @format int32
+     */
+    quantity: number;
+    selected_gameserver_id?: FlakeId;
+    /**
+     * Key-value pair mapping custom variable identifiers to their selected values.
+     * Required only when the product includes custom variables.
+     */
+    custom_variables?: Record<string, string> | null;
+}
+/**
+ * Request to create a new checkout session
+ */
+export interface CreateCheckoutSessionRequestDto {
+    /**
+     * The line items to include in the checkout.
+     */
+    lines: Array<CreateCheckoutSessionLineDto>;
+    coupon_id?: FlakeId;
+    /**
+     * Optional array of promo codes (coupons, gift cards, affiliates) to apply.
+     * An invalid promo code will cause an error.
+     */
+    promo_codes?: Array<string> | null;
+    /**
+     * Optional affiliate code to track referrals.
+     * An invalid affiliate code will NOT cause an error.
+     */
+    affiliate_code?: string | null;
+    /**
+     * Optional URL to redirect to after successful checkout
+     */
+    return_url?: string | null;
+    /**
+     * Optional URL to redirect to if checkout is canceled
+     */
+    cancel_url?: string | null;
+    /**
+     * Whether to automatically redirect the customer (return_url must be set)
+     */
+    auto_redirect?: boolean | null;
+}
+/**
+ * Response after creating a checkout session
+ */
+export interface CreateCheckoutSessionResponseDto {
+    id: FlakeId;
+    /**
+     * The token for the checkout session
+     */
+    token: string;
+    /**
+     * The URL to redirect the customer to complete checkout
+     */
+    url: string;
+}
+/**
+ * Request headers
+ */
+export type CustomerAuthenticateStorefrontCustomerHeaders = {
+    /**
+     * The IP address (IPv4 or IPv6) of the customer. Required if the request is not being made from the customer's browser.
+     * @format ipv4
+     */
+    "x-paynow-customer-ip"?: string;
+    /**
+     * The customer's country code in ISO 3166-1 alpha-2 format. Optional, but recommended if you have this available.
+     * @pattern ^[A-Z]{2}$
+     */
+    "x-paynow-customer-countrycode"?: string;
+};
+/**
+ * Represents a customer in the PayNow system with their associated profiles and metadata.
+ */
+export interface CustomerDto {
+    id: FlakeId;
+    store_id: FlakeId;
+    profile?: CustomerGenericProfileDto;
+    steam_id?: SteamId;
+    steam?: CustomerSteamProfileDto;
+    /**
+     * 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?: CustomerMinecraftProfileDto;
+    /**
+     * The customer's Xbox XUID, if available.
+     */
+    xbox_xuid?: string | null;
+    minecraft_platform?: CustomerMinecraftPlatform;
+    /**
+     * The display name for the customer.
+     * @example "m0uka"
+     */
+    name?: string | null;
+    /**
+     * The date and time when the customer was created in the system.
+     * @format date-time
+     */
+    created_at: string;
+    /**
+     * The date and time when the customer was last updated, if applicable.
+     * @format date-time
+     */
+    updated_at?: string | null;
+    /**
+     * Additional custom data associated with the customer.
+     */
+    metadata: Record<string, string>;
+}
+/**
+ * Represents a generic platform profile for a customer.
+ */
+export interface CustomerGenericProfileDto {
+    /**
+     * The platform-specific identifier for the profile.
+     */
+    id: string;
+    /**
+     * The name of the platform this profile belongs to.
+     * @example "steam"
+     */
+    platform: string;
+    /**
+     * The display name of the user on this platform.
+     */
+    name: string;
+    /**
+     * The URL to the user's avatar image on this platform.
+     */
+    avatar_url?: string | null;
+}
+export type CustomerMinecraftPlatform = "unknown" | "java" | "bedrock";
+/**
+ * Represents a Minecraft profile for a customer.
+ */
+export interface CustomerMinecraftProfileDto {
+    /**
+     * 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;
+}
+/**
+ * Represents a customer platform association, used for gifting
+ */
+export interface CustomerPlatformAccountDto {
+    platform: CustomerProfilePlatform;
+    /**
+     * The account ID on the platform
+     * @example "76561198152492642"
+     */
+    id: string;
+}
+/**
+ * - `steam`: Steam profile platform - the ID param must be a Steam ID 64.
+ * - `minecraft`: Minecraft profile platform - the ID param must be a Minecraft nick.
+            If your store platform is Geyser, this automatically sets the Minecraft platform based on the prefix configured in store settings.
+ * - `paynow_name`: PayNow name profile platform - the ID param must be a PayNow username.
+ * - `paynow`: PayNow name profile platform - the ID param must be a PayNow username.
+ * - `minecraft_java_name`: Minecraft Java Profile Platform - the ID param must be a Java minecraft nick.
+ * - `minecraft_bedrock_name`: Minecraft Bedrock Profile Platform - the ID param must be a Bedrock minecraft nick.
+ * - `xbox_xuid`: Minecraft Xbox XUID Profile Platform - the ID param must be an xbox xuid
+ * - `minecraft_uuid`: Minecraft profile platform - the ID param must be a Minecraft UUID.
+ */
+export type CustomerProfilePlatform = "invalid" | "steam" | "minecraft" | "paynow_name" | "paynow" | "minecraft_java_name" | "minecraft_bedrock_name" | "xbox_xuid" | "minecraft_uuid";
+/**
+ * Represents a Steam profile for a customer.
+ */
+export interface CustomerSteamProfileDto {
+    id: SteamId;
+    /**
+     * The display name of the user on Steam.
+     */
+    name: string;
+    /**
+     * The URL to the user's Steam avatar image.
+     */
+    avatar_url: string;
+}
+export interface CustomerTierGroupDto {
+    tier_group_id: FlakeId;
+    active_product_id: FlakeId;
+    pending_change_product_id?: FlakeId;
+    /**
+     * The date and time of the next subscription renewal for this tier group.
+     * @format date-time
+     */
+    next_renewal_at: string;
+    /**
+     * The next billing amount in the smallest currency unit (e.g., cents) in the settlement currency.
+     * @format int64
+     */
+    next_billing_amount: number;
+    /**
+     * The next billing amount in the smallest currency unit (e.g., cents) in the customer-facing presentment currency.
+     * @format int64
+     */
+    next_billing_presentment_amount: number;
+    /**
+     * The settlement currency code (e.g., "usd").
+     */
+    currency: string;
+    /**
+     * The customer-facing presentment currency code (e.g., "eur").
+     */
+    presentment_currency: string;
+}
+export interface CustomVariableLineItemDto {
+    id: FlakeId;
+    /**
+     * The identifier used to reference this custom variable (e.g., "color", "size").
+     */
+    identifier: string;
+    /**
+     * The display name of the custom variable shown to users.
+     */
+    name: string;
+    /**
+     * A detailed description of what this custom variable represents.
+     */
+    description: string;
+    /**
+     * The price associated with this custom variable in the smallest currency unit (e.g., cents).
+     * @format int64
+     */
+    price: number;
+    /**
+     * The selected value for this custom variable.
+     */
+    value: string;
+}
+/**
+ * Defines the type of input method for a custom variable.
+ * - `dropdown`: Dropdown selection with predefined options.
+            Customers choose from a list of available options.
+            Allows for additional pricing based on the selected entry.
+ * - `text`: Free-form text input.
+            Customers can enter any text value (subject to validation).
+ * - `number`: Numeric input.
+            Customers can enter numeric values (subject to validation).
+ */
+export type CustomVariableType = "dropdown" | "text" | "number";
+/**
+ * Query parameters
+ */
+export type DeliveryGetStorefrontCustomerDeliveryItemsQuery = {
+    /**
+     * The maximum number of items to return in a single request.
+     * @format int32
+     * @minimum 1
+     * @maximum 100
+     */
+    limit?: number;
+    /**
+     * Returns items after the specified ID.
+     * Used for forward pagination through results.
+     */
+    after?: FlakeId;
+    /**
+     * Returns items before the specified ID.
+     * Used for backward pagination through results.
+     */
+    before?: FlakeId;
+    /**
+     * Determines the sort order of returned items.
+     * When true, items are returned in ascending order.
+     * When false, items are returned in descending order.
+     */
+    asc?: boolean;
+};
+/**
+ * Represents the product information for a delivery item
+ */
+export interface DeliveryItemProductDto {
+    id: FlakeId;
+    /**
+     * The name of the product
+     * @example "Premium Membership"
+     */
+    name: string;
+    /**
+     * The URL-friendly slug of the product
+     * @example "premium-membership"
+     */
+    slug: string;
+    /**
+     * The version identifier of the product
+     * @example "v2.1.0"
+     */
+    version_id: string;
+}
+export type DeliveryItemStateDto = "usable" | "active" | "used" | "revoked" | "renewed";
+/**
+ * Query parameters
+ */
+export type DiscordDoProductsHaveDiscordActionsQuery = {
+    product_version_id?: Array<FlakeId>;
+};
+/**
+ * @format flake-id
+ * @example "411486491630370816"
+ */
+export type FlakeId = string;
+/**
+ * Query parameters
+ */
+export type OrdersGetOrdersQuery = {
+    /**
+     * The maximum number of items to return in a single request.
+     * @format int32
+     * @minimum 1
+     * @maximum 100
+     */
+    limit?: number;
+    /**
+     * Returns items after the specified ID.
+     * Used for forward pagination through results.
+     */
+    after?: FlakeId;
+    /**
+     * Returns items before the specified ID.
+     * Used for backward pagination through results.
+     */
+    before?: FlakeId;
+    /**
+     * Determines the sort order of returned items.
+     * When true, items are returned in ascending order.
+     * When false, items are returned in descending order.
+     */
+    asc?: boolean;
+};
+export type OrderStatus = "created" | "completed" | "canceled" | "refunded" | "chargeback";
+/**
+ * Defines the type of items contained in an order
+ * - `one_time`: Order contains only one-time purchase items
+ * - `subscription_initial`: Order is the initial charge for a subscription
+ * - `subscription_renewal`: Order is a recurring renewal charge for a subscription
+ * - `subscription_proration`: Order is a proration charge for a subscription
+ * - `mixed`: Order contains both one-time purchase and subscription items
+ */
+export type OrderType = "one_time" | "subscription_initial" | "subscription_renewal" | "subscription_proration" | "mixed";
+export type PayNowActorType = "anonymous" | "user" | "api_key" | "customer" | "game_server" | "internal" | "admin" | "platform" | "global_customer";
+/**
+ * Represents a PayNow error
+ */
+export interface PayNowError {
+    /**
+     * The HTTP status code.
+     * @format int32
+     * @example 400
+     */
+    status: number;
+    /**
+     * The PayNow parseable error code.
+     * @example "bad-request"
+     */
+    code: string;
+    /**
+     * The human-readable error message.
+     * @example "Bad Request Example"
+     */
+    message: string;
+    /**
+     * A distributed trace ID used for debugging.
+     * @example "234a5bcd543ef3fa53ce929d0e0e4736"
+     */
+    trace_id?: string | null;
+    /**
+     * An array of multiple errors. Only used by some API services.
+     */
+    errors?: Array<ValidationError> | null;
+}
+export type PlatformCapability = "invalid" | "connected_users";
+export interface PlatformStoreTypeAssociationDetailsDto {
+    platform_id: FlakeId;
+    associated_platform?: PublicPlatformDto;
+    /**
+     * The store platform identifier string (e.g. "rust", "minecraft").
+     */
+    store_platform: string;
+    /**
+     * Overrides the default PayNow platform fee percentage for this association.
+     * Expressed in basis points (e.g. 250 = 2.50%).
+     * @format int64
+     */
+    paynow_platform_fee_percentage_override?: number | null;
+    /**
+     * The fee percentage charged by the connected platform.
+     * Expressed in basis points (e.g. 250 = 2.50%).
+     * @format int64
+     */
+    connected_platform_fee_percentage?: number | null;
+    connected_platform_wallet_id?: FlakeId;
+    /**
+     * When true, billing plans are disabled for this platform/store type combination.
+     */
+    disable_billing_plans: boolean;
+    /**
+     * When true, legal or compliance disclaimers should be displayed to the end user.
+     */
+    display_disclaimers: boolean;
+    /**
+     * Whether the management hides some PayNow UI
+     */
+    full_external_management: boolean;
+}
+export type PlatformType = "invalid" | "marketplace" | "store_platform" | "other";
+export interface ProductDeliverableActionsDto {
+    /**
+     * Value indicating whether to grant a giftcard with the product with the subtotal amount.
+     */
+    grant_giftcard: boolean;
+}
+export type ProductRemoveAfterIntervalScale = "invalid" | "day" | "week" | "month";
+/**
+ * Request headers
+ */
+export type ProductsGetStorefrontProductHeaders = {
+    /**
+     * The IP address (IPv4 or IPv6) of the customer. Required if the request is not being made from the customer's browser.
+     * @format ipv4
+     */
+    "x-paynow-customer-ip"?: string;
+    /**
+     * The customer's country code in ISO 3166-1 alpha-2 format. Optional, but recommended if you have this available.
+     * @pattern ^[A-Z]{2}$
+     */
+    "x-paynow-customer-countrycode"?: string;
+};
+/**
+ * Query parameters
+ */
+export type ProductsGetStorefrontProductQuery = {
+    /**
+     * The ISO three-letter lowercase currency code (e.g., usd, eur, gbp) to display prices in. If not provided, the store's default currency will be used.
+     */
+    currency?: string;
+};
+/**
+ * Request headers
+ */
+export type ProductsGetStorefrontProductsHeaders = {
+    /**
+     * The IP address (IPv4 or IPv6) of the customer. Required if the request is not being made from the customer's browser.
+     * @format ipv4
+     */
+    "x-paynow-customer-ip"?: string;
+    /**
+     * The customer's country code in ISO 3166-1 alpha-2 format. Optional, but recommended if you have this available.
+     * @pattern ^[A-Z]{2}$
+     */
+    "x-paynow-customer-countrycode"?: string;
+};
+/**
+ * Query parameters
+ */
+export type ProductsGetStorefrontProductsQuery = {
+    /**
+     * Tag slugs to filter by. Each tag slug is a separate query parameter.
+     */
+    tag?: Array<string>;
+    /**
+     * The ISO three-letter lowercase currency code (e.g., usd, eur, gbp) to display prices in. If not provided, the store's default currency will be used.
+     */
+    currency?: string;
+};
+export type ProductSubscriptionIntervalScale = "invalid" | "day" | "week" | "month" | "year";
+export interface ProductTagDto {
+    id: FlakeId;
+    /**
+     * The unique slug for the tag.
+     * @example "packages"
+     */
+    slug: string;
+    /**
+     * The display name of the tag.
+     * @example "Packages"
+     */
+    name: string;
+}
+/**
+ * Describes how proration is handled when a subscription change is applied.
+ * - `immediate`: Subscription will be updated instantly, and a proration charge will be applied.
+ * - `next_billing_period`: Subscription will be updated at the end of the billing period, no proration will be applied.
+ * - `none`: No proration is applied, subscription is updated instantly.
+ */
+export type ProrationBehaviorDto = "invalid" | "immediate" | "next_billing_period" | "none";
+export interface PublicPlatformDto {
+    id: FlakeId;
+    slug: string;
+    type: PlatformType;
+    country_code: string;
+    business_name: string;
+    name: string;
+    description: string;
+    website_url: string;
+    logo_url: string;
+    accent_color: string;
+    capabilities: Array<PlatformCapability>;
+    /**
+     * @format date-time
+     */
+    created_at: string;
+    /**
+     * @format date-time
+     */
+    updated_at?: string | null;
+    /**
+     * @format date-time
+     */
+    disabled_at?: string | null;
+}
+export type SaleDiscountTypeDto = "percent" | "amount";
+/**
+ * The Sales Tax estimation for the passed in customer country / IP.
+ * Include the tax percentage + abbreviation in your product view to inform your customers about the tax.
+ */
+export interface SalesTaxEstimateDto {
+    /**
+     * The ISO country code.
+     * @example "CZ"
+     */
+    country_code: string;
+    /**
+     * The full name of the country.
+     * @example "Czech Republic"
+     */
+    country_name: string;
+    /**
+     * The local currency used in the country.
+     * @example "CZK"
+     */
+    currency: string;
+    /**
+     * The abbreviation of the tax term in the local language.
+     * @example "DPH"
+     * @readonly Set by the API; ignored on write.
+     */
+    vat_abbreviation: string;
+    /**
+     * The full name of the tax term in the local language.
+     * @example "Daň z přidané hodnoty"
+     * @readonly Set by the API; ignored on write.
+     */
+    vat_local_name: string;
+    /**
+     * The abbreviation of the local tax identification number.
+     */
+    tax_number_abbreviation?: string | null;
+    /**
+     * The name of the local tax identification number.
+     */
+    tax_number_local_name?: string | null;
+    /**
+     * Indicates whether the country is a member of the European Union.
+     * @example true
+     */
+    eu_member_state: boolean;
+    /**
+     * The tax rate applicable for electronic services, as a percentage.
+     * @format double
+     * @example 21
+     */
+    eservice_rate: number;
+    /**
+     * The VAT rate (synonym for EServiceRate).
+     * @format double
+     * @example 21
+     * @readonly Set by the API; ignored on write.
+     */
+    percentage: number;
+}
+/**
+ * Object representing a sales tax jurisdiction and its associated taxes.
+ */
+export interface SalesTaxJurisdictionDto {
+    /**
+     * The name of the tax jurisdiction.
+     * @example "EU OSS"
+     */
+    name: string;
+    /**
+     * List of taxes applied within this jurisdiction.
+     */
+    taxes: Array<SalesTaxJurisdictionTaxDto>;
+    /**
+     * Explanation for why taxes are not applied, if applicable.
+     * This property is null when taxes are applied.
+     */
+    not_taxed_reason?: string | null;
+}
+/**
+ * Object representing a specific tax within a sales tax jurisdiction.
+ */
+export interface SalesTaxJurisdictionTaxDto {
+    /**
+     * The name of the tax.
+     */
+    tax_name: string;
+    /**
+     * The amount subject to taxation, formatted as a string.
+     */
+    taxable_amount: string;
+    /**
+     * The calculated tax amount, formatted as a string.
+     */
+    tax_amount: string;
+    /**
+     * The rate at which the tax is applied, formatted as a string.
+     */
+    tax_rate: string;
+}
+/**
+ * A 64-bit Steam account identifier. Accepts string or numeric format.
+ * @format steam-id
+ * @example "76561197960287930"
+ */
+export type SteamId = string;
+/**
+ * Represents a PayNow store and its associated configuration.
+ */
+export interface StoreDto {
+    id: FlakeId;
+    owner_id: FlakeId;
+    /**
+     * The URL-safe slug used to identify the store (e.g. "my-rust-server").
+     */
+    slug: string;
+    /**
+     * The display name of the store.
+     */
+    name: string;
+    /**
+     * The platform this store is associated with (e.g. "rust", "minecraft").
+     */
+    platform: string;
+    /**
+     * Alias for 'platform'. Returns the platform identifier as a game name.
+     * @readonly Set by the API; ignored on write.
+     */
+    game: string;
+    /**
+     * The ISO 4217 currency code used by this store for pricing (e.g. "usd", "eur")
+     */
+    currency: string;
+    /**
+     * A human-readable description of the store shown to customers and PayNow.
+     */
+    description: string;
+    /**
+     * The store's public website URL.
+     */
+    website_url?: string | null;
+    /**
+     * General contact email address for the store.
+     */
+    contact_email?: string | null;
+    /**
+     * Dedicated support email address for customer inquiries.
+     */
+    support_email?: string | null;
+    /**
+     * URL to the store's support portal or help page.
+     */
+    support_url?: string | null;
+    /**
+     * The integration type used by the store.
+     */
+    integration_type?: string | null;
+    /**
+     * When set to true, the store is processing real transactions in live mode.
+     */
+    live_mode: boolean;
+    /**
+     * URL of the store's full-size logo image.
+     */
+    logo_url?: string | null;
+    /**
+     * URL of the store's square/icon logo image.
+     */
+    logo_square_url?: string | null;
+    /**
+     * Username prefix used to identify Minecraft Bedrock players (e.g. ".").
+     */
+    minecraft_bedrock_username_prefix?: string | null;
+    /**
+     * The UTC timestamp when the store was created.
+     * @format date-time
+     */
+    created_at?: string | null;
+    /**
+     * The UTC timestamp when the store was last updated.
+     * @format date-time
+     */
+    updated_at?: string | null;
+    /**
+     * The UTC timestamp when the store completed onboarding.
+     * @format date-time
+     */
+    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;
+}
+export interface StorefrontCustomVariableDto {
+    /**
+     * Unique identifier string used to reference this custom variable programmatically.
+     * Must contain only letters, numbers, underscores, and hyphens.
+     */
+    identifier: string;
+    /**
+     * Display name for the custom variable shown to customers.
+     */
+    name: string;
+    /**
+     * Description explaining what this custom variable is for. Can be shown to customers.
+     */
+    description: string;
+    type: CustomVariableType;
+    /**
+     * Optional regex pattern to validate text/number input values.
+     * Only applies to text and number types.
+     * Uses RE2 syntax - does not support negative lookarounds, backreferences, or other advanced regex features.
+     */
+    value_regex?: string | null;
+    /**
+     * Available options for dropdown type custom variables.
+     * Empty for text and number types.
+     */
+    options: Array<StorefrontCustomVariableOptionDto>;
+}
+export interface StorefrontCustomVariableOptionDto {
+    /**
+     * Display name shown to customers for this option.
+     */
+    name: string;
+    /**
+     * Internal value used for product command variable replacement, without brackets.
+     */
+    value: string;
+    /**
+     * Additional price in the lowest denominator (e.g. cents) when this option is selected.
+     * @format int64
+     */
+    price: number;
+    /**
+     * Whether this option is selected by default when the custom variable is presented.
+     * Only one option per custom variable should be marked as default.
+     */
+    is_default: boolean;
+    /**
+     * Sort order for displaying options to customers.
+     * Lower numbers appear first.
+     * @format int32
+     */
+    sort_order: number;
+}
+/**
+ * Represents a delivery item assigned to a customer
+ */
+export interface StorefrontDeliveryItemDto {
+    id: FlakeId;
+    store_id: FlakeId;
+    customer_id: FlakeId;
+    order_id?: FlakeId;
+    order_line_id?: FlakeId;
+    subscription_id?: FlakeId;
+    execute_on_gameserver_id?: FlakeId;
+    /**
+     * The index of the item when multiple quantities were assigned
+     * @format int32
+     */
+    quantity_index?: number | null;
+    product: DeliveryItemProductDto;
+    state: DeliveryItemStateDto;
+    /**
+     * Indicates whether the delivery item can expire
+     */
+    expirable: boolean;
+    /**
+     * Indicates whether the item was given as a gift
+     */
+    gift: boolean;
+    /**
+     * The date and time when the item was added
+     * @format date-time
+     */
+    added_at: string;
+    /**
+     * The date and time when the item became active
+     * @format date-time
+     */
+    active_at?: string | null;
+    /**
+     * The date and time when the item expires naturally
+     * @format date-time
+     */
+    expires_at?: string | null;
+    /**
+     * The override expiry date for the delivery item
+     * @format date-time
+     */
+    override_expires_at?: string | null;
+    /**
+     * The date and time when the item was removed
+     * @format date-time
+     */
+    removed_at?: string | null;
+    /**
+     * The date and time when the item was revoked
+     * @format date-time
+     */
+    revoked_at?: string | null;
+    /**
+     * The reason for revoking the delivery item
+     */
+    revoke_reason?: string | null;
+}
+/**
+ * Represents a simplified view of a game server for storefront display purposes.
+ */
+export interface StorefrontGameServerDto {
+    id: FlakeId;
+    /**
+     * The display name of the game server.
+     */
+    name: string;
+    /**
+     * Indicates whether the game server is currently enabled.
+     */
+    enabled: boolean;
+}
+export interface StorefrontGiftCardDto {
+    code: string;
+    /**
+     * @format int32
+     */
+    balance: number;
+    /**
+     * @format int32
+     */
+    starting_balance: number;
+    /**
+     * @format date-time
+     */
+    expires_at?: string | null;
+}
+/**
+ * Represents a navigation link in the storefront's hierarchical navigation structure.
+ */
+export interface StorefrontNavLinkDto {
+    /**
+     * The unique identifier for this navigation node in the navigation tree.
+     */
+    node_id: string;
+    /**
+     * The identifier of the parent navigation node, if this is a child node.
+     */
+    parent_node_id?: string | null;
+    tag_id: FlakeId;
+    /**
+     * The URL-friendly slug for the tag associated with this navigation link.
+     * @example "perks"
+     */
+    tag_slug: string;
+    /**
+     * A list containing all parent tags and this node's tag, representing the complete path in the tag hierarchy.
+     * @example ["perks","vip"]
+     */
+    tag_query: Array<string>;
+    /**
+     * The display name of the associated tag shown to users in the UI.
+     * @example "Perks"
+     */
+    name: string;
+    /**
+     * The display order of this navigation link relative to its siblings.
+     * @format int32
+     */
+    order: number;
+    /**
+     * The collection of child navigation links that appear beneath this link in the hierarchy.
+     */
+    children: Array<StorefrontNavLinkDto>;
+}
+/**
+ * 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;
+}
+export interface StorefrontProductDto {
+    id: FlakeId;
+    store_id: FlakeId;
+    version_id: FlakeId;
+    /**
+     * The URL to the product image.
+     * @example "https://cdn.paynow.gg/logo/full/logotype-color.svg"
+     */
+    image_url?: string | null;
+    /**
+     * The unique slug for the product.
+     * @example "premium-game-package"
+     */
+    slug: string;
+    /**
+     * The display name of the product.
+     * @example "Premium Game Package"
+     */
+    name: string;
+    /**
+     * The detailed description of the product.
+     * @example "This premium package includes exclusive in-game items, bonus currency, and early access to new content."
+     */
+    description: string;
+    /**
+     * The date and time when the product becomes enabled.
+     * @format date-time
+     */
+    enabled_at?: string | null;
+    /**
+     * The date and time until which the product remains enabled.
+     * @format date-time
+     */
+    enabled_until?: string | null;
+    /**
+     * The display label for the product.
+     * @example "Premium Items"
+     */
+    label?: string | null;
+    /**
+     * Indicates if the product is hidden.
+     */
+    hidden: boolean;
+    /**
+     * The sort order for displaying the product.
+     * @format int32
+     */
+    sort_order: number;
+    /**
+     * The price of the product, in the lowest denominator (e.g. cents).
+     * @format int64
+     * @example 1999
+     */
+    price: number;
+    /**
+     * The ISO three-letter lowercase currency code (e.g., usd, eur, gbp) the product is denominated in.
+     */
+    currency: string;
+    /**
+     * Indicates whether the product is limited to a single game server.
+     */
+    single_game_server_only: boolean;
+    /**
+     * Indicates whether one-time purchases are allowed.
+     * @example true
+     */
+    allow_one_time_purchase: boolean;
+    /**
+     * Indicates whether subscription purchases are allowed.
+     * @example true
+     */
+    allow_subscription: boolean;
+    /**
+     * Indicates whether gifting is disabled for this product.
+     */
+    is_gifting_disabled: boolean;
+    /**
+     * Indicates whether gift cards are disabled entirely for the product.
+     */
+    is_gift_cards_disabled: boolean;
+    /**
+     * Indicates whether coupons are disabled entirely for the product.
+     */
+    is_coupons_disabled: boolean;
+    /**
+     * Indicates whether affiliate links are disabled entirely for the product.
+     */
+    is_affiliate_links_disabled: boolean;
+    /**
+     * The subscription interval value.
+     * @format int32
+     * @example 1
+     */
+    subscription_interval_value: number;
+    subscription_interval_scale: ProductSubscriptionIntervalScale;
+    /**
+     * Indicates whether automatic removal is enabled.
+     * @example true
+     */
+    remove_after_enabled: boolean;
+    /**
+     * The time value for automatic removal.
+     * @format int32
+     * @example 1
+     */
+    remove_after_time_value: number;
+    remove_after_time_scale: ProductRemoveAfterIntervalScale;
+    pricing?: StorefrontProductPricingDto;
+    stock?: StorefrontProductStockDto;
+    trial: StorefrontProductTrialDto;
+    /**
+     * The tags associated with the product.
+     */
+    tags: Array<ProductTagDto>;
+    /**
+     * The game servers associated with the product.
+     */
+    gameservers: Array<StorefrontGameServerDto>;
+    /**
+     * Custom Variables associated with the product.
+     */
+    custom_variables: Array<StorefrontCustomVariableDto>;
+    deliverable_actions?: ProductDeliverableActionsDto;
+    /**
+     * Additional metadata for the product.
+     */
+    metadata?: Record<string, string> | null;
+    /**
+     * The date and time when the product was created.
+     * @format date-time
+     */
+    created_at?: string | null;
+    /**
+     * The date and time when the product was last updated.
+     * @format date-time
+     */
+    updated_at?: string | null;
+    tier_group_id?: FlakeId;
+    active_tier_group?: CustomerTierGroupDto;
+}
+/**
+ * The pricing details for the product in the storefront.
+ */
+export interface StorefrontProductPricingDto {
+    active_sale?: StorefrontSaleDto;
+    /**
+     * The amount of the sale discount in the lowest denominator (e.g. cents).
+     * @format int64
+     * @example 500
+     */
+    sale_value?: number | null;
+    vat_rate?: SalesTaxEstimateDto;
+    regional_pricing?: StorefrontProductRegionalPricingDto;
+    /**
+     * The original price of the product before any discounts, in the lowest denominator (e.g. cents).
+     * @format int64
+     * @example 1999
+     */
+    price_original: number;
+    /**
+     * The final price of the product after all discounts, in the lowest denominator (e.g. cents).
+     * @format int64
+     * @example 1499
+     */
+    price_final: number;
+}
+/**
+ * Regional pricing information for this product.
+ * Only present if there is a regional pricing configured.
+ */
+export interface StorefrontProductRegionalPricingDto {
+    /**
+     * The identifier for the region.
+     * @example "eu"
+     */
+    region_id: string;
+    /**
+     * The currency code used in the region.
+     * @example "eur"
+     */
+    currency: string;
+    /**
+     * Indicates whether the base price includes tax.
+     * @example true
+     */
+    tax_inclusive: boolean;
+    /**
+     * The base price in the regional currency, in the lowest denominator (e.g. cents).
+     * @format int64
+     * @example 1799
+     */
+    base_price: number;
+}
+/**
+ * The stock status information for the product in the storefront.
+ */
+export interface StorefrontProductStockDto {
+    /**
+     * Indicates whether the product is currently available for purchase (there is available stock).
+     * @example true
+     */
+    available_to_purchase: boolean;
+    /**
+     * The number of items available for the customer to purchase (customer stock limit remaining).
+     * @format int32
+     * @example 5
+     */
+    customer_available: number;
+}
+export interface StorefrontProductTrialDto {
+    /**
+     * Indicates whether the trial period is enabled for this product.
+     */
+    enabled: boolean;
+    /**
+     * Indicates whether the customer is eligible for the trial period.
+     */
+    eligible: boolean;
+    /**
+     * The duration value of the trial period.
+     * @format int32
+     */
+    period_value: number;
+    period_scale: ProductSubscriptionIntervalScale;
+}
+export interface StorefrontSaleDto {
+    id: FlakeId;
+    version_id: FlakeId;
+    /**
+     * The name of the sale.
+     * @example "Summer Sale"
+     */
+    name: string;
+    discount_type: SaleDiscountTypeDto;
+    /**
+     * The amount of the discount, either as a percentage in permille or as an absolute value in cents.
+     * @format int64
+     * @example 2000
+     */
+    discount_amount: number;
+    /**
+     * The minimum order value required to apply the discount, in the lowest denominator (e.g. cents).
+     * @format int64
+     * @example 0
+     */
+    minimum_order_value: number;
+    /**
+     * The date and time when the sale begins.
+     * @format date-time
+     * @example "2025-06-01T00:00:00Z"
+     */
+    begins_at: string;
+    /**
+     * The date and time when the sale ends, if applicable.
+     * @format date-time
+     * @example "2025-06-30T23:59:59Z"
+     */
+    ends_at?: string | null;
+}
+/**
+ * Represents a store entity within the storefront system.
+ */
+export interface StorefrontStoreDto {
+    id: FlakeId;
+    /**
+     * The URL-friendly identifier for the store, used in store URLs.
+     * @example "m0ukas-awesome-store"
+     */
+    slug: string;
+    /**
+     * The display name of the store shown to customers.
+     * @example "m0uka's awesome store"
+     */
+    name: string;
+    /**
+     * The platform or the game of the store.
+     * @example "rust"
+     */
+    platform: string;
+    /**
+     * The game of the store. Equivalent to the `platform` for backwards compatibility.
+     * @readonly Set by the API; ignored on write.
+     */
+    game: string;
+    /**
+     * The three-letter ISO currency code used for pricing in this store.
+     * If using the Adaptive Currency feature, this will be updated to reflect customer's local currency
+     * (based on passed in IP / country headers).
+     * @example "eur"
+     */
+    currency: string;
+    /**
+     * The three-letter ISO currency code signifying the main currency of the store.
+     * @example "usd"
+     */
+    creator_currency: string;
+    /**
+     * A detailed description of the store. Only present for some platform types.
+     */
+    description?: string | null;
+    /**
+     * The URL of the store's main website, if not using Hosted Webstores.
+     */
+    website_url?: string | null;
+    /**
+     * The email address customers can use to contact store support.
+     * @example "support@example.com"
+     */
+    support_email?: string | null;
+    /**
+     * The URL of the store's support page.
+     */
+    support_url?: string | null;
+    /**
+     * The type of integration this store uses with external systems.
+     */
+    integration_type?: string | null;
+    /**
+     * Indicates whether the store is in live mode (true) or test mode (false).
+     */
+    live_mode: boolean;
+    /**
+     * The URL to the store's main logo image.
+     */
+    logo_url?: string | null;
+    /**
+     * The URL to the store's square logo image.
+     */
+    logo_square_url?: string | null;
+    /**
+     * The date and time when the store was created.
+     * @format date-time
+     */
+    created_at?: string | null;
+    /**
+     * The date and time when the store was last updated.
+     * @format date-time
+     */
+    updated_at?: string | null;
+}
+/**
+ * Data transfer object representing a store subscription.
+ */
+export interface StorefrontSubscriptionDto {
+    id: FlakeId;
+    /**
+     * Human-readable identifier for the subscription.
+     * @readonly Set by the API; ignored on write.
+     */
+    pretty_id: string;
+    store_id: FlakeId;
+    customer: StorefrontCustomerDto;
+    pending_change?: SubscriptionChangeDto;
+    next_billing_amount: SubscriptionBillingAmountDto;
+    next_billing_presentment_amount: SubscriptionBillingAmountDto;
+    status: SubscriptionStatusDto;
+    /**
+     * Identifiers of coupons applied to this subscription.
+     */
+    coupon_ids: Array<FlakeId>;
+    checkout_id?: FlakeId;
+    /**
+     * List of tax jurisdictions applicable to this subscription.
+     */
+    tax_jurisdictions: Array<SalesTaxJurisdictionDto>;
+    /**
+     * Numeric value of the billing interval.
+     * @format int32
+     */
+    interval_value: number;
+    interval_scale: ProductSubscriptionIntervalScale;
+    /**
+     * Currency code used for billing this subscription.
+     */
+    currency: string;
+    /**
+     * Amount of discount applied in smallest currency units.
+     * @format int64
+     */
+    discount_amount: number;
+    /**
+     * Formatted string representation of the discount amount.
+     * @readonly Set by the API; ignored on write.
+     */
+    discount_amount_str: string;
+    /**
+     * Subtotal amount in smallest currency units.
+     * @format int64
+     */
+    subtotal_amount: number;
+    /**
+     * Formatted string representation of the subtotal amount.
+     * @readonly Set by the API; ignored on write.
+     */
+    subtotal_amount_str: string;
+    /**
+     * Tax amount in the smallest currency units.
+     * @format int64
+     */
+    tax_amount: number;
+    /**
+     * Formatted string representation of the tax amount.
+     * @readonly Set by the API; ignored on write.
+     */
+    tax_amount_str: string;
+    /**
+     * Total amount in the smallest currency units.
+     * @format int64
+     */
+    total_amount: number;
+    /**
+     * Formatted string representation of the total amount.
+     * @readonly Set by the API; ignored on write.
+     */
+    total_amount_str: string;
+    /**
+     * Initial discount amount in the smallest currency units for the first billing cycle.
+     * @format int64
+     */
+    initial_discount_amount: number;
+    /**
+     * Formatted string representation of the initial discount amount.
+     * @readonly Set by the API; ignored on write.
+     */
+    initial_discount_amount_str: string;
+    /**
+     * Initial subtotal amount in smallest currency units for the first billing cycle.
+     * @format int64
+     */
+    initial_subtotal_amount: number;
+    /**
+     * Formatted string representation of the initial subtotal amount.
+     * @readonly Set by the API; ignored on write.
+     */
+    initial_subtotal_amount_str: string;
+    /**
+     * Initial gift card usage amount in smallest currency units.
+     * @format int64
+     */
+    initial_giftcard_usage_amount: number;
+    /**
+     * Formatted string representation of the initial gift card usage amount.
+     * @readonly Set by the API; ignored on write.
+     */
+    initial_giftcard_usage_amount_str: string;
+    /**
+     * Initial tax amount in smallest currency units for the first billing cycle.
+     * @format int64
+     */
+    initial_tax_amount: number;
+    /**
+     * Formatted string representation of the initial tax amount.
+     * @readonly Set by the API; ignored on write.
+     */
+    initial_tax_amount_str: string;
+    /**
+     * Initial total amount in smallest currency units for the first billing cycle.
+     * @format int64
+     */
+    initial_total_amount: number;
+    /**
+     * Formatted string representation of the initial total amount.
+     * @readonly Set by the API; ignored on write.
+     */
+    initial_total_amount_str: string;
+    /**
+     * Presentment currency code (currency shown to customer).
+     */
+    presentment_currency?: string | null;
+    /**
+     * Presentment subtotal amount in smallest currency units.
+     * @format int64
+     */
+    presentment_subtotal_amount?: number | null;
+    /**
+     * Formatted string representation of the presentment subtotal amount.
+     * @readonly Set by the API; ignored on write.
+     */
+    presentment_subtotal_amount_str?: string | null;
+    /**
+     * Presentment discount amount in smallest currency units.
+     * @format int64
+     */
+    presentment_discount_amount?: number | null;
+    /**
+     * Formatted string representation of the presentment discount amount.
+     * @readonly Set by the API; ignored on write.
+     */
+    presentment_discount_amount_str?: string | null;
+    /**
+     * Presentment tax amount in smallest currency units.
+     * @format int64
+     */
+    presentment_tax_amount?: number | null;
+    /**
+     * Formatted string representation of the presentment tax amount.
+     * @readonly Set by the API; ignored on write.
+     */
+    presentment_tax_amount_str?: string | null;
+    /**
+     * Presentment total amount in smallest currency units.
+     * @format int64
+     */
+    presentment_total_amount?: number | null;
+    /**
+     * Formatted string representation of the presentment total amount.
+     * @readonly Set by the API; ignored on write.
+     */
+    presentment_total_amount_str?: string | null;
+    /**
+     * Initial presentment discount amount in smallest currency units for the first billing cycle.
+     * @format int64
+     */
+    initial_presentment_discount_amount?: number | null;
+    /**
+     * Formatted string representation of the initial presentment discount amount.
+     * @readonly Set by the API; ignored on write.
+     */
+    initial_presentment_discount_amount_str?: string | null;
+    /**
+     * Initial presentment subtotal amount in smallest currency units for the first billing cycle.
+     * @format int64
+     */
+    initial_presentment_subtotal_amount?: number | null;
+    /**
+     * Formatted string representation of the initial presentment subtotal amount.
+     * @readonly Set by the API; ignored on write.
+     */
+    initial_presentment_subtotal_amount_str?: string | null;
+    /**
+     * Initial presentment gift card usage amount in smallest currency units.
+     * @format int64
+     */
+    initial_presentment_giftcard_usage_amount?: number | null;
+    /**
+     * Formatted string representation of the initial presentment gift card usage amount.
+     * @readonly Set by the API; ignored on write.
+     */
+    initial_presentment_giftcard_usage_amount_str?: string | null;
+    /**
+     * Initial presentment tax amount in smallest currency units for the first billing cycle.
+     * @format int64
+     */
+    initial_presentment_tax_amount?: number | null;
+    /**
+     * Formatted string representation of the initial presentment tax amount.
+     * @readonly Set by the API; ignored on write.
+     */
+    initial_presentment_tax_amount_str?: string | null;
+    /**
+     * Initial presentment total amount in smallest currency units for the first billing cycle.
+     * @format int64
+     */
+    initial_presentment_total_amount?: number | null;
+    /**
+     * Formatted string representation of the initial presentment total amount.
+     * @readonly Set by the API; ignored on write.
+     */
+    initial_presentment_total_amount_str?: string | null;
+    /**
+     * The foreign exchange rate applied (if presentment currency differs from settlement currency).
+     */
+    fx_rate?: string | null;
+    /**
+     * Start date of the current billing period.
+     * @format date-time
+     */
+    current_period_start?: string | null;
+    /**
+     * End date of the current billing period.
+     * @format date-time
+     */
+    current_period_end?: string | null;
+    /**
+     * Sequence number of the current billing cycle.
+     * @format int32
+     */
+    billing_cycle_sequence?: number | null;
+    /**
+     * Date and time when the next payment attempt will occur.
+     * @format date-time
+     */
+    next_attempt_at?: string | null;
+    /**
+     * Number of payment attempts made for the current billing cycle.
+     * @format int32
+     */
+    attempt_count?: number | null;
+    /**
+     * Date and time when the subscription was created.
+     * @format date-time
+     */
+    created_at: string;
+    /**
+     * Date and time when the subscription was last updated.
+     * @format date-time
+     */
+    updated_at?: string | null;
+    /**
+     * Date and time when the subscription became active.
+     * @format date-time
+     */
+    active_at?: string | null;
+    /**
+     * Date and time when the subscription was canceled.
+     * @format date-time
+     */
+    canceled_at?: string | null;
+    /**
+     * Reason provided for cancellation.
+     */
+    cancel_reason?: string | null;
+    /**
+     * Date and time when a subscription cancellation (cancel_at_period_end) was requested.
+     * @format date-time
+     */
+    cancellation_requested_at?: string | null;
+    /**
+     * Whether the subscription will be canceled at the end of the billing period.
+     * @readonly Set by the API; ignored on write.
+     */
+    cancel_at_period_end: boolean;
+    /**
+     * Whether the subscription is past due, and is in a dunning (retrying) state.
+     */
+    past_due: boolean;
+    /**
+     * Line items associated with this subscription.
+     */
+    lines: Array<StorefrontSubscriptionLineDto>;
+}
+/**
+ * Represents a line item within a subscription.
+ */
+export interface StorefrontSubscriptionLineDto {
+    id: FlakeId;
+    store_id: FlakeId;
+    subscription_id: FlakeId;
+    checkout_line_id?: FlakeId;
+    initial_order_line_id?: FlakeId;
+    /**
+     * Identifier for the pricing region associated with this subscription line.
+     */
+    pricing_region_id?: string | null;
+    gift_to_customer_id?: FlakeId;
+    selected_gameserver_id?: FlakeId;
+    sale_id?: FlakeId;
+    sale_version_id?: FlakeId;
+    trial_id?: FlakeId;
+    product_id: FlakeId;
+    product_version_id: FlakeId;
+    /**
+     * Name of the product associated with this subscription line.
+     */
+    product_name: string;
+    /**
+     * URL for the product image.
+     */
+    product_image_url?: string | null;
+    /**
+     * Indicates whether tax is included in the base price itself.
+     */
+    tax_inclusive: boolean;
+    /**
+     * Currency code for this subscription line.
+     */
+    currency: string;
+    /**
+     * Base price of the subscription line in smallest currency units (e.g., cents).
+     * @format int64
+     */
+    price: number;
+    /**
+     * Amount of discount applied in smallest currency units.
+     * @format int64
+     */
+    discount_amount: number;
+    /**
+     * Formatted string representation of the discount amount.
+     * @readonly Set by the API; ignored on write.
+     */
+    discount_amount_str: string;
+    /**
+     * Subtotal amount in smallest currency units.
+     * @format int64
+     */
+    subtotal_amount: number;
+    /**
+     * Formatted string representation of the subtotal amount.
+     * @readonly Set by the API; ignored on write.
+     */
+    subtotal_amount_str: string;
+    /**
+     * Tax amount in smallest currency units.
+     * @format int64
+     */
+    tax_amount: number;
+    /**
+     * Formatted string representation of the tax amount.
+     * @readonly Set by the API; ignored on write.
+     */
+    tax_amount_str: string;
+    /**
+     * Total amount in smallest currency units.
+     * @format int64
+     */
+    total_amount: number;
+    /**
+     * Formatted string representation of the total amount.
+     * @readonly Set by the API; ignored on write.
+     */
+    total_amount_str: string;
+    /**
+     * Initial discount amount in smallest currency units for the first billing cycle.
+     * @format int64
+     */
+    initial_discount_amount: number;
+    /**
+     * Formatted string representation of the initial discount amount.
+     * @readonly Set by the API; ignored on write.
+     */
+    initial_discount_amount_str: string;
+    /**
+     * Initial subtotal amount in smallest currency units for the first billing cycle.
+     * @format int64
+     */
+    initial_subtotal_amount: number;
+    /**
+     * Formatted string representation of the initial subtotal amount.
+     * @readonly Set by the API; ignored on write.
+     */
+    initial_subtotal_amount_str: string;
+    /**
+     * Initial gift card usage amount in smallest currency units.
+     * @format int64
+     */
+    initial_giftcard_usage_amount: number;
+    /**
+     * Formatted string representation of the initial gift card usage amount.
+     * @readonly Set by the API; ignored on write.
+     */
+    initial_giftcard_usage_amount_str: string;
+    /**
+     * Initial tax amount in smallest currency units for the first billing cycle.
+     * @format int64
+     */
+    initial_tax_amount: number;
+    /**
+     * Formatted string representation of the initial tax amount.
+     * @readonly Set by the API; ignored on write.
+     */
+    initial_tax_amount_str: string;
+    /**
+     * Initial total amount in smallest currency units for the first billing cycle.
+     * @format int64
+     */
+    initial_total_amount: number;
+    /**
+     * Formatted string representation of the initial total amount.
+     * @readonly Set by the API; ignored on write.
+     */
+    initial_total_amount_str: string;
+    /**
+     * Presentment currency code (currency shown to customer).
+     */
+    presentment_currency?: string | null;
+    /**
+     * Presentment subtotal amount in smallest currency units.
+     * @format int64
+     */
+    presentment_subtotal_amount?: number | null;
+    /**
+     * Formatted string representation of the presentment subtotal amount.
+     * @readonly Set by the API; ignored on write.
+     */
+    presentment_subtotal_amount_str?: string | null;
+    /**
+     * Presentment discount amount in smallest currency units.
+     * @format int64
+     */
+    presentment_discount_amount?: number | null;
+    /**
+     * Formatted string representation of the presentment discount amount.
+     * @readonly Set by the API; ignored on write.
+     */
+    presentment_discount_amount_str?: string | null;
+    /**
+     * Presentment tax amount in smallest currency units.
+     * @format int64
+     */
+    presentment_tax_amount?: number | null;
+    /**
+     * Formatted string representation of the presentment tax amount.
+     * @readonly Set by the API; ignored on write.
+     */
+    presentment_tax_amount_str?: string | null;
+    /**
+     * Presentment total amount in smallest currency units.
+     * @format int64
+     */
+    presentment_total_amount?: number | null;
+    /**
+     * Formatted string representation of the presentment total amount.
+     * @readonly Set by the API; ignored on write.
+     */
+    presentment_total_amount_str?: string | null;
+    /**
+     * Initial presentment discount amount in smallest currency units for the first billing cycle.
+     * @format int64
+     */
+    initial_presentment_discount_amount?: number | null;
+    /**
+     * Formatted string representation of the initial presentment discount amount.
+     * @readonly Set by the API; ignored on write.
+     */
+    initial_presentment_discount_amount_str?: string | null;
+    /**
+     * Initial presentment subtotal amount in smallest currency units for the first billing cycle.
+     * @format int64
+     */
+    initial_presentment_subtotal_amount?: number | null;
+    /**
+     * Formatted string representation of the initial presentment subtotal amount.
+     * @readonly Set by the API; ignored on write.
+     */
+    initial_presentment_subtotal_amount_str?: string | null;
+    /**
+     * Initial presentment gift card usage amount in smallest currency units.
+     * @format int64
+     */
+    initial_presentment_giftcard_usage_amount?: number | null;
+    /**
+     * Formatted string representation of the initial presentment gift card usage amount.
+     * @readonly Set by the API; ignored on write.
+     */
+    initial_presentment_giftcard_usage_amount_str?: string | null;
+    /**
+     * Initial presentment tax amount in smallest currency units for the first billing cycle.
+     * @format int64
+     */
+    initial_presentment_tax_amount?: number | null;
+    /**
+     * Formatted string representation of the initial presentment tax amount.
+     * @readonly Set by the API; ignored on write.
+     */
+    initial_presentment_tax_amount_str?: string | null;
+    /**
+     * Initial presentment total amount in smallest currency units for the first billing cycle.
+     * @format int64
+     */
+    initial_presentment_total_amount?: number | null;
+    /**
+     * Formatted string representation of the initial presentment total amount.
+     * @readonly Set by the API; ignored on write.
+     */
+    initial_presentment_total_amount_str?: string | null;
+}
+/**
+ * Represents a tag entity used for categorizing and filtering products within a store.
+ */
+export interface StorefrontTagDto {
+    id: FlakeId;
+    store_id: FlakeId;
+    /**
+     * The URL-friendly identifier for the tag, used in category URLs.
+     */
+    slug: string;
+    /**
+     * The display name of the tag shown to customers.
+     */
+    name: string;
+    /**
+     * A detailed description of the tag's purpose or the category it represents.
+     */
+    description?: string | null;
+    /**
+     * The URL to the tag image.
+     * @example "https://cdn.paynow.gg/logo/full/logotype-color.svg"
+     */
+    image_url?: string | null;
+    /**
+     * Indicates whether the tag is active and should be included in navigation and filtering.
+     */
+    enabled: boolean;
+    /**
+     * The date and time when the tag was created.
+     * @format date-time
+     */
+    created_at: string;
+    /**
+     * The date and time when the tag was last updated, if applicable.
+     * @format date-time
+     */
+    updated_at?: string | null;
+}
+/**
+ * Request headers
+ */
+export type StoreGetStorefrontStoreHeaders = {
+    /**
+     * The IP address (IPv4 or IPv6) of the customer. Required if the request is not being made from the customer's browser.
+     * @format ipv4
+     */
+    "x-paynow-customer-ip"?: string;
+    /**
+     * The customer's country code in ISO 3166-1 alpha-2 format. Optional, but recommended if you have this available.
+     * @pattern ^[A-Z]{2}$
+     */
+    "x-paynow-customer-countrycode"?: string;
+};
+/**
+ * Represents a member of a PayNow store.
+ */
+export interface StoreMemberDto {
+    id: FlakeId;
+    user_id: FlakeId;
+    user: StoreMemberUserDto;
+    /**
+     * The UTC timestamp when the member was added to the store.
+     * @format date-time
+     */
+    added_at?: string | null;
+    added_by?: ActorDto;
+    role_id?: FlakeId;
+}
+/**
+ * Represents identity and profile information for a store member.
+ */
+export interface StoreMemberUserDto {
+    type: PayNowActorType;
+    id: FlakeId;
+    /**
+     * The email address associated with the user.
+     * Only visible if you are the store owner.
+     */
+    email?: string | null;
+    /**
+     * The first name of the actor.
+     * Hidden if the user has a set nickname, and you are not the store owner.
+     */
+    first_name?: string | null;
+    /**
+     * The last name of the actor.
+     * Hidden if the user has a set nickname, and you are not the store owner.
+     */
+    last_name?: string | null;
+    /**
+     * The nickname of the user.
+     */
+    nickname?: string | null;
+}
+/**
+ * Determines the party that needs to perform or requests a verification
+ * - `store`: The associated store
+ * - `paynow`: We as a platform, RequestedByDetail is the admin actor ID in that case (or null if internal)
+ * - `payment_processor`: Payment processor, e.g. Stripe
+ * - `payout_provider`: Payout provider, e.g. Trolley, PayPal
+ * - `kyc_provider`: KYC provider, e.g. Stripe, Onefootprint
+ * - `external`: External party, not fitting in any other category, e.g. government, regulators
+ */
+export type StoreRequirementActionParty = "invalid" | "store" | "paynow" | "payment_processor" | "payout_provider" | "kyc_provider" | "external";
+/**
+ * Represents categories of requirements that must be fulfilled for store setup and compliance in the PayNow platform.
+ * - `invalid`: Invalid or unspecified category. Default value that should not be used in production.
+ * - `business`: Business information and operational requirements.
+            Includes company details, business model, store policies, refund procedures,
+            and operational guidelines for running a store on PayNow.
+ * - `kyc`: Know Your Customer (KYC) identity verification requirements.
+            Includes government-issued ID verification, proof of address, and identity confirmation
+            as per PayNow's KYC Policy and conducted via any third party KYC partners
+ * - `compliance`: Regulatory compliance requirements including AML checks and content policies.
+            Covers sanctions screening, FATF checks, prohibited customer/product screening,
+            and content compliance as defined in PayNow's policies.
+ * - `risk`: Risk management and fraud prevention requirements.
+            Includes transaction monitoring, unusual activity detection, and ongoing
+            risk assessment procedures to protect against fraudulent activities.
+ * - `technical`: Technical integration and setup requirements.
+            Covers API configuration, webhook setup, platform integration, and any technical
+            prerequisites for store operation.
+ * - `financial`: Financial setup and verification requirements.
+            Includes payment processing configuration, banking information, Tipalti/Trolley payout setup,
+            tax documentation (W-9, W-8, etc.), and payment method verification.
+ * - `legal`: Legal agreement and policy acceptance requirements.
+            Covers acceptance of User Agreement, Terms of Service, Privacy Policy,
+            and any other legal documents required by PayNow for store operation.
+ * - `other`: Other miscellaneous requirements that don't fit into the above categories.
+            Used for special cases or additional requirements specific to certain store types
+            or jurisdictions.
+ */
+export type StoreRequirementCategory = "invalid" | "business" | "kyc" | "compliance" | "risk" | "technical" | "financial" | "legal" | "other";
+/**
+ * - `pending`: Requirement created, awaiting action
+ * - `under_review`: Submitted, under review, or awaiting external verification
+ * - `requires_revision`: Rejected, needs store to resubmit with corrections
+ * - `approved`: Requirement successfully fulfilled
+ * - `expired`: Requirement expired and needs renewal
+ * - `waived`: Requirement waived by PayNow (manual override)
+ * - `rejected_final`: Requirement fully rejected - usually terminal state for the entire store
+ */
+export type StoreRequirementStatus = "invalid" | "pending" | "under_review" | "requires_revision" | "approved" | "expired" | "waived" | "rejected_final";
+export type StoreRestrictionFlagDto = "none" | "payments_disabled" | "payouts_disabled";
+export interface StoreTrustDto {
+    store_id: FlakeId;
+    status: StoreTrustStatusDto;
+    status_reason?: string | null;
+    restrictions: StoreRestrictionFlagDto;
+    /**
+     * @format date-time
+     */
+    created_at: string;
+    /**
+     * @format date-time
+     */
+    updated_at?: string | null;
+    onboarding_steps?: StoreTrustOnboardingStepsDto;
+    events: Array<StoreTrustEventDto>;
+    pending_requirements: Array<TrustStoreRequirementDto>;
+}
+export interface StoreTrustEventDto {
+    id: FlakeId;
+    store_id: FlakeId;
+    type: StoreTrustEventTypeDto;
+    description?: string | null;
+    store_requirement_id?: FlakeId;
+    store_review_id?: FlakeId;
+    actor: ActorDto;
+    /**
+     * @format date-time
+     */
+    created_at: string;
+}
+export type 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";
+export interface StoreTrustOnboardingStepsDto {
+    store_id: FlakeId;
+    store_owner_id: FlakeId;
+    payout_onboarding_completed: boolean;
+    kyc_completed: boolean;
+    products_created: boolean;
+    gameserver_linked: boolean;
+    webhooks_active: boolean;
+    downloadable_files_added: boolean;
+}
+export type StoreTrustStatusDto = "invalid" | "pending_review" | "requires_action" | "under_review" | "active" | "restricted" | "offboarded";
+/**
+ * Represents a billing amount breakdown for a subscription.
+ */
+export interface SubscriptionBillingAmountDto {
+    /**
+     * ISO 4217 currency code, in lowercase.
+     */
+    currency: string;
+    /**
+     * Base amount before discounts or tax, in smallest currency units.
+     * @format int64
+     */
+    subtotal: number;
+    /**
+     * Total discount applied, in smallest currency units.
+     * @format int64
+     */
+    discount: number;
+    /**
+     * Tax amount, in smallest currency units.
+     * @format int64
+     */
+    tax: number;
+    /**
+     * Amount due after discounts and tax, in smallest currency units.
+     * @format int64
+     */
+    total: number;
+}
+/**
+ * Pricing breakdown for a subscription change, in the smallest units of the given currency (e.g. cents).
+ */
+export interface SubscriptionChangeAmountDto {
+    /**
+     * ISO 4217 currency code, in lowercase.
+     */
+    currency: string;
+    /**
+     * Base amount before discounts or tax, in smallest currency units.
+     * @format int64
+     */
+    subtotal: number;
+    /**
+     * Total discount applied, in smallest currency units.
+     * @format int64
+     */
+    discount: number;
+    /**
+     * Tax amount, in smallest currency units.
+     * @format int64
+     */
+    tax: number;
+    /**
+     * Amount due after discounts and tax, in smallest currency units.
+     * @format int64
+     */
+    total: number;
+}
+/**
+ * A pending or applied change to a subscription.
+ */
+export interface SubscriptionChangeDto {
+    id: FlakeId;
+    subscription_id: FlakeId;
+    prorated_order_id?: FlakeId;
+    status: SubscriptionChangeStatusDto;
+    proration_behavior: ProrationBehaviorDto;
+    /**
+     * Whether this change was initiated without active customer interaction.
+     */
+    off_session: boolean;
+    prorated_amount: SubscriptionChangeProratedAmountDto;
+    /**
+     * @format date-time
+     */
+    created_at: string;
+    /**
+     * @format date-time
+     */
+    applied_at?: string | null;
+    lines: Array<SubscriptionChangeLineDto>;
+    next_billing_amount: SubscriptionChangeAmountDto;
+    next_billing_presentment_amount: SubscriptionChangeAmountDto;
+}
+/**
+ * Pricing breakdown for a single subscription change line, in the smallest units of the given currency (e.g. cents).
+ */
+export interface SubscriptionChangeLineAmountDto {
+    /**
+     * ISO 4217 currency code in lowercase.
+     */
+    currency: string;
+    /**
+     * Base amount before discounts or tax, in smallest currency units.
+     * @format int64
+     */
+    subtotal: number;
+    /**
+     * Total discount applied, in smallest currency units.
+     * @format int64
+     */
+    discount: number;
+    /**
+     * Tax amount, in smallest currency units.
+     * @format int64
+     */
+    tax: number;
+    /**
+     * Amount due after discounts and tax, in smallest currency units.
+     * @format int64
+     */
+    total: number;
+}
+/**
+ * A single line item within a subscription change.
+ */
+export interface SubscriptionChangeLineDto {
+    id: FlakeId;
+    subscription_line_id?: FlakeId;
+    /**
+     * Whether this line is being removed by the change.
+     */
+    is_deleted: boolean;
+    /**
+     * Whether tax is included in the base price.
+     */
+    tax_inclusive: boolean;
+    /**
+     * Base price in smallest settlement currency units.
+     * @format int64
+     */
+    price: number;
+    product: SubscriptionChangeLineProductDto;
+    amount: SubscriptionChangeLineAmountDto;
+    presentment_amount: SubscriptionChangeLineAmountDto;
+    /**
+     * Prorated charge for this line in smallest settlement currency units.
+     * @format int64
+     */
+    prorated_amount: number;
+    /**
+     * Prorated charge for this line in smallest presentment currency units.
+     * @format int64
+     */
+    prorated_presentment_amount: number;
+    /**
+     * Minutes remaining in the billing period at the time of change - used to calculate proration.
+     * @format int64
+     */
+    remaining_minutes: number;
+    /**
+     * Total minutes in the billing period - used to calculate proration.
+     * @format int64
+     */
+    total_minutes: number;
+}
+/**
+ * The product associated with a subscription change line.
+ */
+export interface SubscriptionChangeLineProductDto {
+    id: FlakeId;
+    version_id: FlakeId;
+    /**
+     * Display name of the product.
+     */
+    name: string;
+    /**
+     * URL of the product image, if set.
+     */
+    image_url?: string | null;
+    selected_gameserver_id?: FlakeId;
+    /**
+     * The pricing region used to determine the price, if applicable.
+     */
+    pricing_region_id?: string | null;
+    /**
+     * Custom variables set on this line item, keyed by variable identifier.
+     */
+    custom_variables: Record<string, CustomVariableLineItemDto>;
+}
+/**
+ * The total prorated charge for a subscription change, expressed in both settlement and presentment currencies.
+ */
+export interface SubscriptionChangeProratedAmountDto {
+    /**
+     * ISO 4217 settlement currency code, in lowercase.
+     */
+    currency: string;
+    /**
+     * Total prorated charge in smallest settlement currency units, including tax.
+     * @format int64
+     */
+    prorated_amount: number;
+    /**
+     * ISO 4217 presentment currency code, in lowercase.
+     */
+    presentment_currency: string;
+    /**
+     * Total prorated charge in smallest presentment currency units, including tax.
+     * @format int64
+     */
+    presentment_prorated_amount: number;
+}
+/**
+ * Represents the status of a subscription change.
+ * - `pending_payment`: The change is pending payment before it can be applied.
+ * - `pending_renewal`: The change will be applied at the next renewal.
+ * - `applied`: The change has been applied to the subscription.
+ * - `canceled`: The change was canceled and will not be applied.
+ * - `pending_verification`: The change requires a verification code sent to the customer's e-mail.
+ */
+export type SubscriptionChangeStatusDto = "invalid" | "pending_payment" | "pending_renewal" | "applied" | "canceled" | "pending_verification";
+/**
+ * Query parameters
+ */
+export type SubscriptionsGetSubscriptionsQuery = {
+    customer_id?: FlakeId;
+    subscription_id?: FlakeId;
+    billing_email?: string;
+    payment_method_id?: FlakeId;
+    checkout_id?: FlakeId;
+    trial_id?: FlakeId;
+    status?: Array<SubscriptionStatusDto>;
+    /**
+     * The maximum number of items to return in a single request.
+     * @format int32
+     * @minimum 1
+     * @maximum 100
+     */
+    limit?: number;
+    /**
+     * Returns items after the specified ID.
+     * Used for forward pagination through results.
+     */
+    after?: FlakeId;
+    /**
+     * Returns items before the specified ID.
+     * Used for backward pagination through results.
+     */
+    before?: FlakeId;
+    /**
+     * Determines the sort order of returned items.
+     * When true, items are returned in ascending order.
+     * When false, items are returned in descending order.
+     */
+    asc?: boolean;
+};
+/**
+ * Represents the current state of a subscription.
+ * - `created`: The subscription has been created but is not yet active.
+ * - `active`: The subscription is currently active and will renew.
+ * - `canceled`: The subscription has been canceled and will no longer renew.
+ */
+export type SubscriptionStatusDto = "invalid" | "created" | "active" | "canceled";
+export interface TrustStoreRequirementDto {
+    id: FlakeId;
+    store_id: FlakeId;
+    /**
+     * Template ID if this requirement was created from a template. Null for ad-hoc requirements.
+     */
+    template_id?: string | null;
+    originating_flag_id?: FlakeId;
+    category: StoreRequirementCategory;
+    /**
+     * Unique code identifying the type of requirement. Copied from template or custom for ad-hoc requirements.
+     */
+    code: string;
+    /**
+     * Human-readable name of the requirement. Copied from template or custom for ad-hoc requirements.
+     */
+    name: string;
+    /**
+     * Detailed description explaining what the store needs to provide. Copied from template or custom for ad-hoc requirements.
+     */
+    description?: string | null;
+    /**
+     * JSON schema defining the form fields, validation rules, and document requirements
+     */
+    schema?: null;
+    /**
+     * Additional metadata for this requirement (stored as JSON)
+     */
+    metadata: Record<string, string>;
+    status: StoreRequirementStatus;
+    requested_by: StoreRequirementActionParty;
+    /**
+     * Specifies the specific requester entity (e.g., "stripe", "trolley", or admin user ID)
+     * Free-form string for internal records
+     */
+    requested_by_detail?: string | null;
+    /**
+     * When this requirement was created
+     * @format date-time
+     */
+    created_at: string;
+    /**
+     * When this requirement was last updated
+     * @format date-time
+     */
+    updated_at?: string | null;
+    /**
+     * When this requirement must be completed by (optional)
+     * @format date-time
+     */
+    deadline_at?: string | null;
+    /**
+     * When the store submitted their response to this requirement
+     * @format date-time
+     */
+    submitted_at?: string | null;
+    /**
+     * When this requirement was verified and approved
+     * @format date-time
+     */
+    verified_at?: string | null;
+    /**
+     * When this requirement was rejected for not meeting standards
+     * @format date-time
+     */
+    rejected_at?: string | null;
+    /**
+     * Store capabilities that are restricted until this requirement is satisfied
+     */
+    restricts_capabilities: Array<string>;
+    /**
+     * Associated submissions for this requriement.
+     */
+    submissions: Array<TrustStoreRequirementSubmissionDto>;
+}
+export interface TrustStoreRequirementSubmissionDto {
+    id: FlakeId;
+    store_id: FlakeId;
+    store_requirement_id: FlakeId;
+    /**
+     * The identifier of the specific field within the store requirement.
+     */
+    store_requirement_field_id: string;
+    /**
+     * The text value submitted for this field, if applicable.
+     */
+    text_value?: string | null;
+    /**
+     * The identifier of the uploaded file, if a file was submitted.
+     */
+    file_id?: string | null;
+    /**
+     * The original name of the uploaded file.
+     */
+    file_name?: string | null;
+    /**
+     * The MIME content type of the uploaded file.
+     */
+    file_content_type?: string | null;
+    /**
+     * The size of the uploaded file in bytes.
+     * @format int64
+     */
+    file_size_bytes?: number | null;
+    /**
+     * The timestamp when this submission was made.
+     * @format date-time
+     */
+    submitted_at: string;
+    submitted_by: ActorDto;
+    /**
+     * The IP address from which the submission was made.
+     */
+    submitted_by_ip_address?: string | null;
+    /**
+     * The user agent string of the client that made the submission.
+     */
+    submitted_by_user_agent?: string | null;
+}
+/**
+ * Response returned after a subscription change is initiated.
+ */
+export interface UpdateSubscriptionResponseDto {
+    subscription_change: SubscriptionChangeDto;
+    pending_payment?: CheckoutPaymentInfoDto;
+}
+export interface UpdateSubscriptionTierRequestDto {
+    target_product_id: FlakeId;
+    /**
+     * A verification code sent to the customer's subscription billing e-mail.
+     * Pass this if the `status` field on the `subscription_change` object equals `pending_verification`.
+     */
+    verification_code?: string | null;
+}
+/**
+ * A validation error.
+ */
+export interface ValidationError {
+    /**
+     * The parseable error code.
+     */
+    code: string;
+    /**
+     * The human-readable error message.
+     */
+    message: string;
+    /**
+     * The path leading to the validation error.
+     */
+    path: string;
+    /**
+     * Type of the validation that failed.
+     */
+    validation: string;
+}
+//# sourceMappingURL=types.d.ts.map