dodopayments 1.78.0__py3-none-any.whl → 1.81.0__py3-none-any.whl

dodopayments/types/checkout_session_preview_params.py

@@ -3,32 +3,23 @@
 from __future__ import annotations
 
 from typing import Dict, List, Iterable, Optional
-from typing_extensions import Literal, Required, TypedDict
+from typing_extensions import Required, TypedDict
 
-from .._types import SequenceNotStr
 from .currency import Currency
-from .country_code import CountryCode
-from .attach_addon_param import AttachAddonParam
+from .custom_field_param import CustomFieldParam
 from .payment_method_types import PaymentMethodTypes
 from .customer_request_param import CustomerRequestParam
-from .on_demand_subscription_param import OnDemandSubscriptionParam
+from .product_item_req_param import ProductItemReqParam
+from .subscription_data_param import SubscriptionDataParam
+from .checkout_session_flags_param import CheckoutSessionFlagsParam
+from .checkout_session_customization_param import CheckoutSessionCustomizationParam
+from .checkout_session_billing_address_param import CheckoutSessionBillingAddressParam
 
-__all__ = [
-    "CheckoutSessionPreviewParams",
-    "ProductCart",
-    "BillingAddress",
-    "CustomField",
-    "Customization",
-    "CustomizationThemeConfig",
-    "CustomizationThemeConfigDark",
-    "CustomizationThemeConfigLight",
-    "FeatureFlags",
-    "SubscriptionData",
-]
+__all__ = ["CheckoutSessionPreviewParams"]
 
 
 class CheckoutSessionPreviewParams(TypedDict, total=False):
-    product_cart: Required[Iterable[ProductCart]]
+    product_cart: Required[Iterable[ProductItemReqParam]]
 
     allowed_payment_method_types: Optional[List[PaymentMethodTypes]]
     """
@@ -40,7 +31,7 @@ class CheckoutSessionPreviewParams(TypedDict, total=False):
     methods are unavailable, checkout session will fail.
     """
 
-    billing_address: Optional[BillingAddress]
+    billing_address: Optional[CheckoutSessionBillingAddressParam]
     """Billing address information for the session"""
 
     billing_currency: Optional[Currency]
