dodopayments 1.49.0__py3-none-any.whl → 1.51.0__py3-none-any.whl

dodopayments/types/__init__.py

@@ -15,28 +15,23 @@ from .get_dispute import GetDispute as GetDispute
 from .license_key import LicenseKey as LicenseKey
 from .price_param import PriceParam as PriceParam
 from .country_code import CountryCode as CountryCode
-from .refund_param import RefundParam as RefundParam
 from .subscription import Subscription as Subscription
 from .tax_category import TaxCategory as TaxCategory
 from .discount_type import DiscountType as DiscountType
-from .dispute_param import DisputeParam as DisputeParam
 from .dispute_stage import DisputeStage as DisputeStage
 from .intent_status import IntentStatus as IntentStatus
-from .payment_param import PaymentParam as PaymentParam
 from .refund_status import RefundStatus as RefundStatus
 from .time_interval import TimeInterval as TimeInterval
 from .addon_response import AddonResponse as AddonResponse
 from .dispute_status import DisputeStatus as DisputeStatus
 from .billing_address import BillingAddress as BillingAddress
+from .webhook_details import WebhookDetails as WebhookDetails
 from .addon_list_params import AddonListParams as AddonListParams
-from .get_dispute_param import GetDisputeParam as GetDisputeParam
-from .license_key_param import LicenseKeyParam as LicenseKeyParam
 from .attach_addon_param import AttachAddonParam as AttachAddonParam
 from .license_key_status import LicenseKeyStatus as LicenseKeyStatus
 from .new_customer_param import NewCustomerParam as NewCustomerParam
 from .payout_list_params import PayoutListParams as PayoutListParams
 from .refund_list_params import RefundListParams as RefundListParams
-from .subscription_param import SubscriptionParam as SubscriptionParam
 from .webhook_event_type import WebhookEventType as WebhookEventType
 from .addon_create_params import AddonCreateParams as AddonCreateParams
 from .addon_update_params import AddonUpdateParams as AddonUpdateParams
@@ -63,7 +58,6 @@ from .product_create_params import ProductCreateParams as ProductCreateParams
 from .product_list_response import ProductListResponse as ProductListResponse
 from .product_update_params import ProductUpdateParams as ProductUpdateParams
 from .webhook_create_params import WebhookCreateParams as WebhookCreateParams
-from .webhook_list_response import WebhookListResponse as WebhookListResponse
 from .webhook_update_params import WebhookUpdateParams as WebhookUpdateParams
 from .customer_create_params import CustomerCreateParams as CustomerCreateParams
 from .customer_request_param import CustomerRequestParam as CustomerRequestParam
@@ -75,15 +69,13 @@ from .license_activate_params import LicenseActivateParams as LicenseActivatePar
 from .license_key_list_params import LicenseKeyListParams as LicenseKeyListParams
 from .license_validate_params import LicenseValidateParams as LicenseValidateParams
 from .payment_create_response import PaymentCreateResponse as PaymentCreateResponse
-from .webhook_create_response import WebhookCreateResponse as WebhookCreateResponse
-from .webhook_update_response import WebhookUpdateResponse as WebhookUpdateResponse
 from .addon_cart_response_item import AddonCartResponseItem as AddonCartResponseItem
 from .customer_limited_details import CustomerLimitedDetails as CustomerLimitedDetails
 from .subscription_list_params import SubscriptionListParams as SubscriptionListParams
+from .checkout_session_response import CheckoutSessionResponse as CheckoutSessionResponse
 from .license_deactivate_params import LicenseDeactivateParams as LicenseDeactivateParams
 from .license_key_update_params import LicenseKeyUpdateParams as LicenseKeyUpdateParams
 from .license_validate_response import LicenseValidateResponse as LicenseValidateResponse
-from .webhook_retrieve_response import WebhookRetrieveResponse as WebhookRetrieveResponse
 from .license_key_duration_param import LicenseKeyDurationParam as LicenseKeyDurationParam
 from .one_time_product_cart_item import OneTimeProductCartItem as OneTimeProductCartItem
 from .subscription_charge_params import SubscriptionChargeParams as SubscriptionChargeParams
@@ -93,13 +85,12 @@ from .subscription_update_params import SubscriptionUpdateParams as Subscription
 from .product_update_files_params import ProductUpdateFilesParams as ProductUpdateFilesParams
 from .addon_update_images_response import AddonUpdateImagesResponse as AddonUpdateImagesResponse
 from .brand_update_images_response import BrandUpdateImagesResponse as BrandUpdateImagesResponse
