dodopayments 1.51.1__py3-none-any.whl → 1.56.5__py3-none-any.whl

dodopayments/types/payment_succeeded_webhook_event.py

@@ -0,0 +1,29 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from .payment import Payment
+from .._models import BaseModel
+
+__all__ = ["PaymentSucceededWebhookEvent", "Data"]
+
+
+class Data(Payment):
+    payload_type: Optional[Literal["Payment"]] = None
+    """The type of payload in the data field"""
+
+
+class PaymentSucceededWebhookEvent(BaseModel):
+    business_id: str
+    """The business identifier"""
+
+    data: Data
+    """Event-specific data"""
+
+    timestamp: datetime
+    """The timestamp of when the event occurred"""
+
+    type: Literal["payment.succeeded"]
+    """The event type"""

dodopayments/types/payment_succeeded_webhook_event1.py

@@ -0,0 +1,29 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from .payment import Payment
+from .._models import BaseModel
+
+__all__ = ["PaymentSucceededWebhookEvent", "Data"]
+
+
+class Data(Payment):
+    payload_type: Optional[Literal["Payment"]] = None
+    """The type of payload in the data field"""
+
+
+class PaymentSucceededWebhookEvent(BaseModel):
+    business_id: str
+    """The business identifier"""
+
+    data: Data
+    """Event-specific data"""
+
+    timestamp: datetime
+    """The timestamp of when the event occurred"""
+
+    type: Literal["payment.succeeded"]
+    """The event type"""

dodopayments/types/payout_list_params.py

@@ -2,12 +2,22 @@
 
 from __future__ import annotations
 
-from typing_extensions import TypedDict
+from typing import Union
+from datetime import datetime
+from typing_extensions import Annotated, TypedDict
+
+from .._utils import PropertyInfo
 
 __all__ = ["PayoutListParams"]
 
 
 class PayoutListParams(TypedDict, total=False):
+    created_at_gte: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
+    """Get payouts created after this time (inclusive)"""
+
+    created_at_lte: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
+    """Get payouts created before this time (inclusive)"""
+
     page_number: int
     """Page number default is 0"""
 

dodopayments/types/price.py

@@ -1,20 +1,21 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-from typing import Union, Optional
+from typing import List, Union, Optional
 from typing_extensions import Literal, TypeAlias
 
 from .._models import BaseModel
 from .currency import Currency
 from .time_interval import TimeInterval
+from .add_meter_to_price import AddMeterToPrice
 
-__all__ = ["Price", "OneTimePrice", "RecurringPrice"]
+__all__ = ["Price", "OneTimePrice", "RecurringPrice", "UsageBasedPrice"]
 
 
 class OneTimePrice(BaseModel):
     currency: Currency
     """The currency in which the payment is made."""
 
-    discount: float
+    discount: int
     """Discount applied to the price, represented as a percentage (0 to 100)."""
 
     price: int
@@ -55,7 +56,7 @@ class RecurringPrice(BaseModel):
     currency: Currency
     """The currency in which the payment is made."""
 
-    discount: float
+    discount: int
     """Discount applied to the price, represented as a percentage (0 to 100)."""
 
     payment_frequency_count: int
@@ -98,4 +99,50 @@ class RecurringPrice(BaseModel):
     """Number of days for the trial period. A value of `0` indicates no trial period."""
 
 
-Price: TypeAlias = Union[OneTimePrice, RecurringPrice]
+class UsageBasedPrice(BaseModel):
+    currency: Currency
+    """The currency in which the payment is made."""
+
+    discount: int
+    """Discount applied to the price, represented as a percentage (0 to 100)."""
+
+    fixed_price: int
+    """The fixed payment amount.
+
+    Represented in the lowest denomination of the currency (e.g., cents for USD).
+    For example, to charge $1.00, pass `100`.
+    """
+
+    payment_frequency_count: int
+    """
+    Number of units for the payment frequency. For example, a value of `1` with a
+    `payment_frequency_interval` of `month` represents monthly payments.
+    """
+
+    payment_frequency_interval: TimeInterval
+    """The time interval for the payment frequency (e.g., day, month, year)."""
+
+    purchasing_power_parity: bool
+    """
+    Indicates if purchasing power parity adjustments are applied to the price.
+    Purchasing power parity feature is not available as of now
+    """
+
+    subscription_period_count: int
+    """
+    Number of units for the subscription period. For example, a value of `12` with a
+    `subscription_period_interval` of `month` represents a one-year subscription.
+    """
+
+    subscription_period_interval: TimeInterval
+    """The time interval for the subscription period (e.g., day, month, year)."""
+
+    type: Literal["usage_based_price"]
+
+    meters: Optional[List[AddMeterToPrice]] = None
+
+    tax_inclusive: Optional[bool] = None
+    """Indicates if the price is tax inclusive"""
+
+
+Price: TypeAlias = Union[OneTimePrice, RecurringPrice, UsageBasedPrice]

