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

dodopayments/types/subscription_charge_params.py

@@ -7,7 +7,7 @@ from typing_extensions import Required, TypedDict
 
 from .currency import Currency
 
-__all__ = ["SubscriptionChargeParams"]
+__all__ = ["SubscriptionChargeParams", "CustomerBalanceConfig"]
 
 
 class SubscriptionChargeParams(TypedDict, total=False):
@@ -25,6 +25,9 @@ class SubscriptionChargeParams(TypedDict, total=False):
     for the business.
     """
 
+    customer_balance_config: Optional[CustomerBalanceConfig]
+    """Specify how customer balance is used for the payment"""
+
     metadata: Optional[Dict[str, str]]
     """Metadata for the payment.
 
@@ -42,3 +45,11 @@ class SubscriptionChargeParams(TypedDict, total=False):
     Optional product description override for billing and line items. If not
     specified, the stored description of the product will be used.
     """
+
+
+class CustomerBalanceConfig(TypedDict, total=False):
+    allow_customer_credits_purchase: Optional[bool]
+    """Allows Customer Credit to be purchased to settle payments"""
+
+    allow_customer_credits_usage: Optional[bool]
+    """Allows Customer Credit Balance to be used to settle payments"""

dodopayments/types/subscription_create_params.py

@@ -49,6 +49,9 @@ class SubscriptionCreateParams(TypedDict, total=False):
     discount_code: Optional[str]
     """Discount Code to apply to the subscription"""
 
+    force_3ds: Optional[bool]
+    """Override merchant default 3DS behaviour for this subscription"""
+
     metadata: Dict[str, str]
     """Additional metadata for the subscription Defaults to empty if not specified"""
 

dodopayments/types/subscription_expired_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__ = ["SubscriptionExpiredWebhookEvent", "Data"]
+
+
+class Data(Subscription):
+    payload_type: Optional[Literal["Subscription"]] = None
+    """The type of payload in the data field"""
+
+
+class SubscriptionExpiredWebhookEvent(BaseModel):
+    business_id: str
+    """The business identifier"""
+
+    data: Data
+    """Event-specific data"""
+
+    timestamp: datetime
+    """The timestamp of when the event occurred"""
+
+    type: Literal["subscription.expired"]
+    """The event type"""

dodopayments/types/subscription_expired_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__ = ["SubscriptionExpiredWebhookEvent", "Data"]
+
+
+class Data(Subscription):
+    payload_type: Optional[Literal["Subscription"]] = None
+    """The type of payload in the data field"""
+
+
+class SubscriptionExpiredWebhookEvent(BaseModel):
+    business_id: str
+    """The business identifier"""
+
+    data: Data
+    """Event-specific data"""
+
+    timestamp: datetime
+    """The timestamp of when the event occurred"""
+
+    type: Literal["subscription.expired"]
+    """The event type"""

dodopayments/types/subscription_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 .._models import BaseModel
+from .subscription import Subscription
+
+__all__ = ["SubscriptionFailedWebhookEvent", "Data"]
+
+
+class Data(Subscription):
+    payload_type: Optional[Literal["Subscription"]] = None
+    """The type of payload in the data field"""
+
+
+class SubscriptionFailedWebhookEvent(BaseModel):
+    business_id: str
+    """The business identifier"""
+
+    data: Data
+    """Event-specific data"""
+
+    timestamp: datetime
+    """The timestamp of when the event occurred"""
+
+    type: Literal["subscription.failed"]
+    """The event type"""

dodopayments/types/subscription_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 .._models import BaseModel
+from .subscription import Subscription
+
+__all__ = ["SubscriptionFailedWebhookEvent", "Data"]
+
+
+class Data(Subscription):
+    payload_type: Optional[Literal["Subscription"]] = None
+    """The type of payload in the data field"""
+
+
+class SubscriptionFailedWebhookEvent(BaseModel):
+    business_id: str
+    """The business identifier"""
+
+    data: Data
+    """Event-specific data"""
+
+    timestamp: datetime
+    """The timestamp of when the event occurred"""
+
+    type: Literal["subscription.failed"]
+    """The event type"""

dodopayments/types/subscription_list_response.py

@@ -88,3 +88,6 @@ class SubscriptionListResponse(BaseModel):
 
     discount_id: Optional[str] = None
     """The discount id if discount is applied"""
+
+    tax_id: Optional[str] = None
+    """Tax identifier provided for this subscription (if applicable)"""

dodopayments/types/subscription_on_hold_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__ = ["SubscriptionOnHoldWebhookEvent", "Data"]
+
+
+class Data(Subscription):
+    payload_type: Optional[Literal["Subscription"]] = None
+    """The type of payload in the data field"""
+
+
+class SubscriptionOnHoldWebhookEvent(BaseModel):
+    business_id: str
+    """The business identifier"""
+
+    data: Data
+    """Event-specific data"""
+
+    timestamp: datetime
+    """The timestamp of when the event occurred"""
+
+    type: Literal["subscription.on_hold"]
+    """The event type"""

dodopayments/types/subscription_on_hold_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__ = ["SubscriptionOnHoldWebhookEvent", "Data"]
+
+
+class Data(Subscription):
+    payload_type: Optional[Literal["Subscription"]] = None
+    """The type of payload in the data field"""
+
+
+class SubscriptionOnHoldWebhookEvent(BaseModel):
+    business_id: str
+    """The business identifier"""
+
+    data: Data
+    """Event-specific data"""
+
+    timestamp: datetime
+    """The timestamp of when the event occurred"""
+
+    type: Literal["subscription.on_hold"]
+    """The event type"""

dodopayments/types/subscription_plan_changed_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__ = ["SubscriptionPlanChangedWebhookEvent", "Data"]
+
+
+class Data(Subscription):
+    payload_type: Optional[Literal["Subscription"]] = None
+    """The type of payload in the data field"""
+
+
+class SubscriptionPlanChangedWebhookEvent(BaseModel):
+    business_id: str
+    """The business identifier"""
+
+    data: Data
+    """Event-specific data"""
+
+    timestamp: datetime
+    """The timestamp of when the event occurred"""
+
+    type: Literal["subscription.plan_changed"]
+    """The event type"""

dodopayments/types/subscription_plan_changed_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__ = ["SubscriptionPlanChangedWebhookEvent", "Data"]
+
+
+class Data(Subscription):
+    payload_type: Optional[Literal["Subscription"]] = None
+    """The type of payload in the data field"""
+
+
+class SubscriptionPlanChangedWebhookEvent(BaseModel):
+    business_id: str
+    """The business identifier"""
+
+    data: Data
+    """Event-specific data"""
+
+    timestamp: datetime
+    """The timestamp of when the event occurred"""
+
+    type: Literal["subscription.plan_changed"]
+    """The event type"""

dodopayments/types/subscription_renewed_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__ = ["SubscriptionRenewedWebhookEvent", "Data"]
+
+
+class Data(Subscription):
+    payload_type: Optional[Literal["Subscription"]] = None
+    """The type of payload in the data field"""
+
+
+class SubscriptionRenewedWebhookEvent(BaseModel):
+    business_id: str
+    """The business identifier"""
+
+    data: Data
+    """Event-specific data"""
+
+    timestamp: datetime
+    """The timestamp of when the event occurred"""
+
+    type: Literal["subscription.renewed"]
+    """The event type"""

dodopayments/types/subscription_renewed_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__ = ["SubscriptionRenewedWebhookEvent", "Data"]
+
+
+class Data(Subscription):
+    payload_type: Optional[Literal["Subscription"]] = None
+    """The type of payload in the data field"""
+
+
+class SubscriptionRenewedWebhookEvent(BaseModel):
+    business_id: str
+    """The business identifier"""
+
+    data: Data
+    """Event-specific data"""
+
+    timestamp: datetime
+    """The timestamp of when the event occurred"""
+
+    type: Literal["subscription.renewed"]
+    """The event type"""

dodopayments/types/subscription_retrieve_usage_history_params.py

@@ -0,0 +1,28 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union, Optional
+from datetime import datetime
+from typing_extensions import Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["SubscriptionRetrieveUsageHistoryParams"]
+
+
+class SubscriptionRetrieveUsageHistoryParams(TypedDict, total=False):
+    end_date: Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]
+    """Filter by end date (inclusive)"""
+
+    meter_id: Optional[str]
+    """Filter by specific meter ID"""
+
+    page_number: Optional[int]
+    """Page number (default: 0)"""
+
+    page_size: Optional[int]
+    """Page size (default: 10, max: 100)"""
+
+    start_date: Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]
+    """Filter by start date (inclusive)"""

dodopayments/types/subscription_retrieve_usage_history_response.py

@@ -0,0 +1,46 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+from datetime import datetime
+
+from .._models import BaseModel
+from .currency import Currency
+
+__all__ = ["SubscriptionRetrieveUsageHistoryResponse", "Meter"]
+
+
+class Meter(BaseModel):
+    id: str
+    """Meter identifier"""
+
+    chargeable_units: str
+    """Chargeable units (after free threshold) as string for precision"""
+
+    consumed_units: str
+    """Total units consumed as string for precision"""
+
+    currency: Currency
+    """Currency for the price per unit"""
+
+    free_threshold: int
+    """Free threshold units for this meter"""
+
+    name: str
+    """Meter name"""
+
+    price_per_unit: str
+    """Price per unit in string format for precision"""
+
+    total_price: int
+    """Total price charged for this meter in smallest currency unit (cents)"""
+
+
+class SubscriptionRetrieveUsageHistoryResponse(BaseModel):
+    end_date: datetime
+    """End date of the billing period"""
+
+    meters: List[Meter]
+    """List of meters and their usage for this billing period"""
+
+    start_date: datetime
+    """Start date of the billing period"""

dodopayments/types/subscription_update_params.py

@@ -19,6 +19,8 @@ class SubscriptionUpdateParams(TypedDict, total=False):
     cancel_at_next_billing_date: Optional[bool]
     """When set, the subscription will remain active until the end of billing period"""
 
+    customer_name: Optional[str]
+
     disable_on_demand: Optional[DisableOnDemand]
 
     metadata: Optional[Dict[str, str]]

dodopayments/types/unsafe_unwrap_webhook_event.py

@@ -0,0 +1,52 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Union
+from typing_extensions import TypeAlias
+
+from .dispute_won_webhook_event import DisputeWonWebhookEvent
+from .dispute_lost_webhook_event import DisputeLostWebhookEvent
+from .refund_failed_webhook_event import RefundFailedWebhookEvent
+from .dispute_opened_webhook_event import DisputeOpenedWebhookEvent
+from .payment_failed_webhook_event import PaymentFailedWebhookEvent
+from .dispute_expired_webhook_event import DisputeExpiredWebhookEvent
+from .dispute_accepted_webhook_event import DisputeAcceptedWebhookEvent
+from .refund_succeeded_webhook_event import RefundSucceededWebhookEvent
+from .dispute_cancelled_webhook_event import DisputeCancelledWebhookEvent
+from .payment_cancelled_webhook_event import PaymentCancelledWebhookEvent
+from .payment_succeeded_webhook_event import PaymentSucceededWebhookEvent
+from .dispute_challenged_webhook_event import DisputeChallengedWebhookEvent
+from .payment_processing_webhook_event import PaymentProcessingWebhookEvent
+from .license_key_created_webhook_event import LicenseKeyCreatedWebhookEvent
+from .subscription_active_webhook_event import SubscriptionActiveWebhookEvent
+from .subscription_failed_webhook_event import SubscriptionFailedWebhookEvent
+from .subscription_expired_webhook_event import SubscriptionExpiredWebhookEvent
+from .subscription_on_hold_webhook_event import SubscriptionOnHoldWebhookEvent
+from .subscription_renewed_webhook_event import SubscriptionRenewedWebhookEvent
+from .subscription_cancelled_webhook_event import SubscriptionCancelledWebhookEvent
+from .subscription_plan_changed_webhook_event import SubscriptionPlanChangedWebhookEvent
+
+__all__ = ["UnsafeUnwrapWebhookEvent"]
+
+UnsafeUnwrapWebhookEvent: TypeAlias = Union[
+    DisputeAcceptedWebhookEvent,
+    DisputeCancelledWebhookEvent,
+    DisputeChallengedWebhookEvent,
+    DisputeExpiredWebhookEvent,
+    DisputeLostWebhookEvent,
+    DisputeOpenedWebhookEvent,
+    DisputeWonWebhookEvent,
+    LicenseKeyCreatedWebhookEvent,
+    PaymentCancelledWebhookEvent,
+    PaymentFailedWebhookEvent,
+    PaymentProcessingWebhookEvent,
+    PaymentSucceededWebhookEvent,
+    RefundFailedWebhookEvent,
+    RefundSucceededWebhookEvent,
+    SubscriptionActiveWebhookEvent,
+    SubscriptionCancelledWebhookEvent,
+    SubscriptionExpiredWebhookEvent,
+    SubscriptionFailedWebhookEvent,
+    SubscriptionOnHoldWebhookEvent,
+    SubscriptionPlanChangedWebhookEvent,
+    SubscriptionRenewedWebhookEvent,
+]

dodopayments/types/unwrap_webhook_event.py

@@ -0,0 +1,52 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Union
+from typing_extensions import TypeAlias
+
+from .dispute_won_webhook_event import DisputeWonWebhookEvent
+from .dispute_lost_webhook_event import DisputeLostWebhookEvent
+from .refund_failed_webhook_event import RefundFailedWebhookEvent
+from .dispute_opened_webhook_event import DisputeOpenedWebhookEvent
+from .payment_failed_webhook_event import PaymentFailedWebhookEvent
+from .dispute_expired_webhook_event import DisputeExpiredWebhookEvent
+from .dispute_accepted_webhook_event import DisputeAcceptedWebhookEvent
+from .refund_succeeded_webhook_event import RefundSucceededWebhookEvent
+from .dispute_cancelled_webhook_event import DisputeCancelledWebhookEvent
+from .payment_cancelled_webhook_event import PaymentCancelledWebhookEvent
+from .payment_succeeded_webhook_event import PaymentSucceededWebhookEvent
+from .dispute_challenged_webhook_event import DisputeChallengedWebhookEvent
+from .payment_processing_webhook_event import PaymentProcessingWebhookEvent
+from .license_key_created_webhook_event import LicenseKeyCreatedWebhookEvent
+from .subscription_active_webhook_event import SubscriptionActiveWebhookEvent
+from .subscription_failed_webhook_event import SubscriptionFailedWebhookEvent
+from .subscription_expired_webhook_event import SubscriptionExpiredWebhookEvent
+from .subscription_on_hold_webhook_event import SubscriptionOnHoldWebhookEvent
+from .subscription_renewed_webhook_event import SubscriptionRenewedWebhookEvent
+from .subscription_cancelled_webhook_event import SubscriptionCancelledWebhookEvent
+from .subscription_plan_changed_webhook_event import SubscriptionPlanChangedWebhookEvent
+
+__all__ = ["UnwrapWebhookEvent"]
+
+UnwrapWebhookEvent: TypeAlias = Union[
+    DisputeAcceptedWebhookEvent,
+    DisputeCancelledWebhookEvent,
+    DisputeChallengedWebhookEvent,
+    DisputeExpiredWebhookEvent,
+    DisputeLostWebhookEvent,
+    DisputeOpenedWebhookEvent,
+    DisputeWonWebhookEvent,
+    LicenseKeyCreatedWebhookEvent,
+    PaymentCancelledWebhookEvent,
+    PaymentFailedWebhookEvent,
+    PaymentProcessingWebhookEvent,
+    PaymentSucceededWebhookEvent,
+    RefundFailedWebhookEvent,
+    RefundSucceededWebhookEvent,
+    SubscriptionActiveWebhookEvent,
+    SubscriptionCancelledWebhookEvent,
+    SubscriptionExpiredWebhookEvent,
+    SubscriptionFailedWebhookEvent,
+    SubscriptionOnHoldWebhookEvent,
+    SubscriptionPlanChangedWebhookEvent,
+    SubscriptionRenewedWebhookEvent,
+]

dodopayments/types/usage_event_ingest_params.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Iterable
+from typing_extensions import Required, TypedDict
+
+from .event_input_param import EventInputParam
+
+__all__ = ["UsageEventIngestParams"]
+
+
+class UsageEventIngestParams(TypedDict, total=False):
+    events: Required[Iterable[EventInputParam]]
+    """List of events to be pushed"""

dodopayments/types/usage_event_ingest_response.py

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

dodopayments/types/usage_event_list_params.py

@@ -0,0 +1,42 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union
+from datetime import datetime
+from typing_extensions import Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["UsageEventListParams"]
+
+
+class UsageEventListParams(TypedDict, total=False):
+    customer_id: str
+    """Filter events by customer ID"""
+
+    end: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
+    """Filter events created before this timestamp"""
+
+    event_name: str
+    """Filter events by event name.
+
+    If both event_name and meter_id are provided, they must match the meter's
+    configured event_name
+    """
+
+    meter_id: str
+    """Filter events by meter ID.
+
+    When provided, only events that match the meter's event_name and filter criteria
+    will be returned
+    """
+
+    page_number: int
+    """Page number (0-based, default: 0)"""
+
+    page_size: int
+    """Number of events to return per page (default: 10)"""
+
+    start: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
+    """Filter events created after this timestamp"""

{dodopayments-1.51.1.dist-info → dodopayments-1.56.5.dist-info}/METADATA

@@ -1,10 +1,10 @@
 Metadata-Version: 2.3
 Name: dodopayments
-Version: 1.51.1
+Version: 1.56.5
 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
-Author-email: Dodo Payments <founders@dodopayments.com>
+Author-email: Dodo Payments <support@dodopayments.com>
 License: Apache-2.0
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
@@ -30,7 +30,9 @@ Requires-Dist: sniffio
 Requires-Dist: typing-extensions<5,>=4.10
 Provides-Extra: aiohttp
 Requires-Dist: aiohttp; extra == 'aiohttp'
-Requires-Dist: httpx-aiohttp>=0.1.8; extra == 'aiohttp'
+Requires-Dist: httpx-aiohttp>=0.1.9; extra == 'aiohttp'
+Provides-Extra: webhooks
+Requires-Dist: standardwebhooks; extra == 'webhooks'
 Description-Content-Type: text/markdown
 
 # Dodo Payments Python API library
@@ -46,7 +48,7 @@ It is generated with [Stainless](https://www.stainless.com/).
 
 ## Documentation
 
-The REST API documentation can be found on [docs.dodopayments.com](https://docs.dodopayments.com). The full API of this library can be found in [api.md](https://github.com/dodopayments/dodopayments-python/tree/main/api.md).
+The REST API documentation can be found on [docs.dodopayments.com](https://docs.dodopayments.com/api-reference/introduction). The full API of this library can be found in [api.md](https://github.com/dodopayments/dodopayments-python/tree/main/api.md).
 
 ## Installation