+from .on_demand_subscription_param import OnDemandSubscriptionParam as OnDemandSubscriptionParam
 from .subscription_charge_response import SubscriptionChargeResponse as SubscriptionChargeResponse
 from .subscription_create_response import SubscriptionCreateResponse as SubscriptionCreateResponse
 from .product_update_files_response import ProductUpdateFilesResponse as ProductUpdateFilesResponse
-from .addon_cart_response_item_param import AddonCartResponseItemParam as AddonCartResponseItemParam
 from .attach_existing_customer_param import AttachExistingCustomerParam as AttachExistingCustomerParam
-from .customer_limited_details_param import CustomerLimitedDetailsParam as CustomerLimitedDetailsParam
-from .your_webhook_url_create_params import YourWebhookURLCreateParams as YourWebhookURLCreateParams
+from .checkout_session_create_params import CheckoutSessionCreateParams as CheckoutSessionCreateParams
 from .subscription_change_plan_params import SubscriptionChangePlanParams as SubscriptionChangePlanParams
 from .license_key_instance_list_params import LicenseKeyInstanceListParams as LicenseKeyInstanceListParams
 from .one_time_product_cart_item_param import OneTimeProductCartItemParam as OneTimeProductCartItemParam

dodopayments/types/checkout_session_create_params.py

@@ -0,0 +1,174 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict, List, Iterable, Optional
+from typing_extensions import Literal, Required, TypedDict
+
+from .currency import Currency
+from .country_code import CountryCode
+from .attach_addon_param import AttachAddonParam
+from .payment_method_types import PaymentMethodTypes
+from .customer_request_param import CustomerRequestParam
+from .on_demand_subscription_param import OnDemandSubscriptionParam
+
+__all__ = [
+    "CheckoutSessionCreateParams",
+    "ProductCart",
+    "BillingAddress",
+    "Customization",
+    "FeatureFlags",
+    "SubscriptionData",
+]
+
+
+class CheckoutSessionCreateParams(TypedDict, total=False):
+    product_cart: Required[Iterable[ProductCart]]
+
+    allowed_payment_method_types: Optional[List[PaymentMethodTypes]]
+    """
+    Customers will never see payment methods that are not in this list. However,
+    adding a method here does not guarantee customers will see it. Availability
+    still depends on other factors (e.g., customer location, merchant settings).
+
+    Disclaimar: Always provide 'credit' and 'debit' as a fallback. If all payment
+    methods are unavailable, checkout session will fail.
+    """
+
+    billing_address: Optional[BillingAddress]
+    """Billing address information for the session"""
+
+    billing_currency: Optional[Currency]
+    """This field is ingored if adaptive pricing is disabled"""
+
+    confirm: bool
+    """If confirm is true, all the details will be finalized.
+
+    If required data is missing, an API error is thrown.
+    """
+
+    customer: Optional[CustomerRequestParam]
+    """Customer details for the session"""
+
+    customization: Customization
+    """Customization for the checkout session page"""
+
+    discount_code: Optional[str]
+
+    feature_flags: FeatureFlags
+
+    metadata: Optional[Dict[str, str]]
+    """Additional metadata associated with the payment.
+
+    Defaults to empty if not provided.
+    """
+
+    return_url: Optional[str]
+    """The url to redirect after payment failure or success."""
+
+    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):
+    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 Customization(TypedDict, total=False):
+    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
+
+    Default is `System`.
+    """
+
+
+class FeatureFlags(TypedDict, total=False):
+    allow_currency_selection: bool
+    """if customer is allowed to change currency, set it to true
+
+    Default is true
+    """
+
+    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
+    """
+
+
+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
+    """

dodopayments/types/checkout_session_response.py

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from .._models import BaseModel
+
+__all__ = ["CheckoutSessionResponse"]
+
+
+class CheckoutSessionResponse(BaseModel):
+    checkout_url: str
+    """Checkout url"""
+
+    session_id: str
+    """The ID of the created checkout session"""

dodopayments/types/on_demand_subscription_param.py

@@ -0,0 +1,44 @@
+# 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 Required, TypedDict
+
+from .currency import Currency
+
+__all__ = ["OnDemandSubscriptionParam"]
+
+
+class OnDemandSubscriptionParam(TypedDict, total=False):
+    mandate_only: Required[bool]
+    """
+    If set as True, does not perform any charge and only authorizes payment method
+    details for future use.
+    """
+
+    adaptive_currency_fees_inclusive: Optional[bool]
+    """
+    Whether adaptive currency fees should be included in the product_price (true) or
+    added on top (false). This field is ignored if adaptive pricing is not enabled
+    for the business.
+    """
+
+    product_currency: Optional[Currency]
+    """Optional currency of the product price.
+
+    If not specified, defaults to the currency of the product.
+    """
+
+    product_description: Optional[str]
+    """
+    Optional product description override for billing and line items. If not
+    specified, the stored description of the product will be used.
+    """
+
+    product_price: Optional[int]
+    """
+    Product price for the initial charge to customer If not specified the stored
+    price of the product will be used Represented in the lowest denomination of the
+    currency (e.g., cents for USD). For example, to charge $1.00, pass `100`.
+    """

dodopayments/types/subscription.py

@@ -92,3 +92,6 @@ class Subscription(BaseModel):
 
     discount_id: Optional[str] = None
     """The discount id if discount is applied"""
+
+    expires_at: Optional[datetime] = None
+    """Timestamp when the subscription will expire"""

dodopayments/types/subscription_create_params.py

@@ -10,8 +10,9 @@ from .attach_addon_param import AttachAddonParam
 from .payment_method_types import PaymentMethodTypes
 from .billing_address_param import BillingAddressParam
 from .customer_request_param import CustomerRequestParam
+from .on_demand_subscription_param import OnDemandSubscriptionParam
 
-__all__ = ["SubscriptionCreateParams", "OnDemand"]
+__all__ = ["SubscriptionCreateParams"]
 
 
 class SubscriptionCreateParams(TypedDict, total=False):
@@ -51,7 +52,7 @@ class SubscriptionCreateParams(TypedDict, total=False):
     metadata: Dict[str, str]
     """Additional metadata for the subscription Defaults to empty if not specified"""
 
-    on_demand: Optional[OnDemand]
+    on_demand: Optional[OnDemandSubscriptionParam]
 
     payment_link: Optional[bool]
     """If true, generates a payment link. Defaults to false if not specified."""
@@ -73,37 +74,3 @@ class SubscriptionCreateParams(TypedDict, total=False):
     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
     """
