dodopayments 1.19.0__py3-none-any.whl → 1.20.0__py3-none-any.whl

dodopayments/resources/subscriptions.py

@@ -2,13 +2,14 @@
 
 from __future__ import annotations
 
-from typing import Dict, List, Union, Optional
+from typing import Dict, List, Union, Iterable, Optional
 from datetime import datetime
 from typing_extensions import Literal
 
 import httpx
 
 from ..types import (
+    Currency,
     SubscriptionStatus,
     subscription_list_params,
     subscription_charge_params,
@@ -28,10 +29,12 @@ from .._response import (
 )
 from ..pagination import SyncDefaultPageNumberPagination, AsyncDefaultPageNumberPagination
 from .._base_client import AsyncPaginator, make_request_options
+from ..types.currency import Currency
 from ..types.subscription import Subscription
 from ..types.subscription_status import SubscriptionStatus
 from ..types.billing_address_param import BillingAddressParam
 from ..types.customer_request_param import CustomerRequestParam
+from ..types.subscription_list_response import SubscriptionListResponse
 from ..types.subscription_charge_response import SubscriptionChargeResponse
 from ..types.subscription_create_response import SubscriptionCreateResponse
 
@@ -65,6 +68,7 @@ class SubscriptionsResource(SyncAPIResource):
         customer: CustomerRequestParam,
         product_id: str,
         quantity: int,
+        addons: Optional[Iterable[subscription_create_params.Addon]] | NotGiven = NOT_GIVEN,
         allowed_payment_method_types: Optional[
             List[
                 Literal[
@@ -90,156 +94,7 @@ class SubscriptionsResource(SyncAPIResource):
             ]
         ]
         | NotGiven = NOT_GIVEN,
-        billing_currency: Optional[
-            Literal[
-                "AED",
-                "ALL",
-                "AMD",
-                "ANG",
-                "AOA",
-                "ARS",
-                "AUD",
-                "AWG",
-                "AZN",
-                "BAM",
-                "BBD",
-                "BDT",
-                "BGN",
-                "BHD",
-                "BIF",
-                "BMD",
-                "BND",
-                "BOB",
-                "BRL",
-                "BSD",
-                "BWP",
-                "BYN",
-                "BZD",
-                "CAD",
-                "CHF",
-                "CLP",
-                "CNY",
-                "COP",
-                "CRC",
-                "CUP",
-                "CVE",
-                "CZK",
-                "DJF",
-                "DKK",
-                "DOP",
-                "DZD",
-                "EGP",
-                "ETB",
-                "EUR",
-                "FJD",
-                "FKP",
-                "GBP",
-                "GEL",
-                "GHS",
-                "GIP",
-                "GMD",
-                "GNF",
-                "GTQ",
-                "GYD",
-                "HKD",
-                "HNL",
-                "HRK",
-                "HTG",
-                "HUF",
-                "IDR",
-                "ILS",
-                "INR",
-                "IQD",
-                "JMD",
-                "JOD",
-                "JPY",
-                "KES",
-                "KGS",
-                "KHR",
-                "KMF",
-                "KRW",
-                "KWD",
-                "KYD",
-                "KZT",
-                "LAK",
-                "LBP",
-                "LKR",
-                "LRD",
-                "LSL",
-                "LYD",
-                "MAD",
-                "MDL",
-                "MGA",
-                "MKD",
-                "MMK",
-                "MNT",
-                "MOP",
-                "MRU",
-                "MUR",
-                "MVR",
-                "MWK",
-                "MXN",
-                "MYR",
-                "MZN",
-                "NAD",
-                "NGN",
-                "NIO",
-                "NOK",
-                "NPR",
-                "NZD",
-                "OMR",
-                "PAB",
-                "PEN",
-                "PGK",
-                "PHP",
-                "PKR",
-                "PLN",
-                "PYG",
-                "QAR",
-                "RON",
-                "RSD",
-                "RUB",
-                "RWF",
-                "SAR",
-                "SBD",
-                "SCR",
-                "SEK",
-                "SGD",
-                "SHP",
-                "SLE",
-                "SLL",
-                "SOS",
-                "SRD",
-                "SSP",
-                "STN",
-                "SVC",
-                "SZL",
-                "THB",
-                "TND",
-                "TOP",
-                "TRY",
-                "TTD",
-                "TWD",
-                "TZS",
-                "UAH",
-                "UGX",
-                "USD",
-                "UYU",
-                "UZS",
-                "VES",
-                "VND",
-                "VUV",
-                "WST",
-                "XAF",
-                "XCD",
-                "XOF",
-                "XPF",
-                "YER",
-                "ZAR",
-                "ZMW",
-            ]
-        ]
-        | NotGiven = NOT_GIVEN,
+        billing_currency: Optional[Currency] | NotGiven = NOT_GIVEN,
         discount_code: Optional[str] | NotGiven = NOT_GIVEN,
         metadata: Dict[str, str] | NotGiven = NOT_GIVEN,
         on_demand: Optional[subscription_create_params.OnDemand] | NotGiven = NOT_GIVEN,
@@ -261,6 +116,8 @@ class SubscriptionsResource(SyncAPIResource):
 
           quantity: Number of units to subscribe for. Must be at least 1.
 
+          addons: Attach addons to this subscription
+
           allowed_payment_method_types: List of payment methods allowed during checkout.
 
               Customers will **never** see payment methods that are **not** in this list.
@@ -298,6 +155,7 @@ class SubscriptionsResource(SyncAPIResource):
                     "customer": customer,
                     "product_id": product_id,
                     "quantity": quantity,
+                    "addons": addons,
                     "allowed_payment_method_types": allowed_payment_method_types,
                     "billing_currency": billing_currency,
                     "discount_code": discount_code,
@@ -409,7 +267,7 @@ class SubscriptionsResource(SyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> SyncDefaultPageNumberPagination[Subscription]:
+    ) -> SyncDefaultPageNumberPagination[SubscriptionListResponse]:
         """
         Args:
           created_at_gte: Get events after this created time
@@ -434,7 +292,7 @@ class SubscriptionsResource(SyncAPIResource):
         """
         return self._get_api_list(
             "/subscriptions",
-            page=SyncDefaultPageNumberPagination[Subscription],
+            page=SyncDefaultPageNumberPagination[SubscriptionListResponse],
             options=make_request_options(
                 extra_headers=extra_headers,
                 extra_query=extra_query,
@@ -452,7 +310,7 @@ class SubscriptionsResource(SyncAPIResource):
                     subscription_list_params.SubscriptionListParams,
                 ),
             ),
-            model=Subscription,
+            model=SubscriptionListResponse,
         )
 
     def change_plan(
@@ -567,6 +425,7 @@ class AsyncSubscriptionsResource(AsyncAPIResource):
         customer: CustomerRequestParam,
         product_id: str,
         quantity: int,
+        addons: Optional[Iterable[subscription_create_params.Addon]] | NotGiven = NOT_GIVEN,
         allowed_payment_method_types: Optional[
             List[
                 Literal[
@@ -592,156 +451,7 @@ class AsyncSubscriptionsResource(AsyncAPIResource):
             ]
         ]
         | NotGiven = NOT_GIVEN,
-        billing_currency: Optional[
-            Literal[
-                "AED",
-                "ALL",
-                "AMD",
-                "ANG",
-                "AOA",
-                "ARS",
-                "AUD",
-                "AWG",
-                "AZN",
-                "BAM",
-                "BBD",
-                "BDT",
-                "BGN",
-                "BHD",
-                "BIF",
-                "BMD",
-                "BND",
-                "BOB",
-                "BRL",
-                "BSD",
-                "BWP",
-                "BYN",
-                "BZD",
-                "CAD",
-                "CHF",
-                "CLP",
-                "CNY",
-                "COP",
-                "CRC",
-                "CUP",
-                "CVE",
-                "CZK",
-                "DJF",
-                "DKK",
-                "DOP",
-                "DZD",
-                "EGP",
-                "ETB",
-                "EUR",
-                "FJD",
-                "FKP",
-                "GBP",
-                "GEL",
-                "GHS",
-                "GIP",
-                "GMD",
-                "GNF",
-                "GTQ",
-                "GYD",
-                "HKD",
-                "HNL",
-                "HRK",
-                "HTG",
-                "HUF",
-                "IDR",
-                "ILS",
-                "INR",
-                "IQD",
-                "JMD",
-                "JOD",
-                "JPY",
-                "KES",
-                "KGS",
-                "KHR",
-                "KMF",
-                "KRW",
-                "KWD",
-                "KYD",
-                "KZT",
-                "LAK",
-                "LBP",
-                "LKR",
-                "LRD",
-                "LSL",
-                "LYD",
-                "MAD",
-                "MDL",
-                "MGA",
-                "MKD",
-                "MMK",
-                "MNT",
-                "MOP",
-                "MRU",
-                "MUR",
-                "MVR",
-                "MWK",
-                "MXN",
-                "MYR",
-                "MZN",
-                "NAD",
-                "NGN",
-                "NIO",
-                "NOK",
-                "NPR",
-                "NZD",
-                "OMR",
-                "PAB",
-                "PEN",
-                "PGK",
-                "PHP",
-                "PKR",
-                "PLN",
-                "PYG",
-                "QAR",
-                "RON",
-                "RSD",
-                "RUB",
-                "RWF",
-                "SAR",
-                "SBD",
-                "SCR",
-                "SEK",
-                "SGD",
-                "SHP",
-                "SLE",
-                "SLL",
-                "SOS",
-                "SRD",
-                "SSP",
-                "STN",
-                "SVC",
-                "SZL",
-                "THB",
-                "TND",
-                "TOP",
-                "TRY",
-                "TTD",
-                "TWD",
-                "TZS",
-                "UAH",
-                "UGX",
-                "USD",
-                "UYU",
-                "UZS",
-                "VES",
-                "VND",
-                "VUV",
-                "WST",
-                "XAF",
-                "XCD",
-                "XOF",
-                "XPF",
-                "YER",
-                "ZAR",
-                "ZMW",
-            ]
-        ]
-        | NotGiven = NOT_GIVEN,
+        billing_currency: Optional[Currency] | NotGiven = NOT_GIVEN,
         discount_code: Optional[str] | NotGiven = NOT_GIVEN,
         metadata: Dict[str, str] | NotGiven = NOT_GIVEN,
         on_demand: Optional[subscription_create_params.OnDemand] | NotGiven = NOT_GIVEN,
@@ -763,6 +473,8 @@ class AsyncSubscriptionsResource(AsyncAPIResource):
 
           quantity: Number of units to subscribe for. Must be at least 1.
 
+          addons: Attach addons to this subscription
+
           allowed_payment_method_types: List of payment methods allowed during checkout.
 
               Customers will **never** see payment methods that are **not** in this list.
@@ -800,6 +512,7 @@ class AsyncSubscriptionsResource(AsyncAPIResource):
                     "customer": customer,
                     "product_id": product_id,
                     "quantity": quantity,
+                    "addons": addons,
                     "allowed_payment_method_types": allowed_payment_method_types,
                     "billing_currency": billing_currency,
                     "discount_code": discount_code,
@@ -911,7 +624,7 @@ class AsyncSubscriptionsResource(AsyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> AsyncPaginator[Subscription, AsyncDefaultPageNumberPagination[Subscription]]:
+    ) -> AsyncPaginator[SubscriptionListResponse, AsyncDefaultPageNumberPagination[SubscriptionListResponse]]:
         """
         Args:
           created_at_gte: Get events after this created time
@@ -936,7 +649,7 @@ class AsyncSubscriptionsResource(AsyncAPIResource):
         """
         return self._get_api_list(
             "/subscriptions",
-            page=AsyncDefaultPageNumberPagination[Subscription],
+            page=AsyncDefaultPageNumberPagination[SubscriptionListResponse],
             options=make_request_options(
                 extra_headers=extra_headers,
                 extra_query=extra_query,
@@ -954,7 +667,7 @@ class AsyncSubscriptionsResource(AsyncAPIResource):
                     subscription_list_params.SubscriptionListParams,
                 ),
             ),
-            model=Subscription,
+            model=SubscriptionListResponse,
         )
 
     async def change_plan(

dodopayments/types/__init__.py

@@ -7,23 +7,29 @@ from .refund import Refund as Refund
 from .dispute import Dispute as Dispute
 from .payment import Payment as Payment
 from .product import Product as Product
+from .currency import Currency as Currency
 from .customer import Customer as Customer
 from .discount import Discount as Discount
 from .license_key import LicenseKey as LicenseKey
 from .price_param import PriceParam as PriceParam
 from .country_code import CountryCode as CountryCode
 from .subscription import Subscription as Subscription
+from .tax_category import TaxCategory as TaxCategory
 from .discount_type import DiscountType as DiscountType
 from .dispute_stage import DisputeStage as DisputeStage
 from .intent_status import IntentStatus as IntentStatus
 from .refund_status import RefundStatus as RefundStatus
 from .time_interval import TimeInterval as TimeInterval
 from .webhook_event import WebhookEvent as WebhookEvent
+from .addon_response import AddonResponse as AddonResponse
 from .dispute_status import DisputeStatus as DisputeStatus
 from .billing_address import BillingAddress as BillingAddress
+from .addon_list_params import AddonListParams as AddonListParams
 from .license_key_status import LicenseKeyStatus as LicenseKeyStatus
 from .payout_list_params import PayoutListParams as PayoutListParams
 from .refund_list_params import RefundListParams as RefundListParams
+from .addon_create_params import AddonCreateParams as AddonCreateParams
+from .addon_update_params import AddonUpdateParams as AddonUpdateParams
 from .dispute_list_params import DisputeListParams as DisputeListParams
 from .payment_list_params import PaymentListParams as PaymentListParams
 from .product_list_params import ProductListParams as ProductListParams
@@ -50,6 +56,7 @@ 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 .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 .create_new_customer_param import CreateNewCustomerParam as CreateNewCustomerParam
@@ -61,7 +68,9 @@ from .license_key_duration_param import LicenseKeyDurationParam as LicenseKeyDur
 from .one_time_product_cart_item import OneTimeProductCartItem as OneTimeProductCartItem
 from .subscription_charge_params import SubscriptionChargeParams as SubscriptionChargeParams
 from .subscription_create_params import SubscriptionCreateParams as SubscriptionCreateParams
+from .subscription_list_response import SubscriptionListResponse as SubscriptionListResponse
 from .subscription_update_params import SubscriptionUpdateParams as SubscriptionUpdateParams
+from .addon_update_images_response import AddonUpdateImagesResponse as AddonUpdateImagesResponse
 from .subscription_charge_response import SubscriptionChargeResponse as SubscriptionChargeResponse
 from .subscription_create_response import SubscriptionCreateResponse as SubscriptionCreateResponse
 from .attach_existing_customer_param import AttachExistingCustomerParam as AttachExistingCustomerParam

dodopayments/types/addon_cart_response_item.py

@@ -0,0 +1,11 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from .._models import BaseModel
+
+__all__ = ["AddonCartResponseItem"]
+
+
+class AddonCartResponseItem(BaseModel):
+    addon_id: str
+
+    quantity: int

dodopayments/types/addon_create_params.py

@@ -0,0 +1,30 @@
+# 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
+from .tax_category import TaxCategory
+
+__all__ = ["AddonCreateParams"]
+
+
+class AddonCreateParams(TypedDict, total=False):
+    currency: Required[Currency]
+
+    name: Required[str]
+    """Name of the Addon"""
+
+    price: Required[int]
+    """Amount of the addon"""
+
+    tax_category: Required[TaxCategory]
+    """
+    Represents the different categories of taxation applicable to various products
+    and services.
+    """
+
+    description: Optional[str]
+    """Optional description of the Addon"""

dodopayments/types/addon_list_params.py

@@ -0,0 +1,16 @@
+# 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__ = ["AddonListParams"]
+
+
+class AddonListParams(TypedDict, total=False):
+    page_number: Optional[int]
+    """Page number default is 0"""
+
+    page_size: Optional[int]
+    """Page size default is 10 max is 100"""

dodopayments/types/addon_response.py

@@ -0,0 +1,44 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+
+from .._models import BaseModel
+from .currency import Currency
+from .tax_category import TaxCategory
+
+__all__ = ["AddonResponse"]
+
+
+class AddonResponse(BaseModel):
+    id: str
+    """id of the Addon"""
+
+    business_id: str
+    """Unique identifier for the business to which the addon belongs."""
+
+    created_at: datetime
+    """Created time"""
+
+    currency: Currency
+
+    name: str
+    """Name of the Addon"""
+
+    price: int
+    """Amount of the addon"""
+
+    tax_category: TaxCategory
+    """
+    Represents the different categories of taxation applicable to various products
+    and services.
+    """
+
+    updated_at: datetime
+    """Updated time"""
+
+    description: Optional[str] = None
+    """Optional description of the Addon"""
+
+    image: Optional[str] = None
+    """Image of the Addon"""

dodopayments/types/addon_update_images_response.py

@@ -0,0 +1,11 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from .._models import BaseModel
+
+__all__ = ["AddonUpdateImagesResponse"]
+
+
+class AddonUpdateImagesResponse(BaseModel):
+    image_id: str
+
+    url: str

dodopayments/types/addon_update_params.py

@@ -0,0 +1,33 @@
+# 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 .currency import Currency
+from .tax_category import TaxCategory
+
+__all__ = ["AddonUpdateParams"]
+
+
+class AddonUpdateParams(TypedDict, total=False):
+    currency: Optional[Currency]
+
+    description: Optional[str]
+    """Description of the Addon, optional and must be at most 1000 characters."""
+
+    image_id: Optional[str]
+    """Addon image id after its uploaded to S3"""
+
+    name: Optional[str]
+    """Name of the Addon, optional and must be at most 100 characters."""
+
+    price: Optional[int]
+    """Amount of the addon"""
+
+    tax_category: Optional[TaxCategory]
+    """
+    Represents the different categories of taxation applicable to various products
+    and services.
+    """