dodopayments/types/price_param.py

@@ -2,20 +2,21 @@
 
 from __future__ import annotations
 
-from typing import Union, Optional
+from typing import Union, Iterable, Optional
 from typing_extensions import Literal, Required, TypeAlias, TypedDict
 
 from .currency import Currency
 from .time_interval import TimeInterval
+from .add_meter_to_price_param import AddMeterToPriceParam
 
-__all__ = ["PriceParam", "OneTimePrice", "RecurringPrice"]
+__all__ = ["PriceParam", "OneTimePrice", "RecurringPrice", "UsageBasedPrice"]
 
 
 class OneTimePrice(TypedDict, total=False):
     currency: Required[Currency]
     """The currency in which the payment is made."""
 
-    discount: Required[float]
+    discount: Required[int]
     """Discount applied to the price, represented as a percentage (0 to 100)."""
 
     price: Required[int]
@@ -56,7 +57,7 @@ class RecurringPrice(TypedDict, total=False):
     currency: Required[Currency]
     """The currency in which the payment is made."""
 
-    discount: Required[float]
+    discount: Required[int]
     """Discount applied to the price, represented as a percentage (0 to 100)."""
 
     payment_frequency_count: Required[int]
@@ -99,4 +100,50 @@ class RecurringPrice(TypedDict, total=False):
     """Number of days for the trial period. A value of `0` indicates no trial period."""
 
 
-PriceParam: TypeAlias = Union[OneTimePrice, RecurringPrice]
+class UsageBasedPrice(TypedDict, total=False):
+    currency: Required[Currency]
+    """The currency in which the payment is made."""
+
+    discount: Required[int]
+    """Discount applied to the price, represented as a percentage (0 to 100)."""
+
+    fixed_price: Required[int]
+    """The fixed payment amount.
+
+    Represented in the lowest denomination of the currency (e.g., cents for USD).
+    For example, to charge $1.00, pass `100`.
+    """
+
+    payment_frequency_count: Required[int]
+    """
+    Number of units for the payment frequency. For example, a value of `1` with a
+    `payment_frequency_interval` of `month` represents monthly payments.
+    """
+
+    payment_frequency_interval: Required[TimeInterval]
+    """The time interval for the payment frequency (e.g., day, month, year)."""
+
+    purchasing_power_parity: Required[bool]
+    """
+    Indicates if purchasing power parity adjustments are applied to the price.
+    Purchasing power parity feature is not available as of now
+    """
+
+    subscription_period_count: Required[int]
+    """
+    Number of units for the subscription period. For example, a value of `12` with a
+    `subscription_period_interval` of `month` represents a one-year subscription.
+    """
+
+    subscription_period_interval: Required[TimeInterval]
+    """The time interval for the subscription period (e.g., day, month, year)."""
+
+    type: Required[Literal["usage_based_price"]]
+
+    meters: Optional[Iterable[AddMeterToPriceParam]]
+
+    tax_inclusive: Optional[bool]
+    """Indicates if the price is tax inclusive"""
+
+
+PriceParam: TypeAlias = Union[OneTimePrice, RecurringPrice, UsageBasedPrice]

dodopayments/types/product_create_params.py

@@ -2,9 +2,10 @@
 
 from __future__ import annotations
 
-from typing import Dict, List, Optional
+from typing import Dict, Optional
 from typing_extensions import Required, TypedDict
 
+from .._types import SequenceNotStr
 from .price_param import PriceParam
 from .tax_category import TaxCategory
 from .license_key_duration_param import LicenseKeyDurationParam
@@ -19,7 +20,7 @@ class ProductCreateParams(TypedDict, total=False):
     tax_category: Required[TaxCategory]
     """Tax category applied to this product"""
 
-    addons: Optional[List[str]]
+    addons: Optional[SequenceNotStr[str]]
     """Addons available for subscription product"""
 
     brand_id: Optional[str]

dodopayments/types/product_update_params.py

@@ -2,9 +2,10 @@
 
 from __future__ import annotations
 
-from typing import Dict, List, Optional
+from typing import Dict, Optional
 from typing_extensions import TypedDict
 
+from .._types import SequenceNotStr
 from .price_param import PriceParam
 from .tax_category import TaxCategory
 from .license_key_duration_param import LicenseKeyDurationParam
@@ -13,7 +14,7 @@ __all__ = ["ProductUpdateParams", "DigitalProductDelivery"]
 
 
 class ProductUpdateParams(TypedDict, total=False):
-    addons: Optional[List[str]]
+    addons: Optional[SequenceNotStr[str]]
     """Available Addons for subscription products"""
 
     brand_id: Optional[str]