-
-
-class OnDemand(TypedDict, total=False):
-    mandate_only: Required[bool]
-    """
-    If set as True, does not perform any charge and only authorizes payment method
-    details for future use.
-    """
-
-    adaptive_currency_fees_inclusive: Optional[bool]
-    """
-    Whether adaptive currency fees should be included in the product_price (true) or
-    added on top (false). This field is ignored if adaptive pricing is not enabled
-    for the business.
-    """
-
-    product_currency: Optional[Currency]
-    """Optional currency of the product price.
-
-    If not specified, defaults to the currency of the product.
-    """
-
-    product_description: Optional[str]
-    """
-    Optional product description override for billing and line items. If not
-    specified, the stored description of the product will be used.
-    """
-
-    product_price: Optional[int]
-    """
-    Product price for the initial charge to customer If not specified the stored
-    price of the product will be used Represented in the lowest denomination of the
-    currency (e.g., cents for USD). For example, to charge $1.00, pass `100`.
-    """

dodopayments/types/subscription_update_params.py

@@ -17,6 +17,7 @@ class SubscriptionUpdateParams(TypedDict, total=False):
     billing: Optional[BillingAddressParam]
 
     cancel_at_next_billing_date: Optional[bool]
+    """When set, the subscription will remain active until the end of billing period"""
 
     disable_on_demand: Optional[DisableOnDemand]
 

dodopayments/types/{webhook_list_response.py → webhook_details.py}

@@ -4,10 +4,10 @@ from typing import Dict, List, Optional
 
 from .._models import BaseModel
 
-__all__ = ["WebhookListResponse"]
+__all__ = ["WebhookDetails"]
 
 
-class WebhookListResponse(BaseModel):
+class WebhookDetails(BaseModel):
     id: str
     """The webhook's ID."""
 