@@ -52,18 +43,18 @@ class CheckoutSessionPreviewParams(TypedDict, total=False):
     If required data is missing, an API error is thrown.
     """
 
-    custom_fields: Optional[Iterable[CustomField]]
+    custom_fields: Optional[Iterable[CustomFieldParam]]
     """Custom fields to collect from customer during checkout (max 5 fields)"""
 
     customer: Optional[CustomerRequestParam]
     """Customer details for the session"""
 
-    customization: Customization
+    customization: CheckoutSessionCustomizationParam
     """Customization for the checkout session page"""
 
     discount_code: Optional[str]
 
-    feature_flags: FeatureFlags
+    feature_flags: CheckoutSessionFlagsParam
 
     force_3ds: Optional[bool]
     """Override merchant default 3DS behaviour for this session"""
@@ -98,290 +89,4 @@ class CheckoutSessionPreviewParams(TypedDict, total=False):
     show_saved_payment_methods: bool
     """Display saved payment methods of a returning customer False by default"""
 
-    subscription_data: Optional[SubscriptionData]
-
-
-class ProductCart(TypedDict, total=False):
-    product_id: Required[str]
-    """unique id of the product"""
-
-    quantity: Required[int]
-
-    addons: Optional[Iterable[AttachAddonParam]]
-    """only valid if product is a subscription"""
-
-    amount: Optional[int]
-    """Amount the customer pays if pay_what_you_want is enabled.
-
-    If disabled then amount will be ignored Represented in the lowest denomination
-    of the currency (e.g., cents for USD). For example, to charge $1.00, pass `100`.
-    Only applicable for one time payments
-
-    If amount is not set for pay_what_you_want product, customer is allowed to
-    select the amount.
-    """
-
-
-class BillingAddress(TypedDict, total=False):
-    """Billing address information for the session"""
-
-    country: Required[CountryCode]
-    """Two-letter ISO country code (ISO 3166-1 alpha-2)"""
-
-    city: Optional[str]
-    """City name"""
-
-    state: Optional[str]
-    """State or province name"""
-
-    street: Optional[str]
-    """Street address including house number and unit/apartment if applicable"""
-
-    zipcode: Optional[str]
-    """Postal code or ZIP code"""
-
-
-class CustomField(TypedDict, total=False):
-    """Definition of a custom field for checkout"""
-
-    field_type: Required[Literal["text", "number", "email", "url", "date", "dropdown", "boolean"]]
-    """Type of field determining validation rules"""
-
-    key: Required[str]
-    """Unique identifier for this field (used as key in responses)"""
-
-    label: Required[str]
-    """Display label shown to customer"""
-
-    options: Optional[SequenceNotStr[str]]
-    """Options for dropdown type (required for dropdown, ignored for others)"""
-
-    placeholder: Optional[str]
-    """Placeholder text for the input"""
-
-    required: bool
-    """Whether this field is required"""
-
-
-class CustomizationThemeConfigDark(TypedDict, total=False):
-    """Dark mode color configuration"""
-
-    bg_primary: Optional[str]
-    """Background primary color
-
-    Examples: `"#ffffff"`, `"rgb(255, 255, 255)"`, `"white"`
-    """
-
-    bg_secondary: Optional[str]
-    """Background secondary color"""
-
-    border_primary: Optional[str]
-    """Border primary color"""
-
-    border_secondary: Optional[str]
-    """Border secondary color"""
-
-    button_primary: Optional[str]
-    """Primary button background color"""
-
-    button_primary_hover: Optional[str]
-    """Primary button hover color"""
-
-    button_secondary: Optional[str]
-    """Secondary button background color"""
-
-    button_secondary_hover: Optional[str]
-    """Secondary button hover color"""
-
-    button_text_primary: Optional[str]
-    """Primary button text color"""
-
-    button_text_secondary: Optional[str]
-    """Secondary button text color"""
-
-    input_focus_border: Optional[str]
-    """Input focus border color"""
-
-    text_error: Optional[str]
-    """Text error color"""
-
-    text_placeholder: Optional[str]
-    """Text placeholder color"""
-
-    text_primary: Optional[str]
-    """Text primary color"""
-
-    text_secondary: Optional[str]
-    """Text secondary color"""
-
-    text_success: Optional[str]
-    """Text success color"""
-
-
-class CustomizationThemeConfigLight(TypedDict, total=False):
-    """Light mode color configuration"""
-
-    bg_primary: Optional[str]
-    """Background primary color
-
-    Examples: `"#ffffff"`, `"rgb(255, 255, 255)"`, `"white"`
-    """
-
-    bg_secondary: Optional[str]
-    """Background secondary color"""
-
-    border_primary: Optional[str]
-    """Border primary color"""
-
-    border_secondary: Optional[str]
-    """Border secondary color"""
-
-    button_primary: Optional[str]
-    """Primary button background color"""
-
-    button_primary_hover: Optional[str]
-    """Primary button hover color"""
-
-    button_secondary: Optional[str]
-    """Secondary button background color"""
-
-    button_secondary_hover: Optional[str]
-    """Secondary button hover color"""
-
-    button_text_primary: Optional[str]
-    """Primary button text color"""
-
-    button_text_secondary: Optional[str]
-    """Secondary button text color"""
-
-    input_focus_border: Optional[str]
-    """Input focus border color"""
-
-    text_error: Optional[str]
-    """Text error color"""
-
-    text_placeholder: Optional[str]
-    """Text placeholder color"""
-
-    text_primary: Optional[str]
-    """Text primary color"""
-
-    text_secondary: Optional[str]
-    """Text secondary color"""
-
-    text_success: Optional[str]
-    """Text success color"""
-
-
-class CustomizationThemeConfig(TypedDict, total=False):
-    """Optional custom theme configuration with colors for light and dark modes"""
-
-    dark: Optional[CustomizationThemeConfigDark]
-    """Dark mode color configuration"""
-
-    font_size: Optional[Literal["xs", "sm", "md", "lg", "xl", "2xl"]]
-    """Font size for the checkout UI"""
-
-    font_weight: Optional[Literal["normal", "medium", "bold", "extraBold"]]
-    """Font weight for the checkout UI"""
-
-    light: Optional[CustomizationThemeConfigLight]
-    """Light mode color configuration"""
-
-    pay_button_text: Optional[str]
-    """Custom text for the pay button (e.g., "Complete Purchase", "Subscribe Now")"""
-
-    radius: Optional[str]
-    """Border radius for UI elements (e.g., "4px", "0.5rem", "8px")"""
-
-
-class Customization(TypedDict, total=False):
-    """Customization for the checkout session page"""
-
-    force_language: Optional[str]
-    """Force the checkout interface to render in a specific language (e.g. `en`, `es`)"""
-
-    show_on_demand_tag: bool
-    """Show on demand tag
-
-    Default is true
-    """
-
-    show_order_details: bool
-    """Show order details by default
-
-    Default is true
-    """
-
-    theme: Literal["dark", "light", "system"]
-    """Theme of the page (determines which mode - light/dark/system - to use)
-
-    Default is `System`.
-    """
-
-    theme_config: Optional[CustomizationThemeConfig]
-    """Optional custom theme configuration with colors for light and dark modes"""
-
-
-class FeatureFlags(TypedDict, total=False):
-    allow_currency_selection: bool
-    """if customer is allowed to change currency, set it to true
-
-    Default is true
-    """
-
-    allow_customer_editing_city: bool
-
-    allow_customer_editing_country: bool
-
-    allow_customer_editing_email: bool
-
-    allow_customer_editing_name: bool
-
-    allow_customer_editing_state: bool
-
-    allow_customer_editing_street: bool
-
-    allow_customer_editing_zipcode: bool
-
-    allow_discount_code: bool
-    """If the customer is allowed to apply discount code, set it to true.
-
-    Default is true
-    """
-
-    allow_phone_number_collection: bool
-    """If phone number is collected from customer, set it to rue
-
-    Default is true
-    """
-
-    allow_tax_id: bool
-    """If the customer is allowed to add tax id, set it to true
-
-    Default is true
-    """
-
-    always_create_new_customer: bool
-    """
-    Set to true if a new customer object should be created. By default email is used
-    to find an existing customer to attach the session to
-
-    Default is false
-    """
-
-    redirect_immediately: bool
-    """If true, redirects the customer immediately after payment completion
-
-    Default is false
-    """
-
-
-class SubscriptionData(TypedDict, total=False):
-    on_demand: Optional[OnDemandSubscriptionParam]
-
-    trial_period_days: Optional[int]
-    """
-    Optional trial period in days If specified, this value overrides the trial
-    period set in the product's price Must be between 0 and 10000 days
-    """
+    subscription_data: Optional[SubscriptionDataParam]

dodopayments/types/custom_field_param.py

@@ -0,0 +1,32 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import Literal, Required, TypedDict
+
+from .._types import SequenceNotStr
+
+__all__ = ["CustomFieldParam"]
+
+
+class CustomFieldParam(TypedDict, total=False):
+    """Definition of a custom field for checkout"""
+
+    field_type: Required[Literal["text", "number", "email", "url", "date", "dropdown", "boolean"]]
+    """Type of field determining validation rules"""
+
+    key: Required[str]
+    """Unique identifier for this field (used as key in responses)"""
+
+    label: Required[str]
+    """Display label shown to customer"""
+
+    options: Optional[SequenceNotStr[str]]
+    """Options for dropdown type (required for dropdown, ignored for others)"""
+
+    placeholder: Optional[str]
+    """Placeholder text for the input"""
+
+    required: bool
+    """Whether this field is required"""

dodopayments/types/payment.py

@@ -2,6 +2,7 @@
 
 from typing import Dict, List, Optional
 from datetime import datetime
+from typing_extensions import Literal
 
 from .dispute import Dispute
 from .._models import BaseModel
@@ -165,6 +166,12 @@ class Payment(BaseModel):
     product_cart: Optional[List[ProductCart]] = None
     """List of products purchased in a one-time payment"""
 
+    refund_status: Optional[Literal["partial", "full"]] = None
+    """Summary of the refund status for this payment.
+
+    None if no succeeded refunds exist.
+    """
+
     settlement_tax: Optional[int] = None
     """
     This represents the portion of settlement_amount that corresponds to taxes