@@ -72,7 +73,7 @@ class DigitalProductDelivery(TypedDict, total=False):
     external_url: Optional[str]
     """External URL to digital product"""
 
-    files: Optional[List[str]]
+    files: Optional[SequenceNotStr[str]]
     """Uploaded files ids of digital product"""
 
     instructions: Optional[str]

dodopayments/types/refund.py

@@ -1,11 +1,12 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-from typing import Optional
+from typing import Dict, Optional
 from datetime import datetime
 
 from .._models import BaseModel
 from .currency import Currency
 from .refund_status import RefundStatus
+from .customer_limited_details import CustomerLimitedDetails
 
 __all__ = ["Refund"]
 
@@ -17,9 +18,15 @@ class Refund(BaseModel):
     created_at: datetime
     """The timestamp of when the refund was created in UTC."""
 
+    customer: CustomerLimitedDetails
+    """Details about the customer for this refund (from the associated payment)"""
+
     is_partial: bool
     """If true the refund is a partial refund"""
 
+    metadata: Dict[str, str]
+    """Additional metadata stored with the refund."""
+
     payment_id: str
     """The unique identifier of the payment associated with the refund."""
 

dodopayments/types/refund_create_params.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Iterable, Optional
+from typing import Dict, Iterable, Optional
 from typing_extensions import Required, TypedDict
 
 __all__ = ["RefundCreateParams", "Item"]
@@ -15,6 +15,9 @@ class RefundCreateParams(TypedDict, total=False):
     items: Optional[Iterable[Item]]
     """Partially Refund an Individual Item"""
 
+    metadata: Dict[str, str]
+    """Additional metadata associated with the refund."""
+
     reason: Optional[str]
     """The reason for the refund, if any. Maximum length is 3000 characters. Optional."""
 

dodopayments/types/refund_failed_webhook_event.py

@@ -0,0 +1,29 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from .refund import Refund
+from .._models import BaseModel
+
+__all__ = ["RefundFailedWebhookEvent", "Data"]
+
+
+class Data(Refund):
+    payload_type: Optional[Literal["Refund"]] = None
+    """The type of payload in the data field"""
+
+
+class RefundFailedWebhookEvent(BaseModel):
+    business_id: str
+    """The business identifier"""
+
+    data: Data
+    """Event-specific data"""
+
+    timestamp: datetime
+    """The timestamp of when the event occurred"""
+
+    type: Literal["refund.failed"]
+    """The event type"""

dodopayments/types/refund_failed_webhook_event1.py

@@ -0,0 +1,29 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from .refund import Refund
+from .._models import BaseModel
+
+__all__ = ["RefundFailedWebhookEvent", "Data"]
+
+
+class Data(Refund):
+    payload_type: Optional[Literal["Refund"]] = None
+    """The type of payload in the data field"""
+
+
+class RefundFailedWebhookEvent(BaseModel):
+    business_id: str
+    """The business identifier"""
+
+    data: Data
+    """Event-specific data"""
+
+    timestamp: datetime
+    """The timestamp of when the event occurred"""
+
+    type: Literal["refund.failed"]
+    """The event type"""

dodopayments/types/refund_list_response.py

@@ -0,0 +1,39 @@
+# 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 .refund_status import RefundStatus
+
+__all__ = ["RefundListResponse"]
+
+
+class RefundListResponse(BaseModel):
+    business_id: str
+    """The unique identifier of the business issuing the refund."""
+
+    created_at: datetime
+    """The timestamp of when the refund was created in UTC."""
+
+    is_partial: bool
+    """If true the refund is a partial refund"""
+
+    payment_id: str
+    """The unique identifier of the payment associated with the refund."""
+
+    refund_id: str
+    """The unique identifier of the refund."""
+
+    status: RefundStatus
+    """The current status of the refund."""
+
+    amount: Optional[int] = None
+    """The refunded amount."""
+
+    currency: Optional[Currency] = None
+    """The currency of the refund, represented as an ISO 4217 currency code."""
+
+    reason: Optional[str] = None
+    """The reason provided for the refund, if any. Optional."""

dodopayments/types/refund_succeeded_webhook_event.py

@@ -0,0 +1,29 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from .refund import Refund
+from .._models import BaseModel
+
+__all__ = ["RefundSucceededWebhookEvent", "Data"]
+
+
+class Data(Refund):
+    payload_type: Optional[Literal["Refund"]] = None
+    """The type of payload in the data field"""
+
+
+class RefundSucceededWebhookEvent(BaseModel):
+    business_id: str
+    """The business identifier"""
+
+    data: Data
+    """Event-specific data"""
+
+    timestamp: datetime
+    """The timestamp of when the event occurred"""
+
+    type: Literal["refund.succeeded"]
+    """The event type"""