{dodopayments-1.49.0.dist-info → dodopayments-1.51.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: dodopayments
-Version: 1.49.0
+Version: 1.51.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
@@ -69,15 +69,7 @@ client = DodoPayments(
     environment="test_mode",
 )
 
-payment = client.payments.create(
-    billing={
-        "city": "city",
-        "country": "AF",
-        "state": "state",
-        "street": "street",
-        "zipcode": "zipcode",
-    },
-    customer={"customer_id": "customer_id"},
+checkout_session_response = client.checkout_sessions.create(
     product_cart=[
         {
             "product_id": "product_id",
@@ -85,7 +77,7 @@ payment = client.payments.create(
         }
     ],
 )
-print(payment.payment_id)
+print(checkout_session_response.session_id)
 ```
 
 While you can provide a `bearer_token` keyword argument,
@@ -110,15 +102,7 @@ client = AsyncDodoPayments(
 
 
 async def main() -> None:
-    payment = await client.payments.create(
-        billing={
-            "city": "city",
-            "country": "AF",
-            "state": "state",
-            "street": "street",
-            "zipcode": "zipcode",
-        },
-        customer={"customer_id": "customer_id"},
+    checkout_session_response = await client.checkout_sessions.create(
         product_cart=[
             {
                 "product_id": "product_id",
@@ -126,7 +110,7 @@ async def main() -> None:
             }
         ],
     )
-    print(payment.payment_id)
+    print(checkout_session_response.session_id)
 
 
 asyncio.run(main())
@@ -158,15 +142,7 @@ async def main() -> None:
         bearer_token="My Bearer Token",
         http_client=DefaultAioHttpClient(),
     ) as client:
-        payment = await client.payments.create(
-            billing={
-                "city": "city",
-                "country": "AF",
-                "state": "state",
-                "street": "street",
-                "zipcode": "zipcode",
-            },
-            customer={"customer_id": "customer_id"},
+        checkout_session_response = await client.checkout_sessions.create(
             product_cart=[
                 {
                     "product_id": "product_id",
@@ -174,7 +150,7 @@ async def main() -> None:
                 }
             ],
         )
-        print(payment.payment_id)
+        print(checkout_session_response.session_id)
 
 
 asyncio.run(main())
@@ -259,23 +235,16 @@ from dodopayments import DodoPayments
 
 client = DodoPayments()
 
-payment = client.payments.create(
-    billing={
-        "city": "city",
-        "country": "AF",
-        "state": "state",
-        "street": "street",
-        "zipcode": "zipcode",
-    },
-    customer={"customer_id": "customer_id"},
+checkout_session_response = client.checkout_sessions.create(
     product_cart=[
         {
             "product_id": "product_id",
             "quantity": 0,
         }
     ],
+    billing_address={"country": "AF"},
 )
-print(payment.billing)
+print(checkout_session_response.billing_address)
 ```
 
 ## Handling errors
@@ -294,15 +263,7 @@ from dodopayments import DodoPayments
 client = DodoPayments()
 
 try:
-    client.payments.create(
-        billing={
-            "city": "city",
-            "country": "AF",
-            "state": "state",
-            "street": "street",
-            "zipcode": "zipcode",
-        },
-        customer={"customer_id": "customer_id"},
+    client.checkout_sessions.create(
         product_cart=[
             {
                 "product_id": "product_id",
@@ -352,15 +313,7 @@ client = DodoPayments(
 )
 
 # Or, configure per-request:
-client.with_options(max_retries=5).payments.create(
-    billing={
-        "city": "city",
-        "country": "AF",
-        "state": "state",
-        "street": "street",
-        "zipcode": "zipcode",
-    },
-    customer={"customer_id": "customer_id"},
+client.with_options(max_retries=5).checkout_sessions.create(
     product_cart=[
         {
             "product_id": "product_id",
@@ -390,15 +343,7 @@ client = DodoPayments(
 )
 
 # Override per-request:
-client.with_options(timeout=5.0).payments.create(
-    billing={
-        "city": "city",
-        "country": "AF",
-        "state": "state",
-        "street": "street",
-        "zipcode": "zipcode",
-    },
-    customer={"customer_id": "customer_id"},
+client.with_options(timeout=5.0).checkout_sessions.create(
     product_cart=[
         {
             "product_id": "product_id",
@@ -446,17 +391,7 @@ The "raw" Response object can be accessed by prefixing `.with_raw_response.` to
 from dodopayments import DodoPayments
 
 client = DodoPayments()
-response = client.payments.with_raw_response.create(
-    billing={
-        "city": "city",
-        "country": "AF",
-        "state": "state",
-        "street": "street",
-        "zipcode": "zipcode",
-    },
-    customer={
-        "customer_id": "customer_id"
-    },
+response = client.checkout_sessions.with_raw_response.create(
     product_cart=[{
         "product_id": "product_id",
         "quantity": 0,
@@ -464,8 +399,8 @@ response = client.payments.with_raw_response.create(
 )
 print(response.headers.get('X-My-Header'))
 
-payment = response.parse()  # get the object that `payments.create()` would have returned
-print(payment.payment_id)
+checkout_session = response.parse()  # get the object that `checkout_sessions.create()` would have returned
+print(checkout_session.session_id)
 ```
 
 These methods return an [`APIResponse`](https://github.com/dodopayments/dodopayments-python/tree/main/src/dodopayments/_response.py) object.
@@ -479,15 +414,7 @@ The above interface eagerly reads the full response body when you make the reque
 To stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.
 
 ```python
-with client.payments.with_streaming_response.create(
-    billing={
-        "city": "city",
-        "country": "AF",
-        "state": "state",
-        "street": "street",
-        "zipcode": "zipcode",
-    },
-    customer={"customer_id": "customer_id"},
+with client.checkout_sessions.with_streaming_response.create(
     product_cart=[
         {
             "product_id": "product_id",