dodopayments/types/product_item_req_param.py

@@ -0,0 +1,31 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Iterable, Optional
+from typing_extensions import Required, TypedDict
+
+from .attach_addon_param import AttachAddonParam
+
+__all__ = ["ProductItemReqParam"]
+
+
+class ProductItemReqParam(TypedDict, total=False):
+    product_id: Required[str]
+    """unique id of the product"""
+
+    quantity: Required[int]
+
+    addons: Optional[Iterable[AttachAddonParam]]
+    """only valid if product is a subscription"""
+
+    amount: Optional[int]
+    """Amount the customer pays if pay_what_you_want is enabled.
+
+    If disabled then amount will be ignored Represented in the lowest denomination
+    of the currency (e.g., cents for USD). For example, to charge $1.00, pass `100`.
+    Only applicable for one time payments
+
+    If amount is not set for pay_what_you_want product, customer is allowed to
+    select the amount.
+    """

dodopayments/types/subscription_change_plan_params.py

@@ -31,3 +31,13 @@ class SubscriptionChangePlanParams(TypedDict, total=False):
 
     If not passed, the metadata of the subscription will be taken
     """
+
+    on_payment_failure: Optional[Literal["prevent_change", "apply_change"]]
+    """Controls behavior when the plan change payment fails.
+
+    - `prevent_change`: Keep subscription on current plan until payment succeeds
+    - `apply_change` (default): Apply plan change immediately regardless of payment
+      outcome
+
+    If not specified, uses the business-level default setting.
+    """

dodopayments/types/subscription_data_param.py

@@ -0,0 +1,20 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import TypedDict
+
+from .on_demand_subscription_param import OnDemandSubscriptionParam
+
+__all__ = ["SubscriptionDataParam"]
+
+
+class SubscriptionDataParam(TypedDict, total=False):
+    on_demand: Optional[OnDemandSubscriptionParam]
+
+    trial_period_days: Optional[int]
+    """
+    Optional trial period in days If specified, this value overrides the trial
+    period set in the product's price Must be between 0 and 10000 days
+    """

dodopayments/types/subscription_preview_change_plan_params.py

@@ -31,3 +31,13 @@ class SubscriptionPreviewChangePlanParams(TypedDict, total=False):
 
     If not passed, the metadata of the subscription will be taken
     """