dodopayments/types/refund_succeeded_webhook_event1.py

@@ -0,0 +1,29 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from .refund import Refund
+from .._models import BaseModel
+
+__all__ = ["RefundSucceededWebhookEvent", "Data"]
+
+
+class Data(Refund):
+    payload_type: Optional[Literal["Refund"]] = None
+    """The type of payload in the data field"""
+
+
+class RefundSucceededWebhookEvent(BaseModel):
+    business_id: str
+    """The business identifier"""
+
+    data: Data
+    """Event-specific data"""
+
+    timestamp: datetime
+    """The timestamp of when the event occurred"""
+
+    type: Literal["refund.succeeded"]
+    """The event type"""

dodopayments/types/subscription.py

@@ -11,7 +11,23 @@ from .subscription_status import SubscriptionStatus
 from .addon_cart_response_item import AddonCartResponseItem
 from .customer_limited_details import CustomerLimitedDetails
 
-__all__ = ["Subscription"]
+__all__ = ["Subscription", "Meter"]
+
+
+class Meter(BaseModel):
+    currency: Currency
+
+    free_threshold: int
+
+    measurement_unit: str
+
+    meter_id: str
+
+    name: str
+
+    price_per_unit: str
+
+    description: Optional[str] = None
 
 
 class Subscription(BaseModel):
@@ -36,6 +52,9 @@ class Subscription(BaseModel):
     metadata: Dict[str, str]
     """Additional custom data associated with the subscription"""
 
+    meters: List[Meter]
+    """Meters associated with this subscription (for usage-based billing)"""
+
     next_billing_date: datetime
     """Timestamp of the next scheduled billing.
 
@@ -95,3 +114,6 @@ class Subscription(BaseModel):
 
     expires_at: Optional[datetime] = None
     """Timestamp when the subscription will expire"""
+
+    tax_id: Optional[str] = None
+    """Tax identifier provided for this subscription (if applicable)"""

dodopayments/types/subscription_active_webhook_event.py

@@ -0,0 +1,29 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from .._models import BaseModel
+from .subscription import Subscription
+
+__all__ = ["SubscriptionActiveWebhookEvent", "Data"]
+
+
+class Data(Subscription):
+    payload_type: Optional[Literal["Subscription"]] = None
+    """The type of payload in the data field"""
+
+
+class SubscriptionActiveWebhookEvent(BaseModel):
+    business_id: str
+    """The business identifier"""
+
+    data: Data
+    """Event-specific data"""
+
+    timestamp: datetime
+    """The timestamp of when the event occurred"""
+
+    type: Literal["subscription.active"]
+    """The event type"""

dodopayments/types/subscription_active_webhook_event1.py

@@ -0,0 +1,29 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from .._models import BaseModel
+from .subscription import Subscription
+
+__all__ = ["SubscriptionActiveWebhookEvent", "Data"]
+
+
+class Data(Subscription):
+    payload_type: Optional[Literal["Subscription"]] = None
+    """The type of payload in the data field"""
+
+
+class SubscriptionActiveWebhookEvent(BaseModel):
+    business_id: str
+    """The business identifier"""
+
+    data: Data
+    """Event-specific data"""
+
+    timestamp: datetime
+    """The timestamp of when the event occurred"""
+
+    type: Literal["subscription.active"]
+    """The event type"""

dodopayments/types/subscription_cancelled_webhook_event.py

@@ -0,0 +1,29 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from .._models import BaseModel
+from .subscription import Subscription
+
+__all__ = ["SubscriptionCancelledWebhookEvent", "Data"]
+
+
+class Data(Subscription):
+    payload_type: Optional[Literal["Subscription"]] = None
+    """The type of payload in the data field"""
+
+
+class SubscriptionCancelledWebhookEvent(BaseModel):
+    business_id: str
+    """The business identifier"""
+
+    data: Data
+    """Event-specific data"""
+
+    timestamp: datetime
+    """The timestamp of when the event occurred"""
+
+    type: Literal["subscription.cancelled"]
+    """The event type"""

dodopayments/types/subscription_cancelled_webhook_event1.py

@@ -0,0 +1,29 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from .._models import BaseModel
+from .subscription import Subscription
+
+__all__ = ["SubscriptionCancelledWebhookEvent", "Data"]
+
+
+class Data(Subscription):
+    payload_type: Optional[Literal["Subscription"]] = None
+    """The type of payload in the data field"""
+
+
+class SubscriptionCancelledWebhookEvent(BaseModel):
+    business_id: str
+    """The business identifier"""
+
+    data: Data
+    """Event-specific data"""
+
+    timestamp: datetime
+    """The timestamp of when the event occurred"""
+
+    type: Literal["subscription.cancelled"]
+    """The event type"""