+
+    on_payment_failure: Optional[Literal["prevent_change", "apply_change"]]
+    """Controls behavior when the plan change payment fails.
+
+    - `prevent_change`: Keep subscription on current plan until payment succeeds
+    - `apply_change` (default): Apply plan change immediately regardless of payment
+      outcome
+
+    If not specified, uses the business-level default setting.
+    """

dodopayments/types/theme_config_param.py

@@ -0,0 +1,38 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import Literal, TypedDict
+
+from .theme_mode_config_param import ThemeModeConfigParam
+
+__all__ = ["ThemeConfigParam"]
+
+
+class ThemeConfigParam(TypedDict, total=False):
+    """Custom theme configuration with colors for light and dark modes."""
+
+    dark: Optional[ThemeModeConfigParam]
+    """Dark mode color configuration"""
+
+    font_primary_url: Optional[str]
+    """URL for the primary font"""
+
+    font_secondary_url: Optional[str]
+    """URL for the secondary font"""
+
+    font_size: Optional[Literal["xs", "sm", "md", "lg", "xl", "2xl"]]
+    """Font size for the checkout UI"""
+
+    font_weight: Optional[Literal["normal", "medium", "bold", "extraBold"]]
+    """Font weight for the checkout UI"""
+
+    light: Optional[ThemeModeConfigParam]
+    """Light mode color configuration"""
+
+    pay_button_text: Optional[str]
+    """Custom text for the pay button (e.g., "Complete Purchase", "Subscribe Now")"""
+
+    radius: Optional[str]
+    """Border radius for UI elements (e.g., "4px", "0.5rem", "8px")"""

dodopayments/types/theme_mode_config_param.py

@@ -0,0 +1,71 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import TypedDict
+
+__all__ = ["ThemeModeConfigParam"]
+
+
+class ThemeModeConfigParam(TypedDict, total=False):
+    """Color configuration for a single theme mode (light or dark).
+
+    All color fields accept standard CSS color formats:
+    - Hex: `#fff`, `#ffffff`, `#ffffffff` (with or without # prefix)
+    - RGB/RGBA: `rgb(255, 255, 255)`, `rgba(255, 255, 255, 0.5)`
+    - HSL/HSLA: `hsl(120, 100%, 50%)`, `hsla(120, 100%, 50%, 0.5)`
+    - Named colors: `red`, `blue`, `transparent`, etc.
+    - Advanced: `hwb()`, `lab()`, `lch()`, `oklab()`, `oklch()`, `color()`
+    """
+
+    bg_primary: Optional[str]
+    """Background primary color
+
+    Examples: `"#ffffff"`, `"rgb(255, 255, 255)"`, `"white"`
+    """
+
+    bg_secondary: Optional[str]
+    """Background secondary color"""
+
+    border_primary: Optional[str]
+    """Border primary color"""
+
+    border_secondary: Optional[str]
+    """Border secondary color"""
+
+    button_primary: Optional[str]
+    """Primary button background color"""
+
+    button_primary_hover: Optional[str]
+    """Primary button hover color"""
+
+    button_secondary: Optional[str]
+    """Secondary button background color"""
+
+    button_secondary_hover: Optional[str]
+    """Secondary button hover color"""
+
+    button_text_primary: Optional[str]
+    """Primary button text color"""
+
+    button_text_secondary: Optional[str]
+    """Secondary button text color"""
+
+    input_focus_border: Optional[str]
+    """Input focus border color"""
+
+    text_error: Optional[str]
+    """Text error color"""
+
+    text_placeholder: Optional[str]
+    """Text placeholder color"""
+
+    text_primary: Optional[str]
+    """Text primary color"""
+
+    text_secondary: Optional[str]
+    """Text secondary color"""
+
+    text_success: Optional[str]
+    """Text success color"""

{dodopayments-1.78.0.dist-info → dodopayments-1.81.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: dodopayments
-Version: 1.78.0
+Version: 1.81.0
 Summary: The official Python library for the Dodo Payments API
 Project-URL: Homepage, https://github.com/dodopayments/dodopayments-python
 Project-URL: Repository, https://github.com/dodopayments/dodopayments-python