dodopayments 1.43.1__py3-none-any.whl → 1.47.0__py3-none-any.whl

dodopayments/types/payment_param.py

@@ -0,0 +1,131 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict, Union, Iterable, Optional
+from datetime import datetime
+from typing_extensions import Required, Annotated, TypedDict
+
+from .._utils import PropertyInfo
+from .currency import Currency
+from .country_code import CountryCode
+from .refund_param import RefundParam
+from .dispute_param import DisputeParam
+from .intent_status import IntentStatus
+from .billing_address_param import BillingAddressParam
+from .customer_limited_details_param import CustomerLimitedDetailsParam
+
+__all__ = ["PaymentParam", "ProductCart"]
+
+
+class ProductCart(TypedDict, total=False):
+    product_id: Required[str]
+
+    quantity: Required[int]
+
+
+class PaymentParam(TypedDict, total=False):
+    billing: Required[BillingAddressParam]
+    """Billing address details for payments"""
+
+    brand_id: Required[str]
+    """brand id this payment belongs to"""
+
+    business_id: Required[str]
+    """Identifier of the business associated with the payment"""
+
+    created_at: Required[Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]]
+    """Timestamp when the payment was created"""
+
+    currency: Required[Currency]
+    """Currency used for the payment"""
+
+    customer: Required[CustomerLimitedDetailsParam]
+    """Details about the customer who made the payment"""
+
+    digital_products_delivered: Required[bool]
+    """brand id this payment belongs to"""
+
+    disputes: Required[Iterable[DisputeParam]]
+    """List of disputes associated with this payment"""
+
+    metadata: Required[Dict[str, str]]
+    """Additional custom data associated with the payment"""
+
+    payment_id: Required[str]
+    """Unique identifier for the payment"""
+
+    refunds: Required[Iterable[RefundParam]]
+    """List of refunds issued for this payment"""
+
+    settlement_amount: Required[int]
+    """
+    The amount that will be credited to your Dodo balance after currency conversion
+    and processing. Especially relevant for adaptive pricing where the customer's
+    payment currency differs from your settlement currency.
+    """
+
+    settlement_currency: Required[Currency]
+    """
+    The currency in which the settlement_amount will be credited to your Dodo
+    balance. This may differ from the customer's payment currency in adaptive
+    pricing scenarios.
+    """
+
+    total_amount: Required[int]
+    """
+    Total amount charged to the customer including tax, in smallest currency unit
+    (e.g. cents)
+    """
+
+    card_issuing_country: Optional[CountryCode]
+    """ISO2 country code of the card"""
+
+    card_last_four: Optional[str]
+    """The last four digits of the card"""
+
+    card_network: Optional[str]
+    """Card network like VISA, MASTERCARD etc."""
+
+    card_type: Optional[str]
+    """The type of card DEBIT or CREDIT"""
+
+    discount_id: Optional[str]
+    """The discount id if discount is applied"""
+
+    error_code: Optional[str]
+    """An error code if the payment failed"""
+
+    error_message: Optional[str]
+    """An error message if the payment failed"""
+
+    payment_link: Optional[str]
+    """Checkout URL"""
+
+    payment_method: Optional[str]
+    """Payment method used by customer (e.g. "card", "bank_transfer")"""
+
+    payment_method_type: Optional[str]
+    """Specific type of payment method (e.g. "visa", "mastercard")"""
+
+    product_cart: Optional[Iterable[ProductCart]]
+    """List of products purchased in a one-time payment"""
+
+    settlement_tax: Optional[int]
+    """
+    This represents the portion of settlement_amount that corresponds to taxes
+    collected. Especially relevant for adaptive pricing where the tax component must
+    be tracked separately in your Dodo balance.
+    """
+
+    status: Optional[IntentStatus]
+    """Current status of the payment intent"""
+
+    subscription_id: Optional[str]
+    """Identifier of the subscription if payment is part of a subscription"""
+
+    tax: Optional[int]
+    """Amount of tax collected in smallest currency unit (e.g. cents)"""
+
+    updated_at: Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]
+    """Timestamp when the payment was last updated"""

dodopayments/types/product.py

@@ -1,6 +1,6 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-from typing import List, Optional
+from typing import Dict, List, Optional
 from datetime import datetime
 
 from .price import Price
@@ -45,6 +45,9 @@ class Product(BaseModel):
     license_key_enabled: bool
     """Indicates whether the product requires a license key."""
 
+    metadata: Dict[str, str]
+    """Additional custom data associated with the product"""
+
     price: Price
     """Pricing information for the product."""
 

dodopayments/types/product_create_params.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import List, Optional
+from typing import Dict, List, Optional
 from typing_extensions import Required, TypedDict
 
 from .price_param import PriceParam
@@ -49,6 +49,9 @@ class ProductCreateParams(TypedDict, total=False):
     When true, generates and sends a license key to your customer. Defaults to false
     """
 
+    metadata: Dict[str, str]
+    """Additional metadata for the product"""
+
     name: Optional[str]
     """Optional name of the product"""
 

dodopayments/types/product_list_response.py

@@ -1,6 +1,6 @@
 # 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 .price import Price
@@ -21,6 +21,9 @@ class ProductListResponse(BaseModel):
     is_recurring: bool
     """Indicates if the product is recurring (e.g., subscriptions)."""
 
+    metadata: Dict[str, str]
+    """Additional custom data associated with the product"""
+
     product_id: str
     """Unique identifier for the product."""
 

dodopayments/types/product_update_params.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import List, Optional
+from typing import Dict, List, Optional
 from typing_extensions import TypedDict
 
 from .price_param import PriceParam
@@ -55,6 +55,9 @@ class ProductUpdateParams(TypedDict, total=False):
     limit, activation message) become applicable.
     """
 
+    metadata: Optional[Dict[str, str]]
+    """Additional metadata for the product"""
+
     name: Optional[str]
     """Name of the product, optional and must be at most 100 characters."""
 

dodopayments/types/refund_param.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, Optional
+from datetime import datetime
+from typing_extensions import Required, Annotated, TypedDict
+
+from .._utils import PropertyInfo
+from .currency import Currency
+from .refund_status import RefundStatus
+
+__all__ = ["RefundParam"]
+
+
+class RefundParam(TypedDict, total=False):
+    business_id: Required[str]
+    """The unique identifier of the business issuing the refund."""
+
+    created_at: Required[Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]]
+    """The timestamp of when the refund was created in UTC."""
+
+    is_partial: Required[bool]
+    """If true the refund is a partial refund"""
+
+    payment_id: Required[str]
+    """The unique identifier of the payment associated with the refund."""
+
+    refund_id: Required[str]
+    """The unique identifier of the refund."""
+
+    status: Required[RefundStatus]
+    """The current status of the refund."""
+
+    amount: Optional[int]
+    """The refunded amount."""
+
+    currency: Optional[Currency]
+    """The currency of the refund, represented as an ISO 4217 currency code."""
+
+    reason: Optional[str]
+    """The reason provided for the refund, if any. Optional."""

dodopayments/types/subscription.py

@@ -87,5 +87,8 @@ class Subscription(BaseModel):
     cancelled_at: Optional[datetime] = None
     """Cancelled timestamp if the subscription is cancelled"""
 
+    discount_cycles_remaining: Optional[int] = None
+    """Number of remaining discount cycles if discount is applied"""
+
     discount_id: Optional[str] = None
     """The discount id if discount is applied"""

dodopayments/types/subscription_change_plan_params.py

@@ -14,7 +14,7 @@ class SubscriptionChangePlanParams(TypedDict, total=False):
     product_id: Required[str]
     """Unique identifier of the product to subscribe to"""
 
-    proration_billing_mode: Required[Literal["prorated_immediately", "full_immediately"]]
+    proration_billing_mode: Required[Literal["prorated_immediately", "full_immediately", "difference_immediately"]]
     """Proration Billing Mode"""
 
     quantity: Required[int]

dodopayments/types/subscription_list_params.py

@@ -30,5 +30,5 @@ class SubscriptionListParams(TypedDict, total=False):
     page_size: int
     """Page size default is 10 max is 100"""
 
-    status: Literal["pending", "active", "on_hold", "paused", "cancelled", "failed", "expired"]
+    status: Literal["pending", "active", "on_hold", "cancelled", "failed", "expired"]
     """Filter by status"""

dodopayments/types/subscription_list_response.py

@@ -83,5 +83,8 @@ class SubscriptionListResponse(BaseModel):
     cancelled_at: Optional[datetime] = None
     """Cancelled timestamp if the subscription is cancelled"""
 
+    discount_cycles_remaining: Optional[int] = None
+    """Number of remaining discount cycles if discount is applied"""
+
     discount_id: Optional[str] = None
     """The discount id if discount is applied"""

dodopayments/types/subscription_param.py

@@ -0,0 +1,97 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict, Union, Iterable, Optional
+from datetime import datetime
+from typing_extensions import Required, Annotated, TypedDict
+
+from .._utils import PropertyInfo
+from .currency import Currency
+from .time_interval import TimeInterval
+from .subscription_status import SubscriptionStatus
+from .billing_address_param import BillingAddressParam
+from .addon_cart_response_item_param import AddonCartResponseItemParam
+from .customer_limited_details_param import CustomerLimitedDetailsParam
+
+__all__ = ["SubscriptionParam"]
+
+
+class SubscriptionParam(TypedDict, total=False):
+    addons: Required[Iterable[AddonCartResponseItemParam]]
+    """Addons associated with this subscription"""
+
+    billing: Required[BillingAddressParam]
+    """Billing address details for payments"""
+
+    cancel_at_next_billing_date: Required[bool]
+    """Indicates if the subscription will cancel at the next billing date"""
+
+    created_at: Required[Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]]
+    """Timestamp when the subscription was created"""
+
+    currency: Required[Currency]
+    """Currency used for the subscription payments"""
+
+    customer: Required[CustomerLimitedDetailsParam]
+    """Customer details associated with the subscription"""
+
+    metadata: Required[Dict[str, str]]
+    """Additional custom data associated with the subscription"""
+
+    next_billing_date: Required[Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]]
+    """Timestamp of the next scheduled billing.
+
+    Indicates the end of current billing period
+    """
+
+    on_demand: Required[bool]
+    """Wether the subscription is on-demand or not"""
+
+    payment_frequency_count: Required[int]
+    """Number of payment frequency intervals"""
+
+    payment_frequency_interval: Required[TimeInterval]
+    """Time interval for payment frequency (e.g. month, year)"""
+
+    previous_billing_date: Required[Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]]
+    """Timestamp of the last payment. Indicates the start of current billing period"""
+
+    product_id: Required[str]
+    """Identifier of the product associated with this subscription"""
+
+    quantity: Required[int]
+    """Number of units/items included in the subscription"""
+
+    recurring_pre_tax_amount: Required[int]
+    """
+    Amount charged before tax for each recurring payment in smallest currency unit
+    (e.g. cents)
+    """
+
+    status: Required[SubscriptionStatus]
+    """Current status of the subscription"""
+
+    subscription_id: Required[str]
+    """Unique identifier for the subscription"""
+
+    subscription_period_count: Required[int]
+    """Number of subscription period intervals"""
+
+    subscription_period_interval: Required[TimeInterval]
+    """Time interval for the subscription period (e.g. month, year)"""
+
+    tax_inclusive: Required[bool]
+    """Indicates if the recurring_pre_tax_amount is tax inclusive"""
+
+    trial_period_days: Required[int]
+    """Number of days in the trial period (0 if no trial)"""
+
+    cancelled_at: Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]
+    """Cancelled timestamp if the subscription is cancelled"""
+
+    discount_cycles_remaining: Optional[int]
+    """Number of remaining discount cycles if discount is applied"""
+
+    discount_id: Optional[str]
+    """The discount id if discount is applied"""

dodopayments/types/subscription_status.py

@@ -4,4 +4,4 @@ from typing_extensions import Literal, TypeAlias
 
 __all__ = ["SubscriptionStatus"]
 
-SubscriptionStatus: TypeAlias = Literal["pending", "active", "on_hold", "paused", "cancelled", "failed", "expired"]
+SubscriptionStatus: TypeAlias = Literal["pending", "active", "on_hold", "cancelled", "failed", "expired"]

dodopayments/types/webhook_create_params.py

@@ -0,0 +1,40 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict, List, Optional
+from typing_extensions import Required, TypedDict
+
+from .webhook_event_type import WebhookEventType
+
+__all__ = ["WebhookCreateParams"]
+
+
+class WebhookCreateParams(TypedDict, total=False):
+    url: Required[str]
+    """Url of the webhook"""
+
+    description: Optional[str]
+    """Filter events to the webhook.
+
+    Webhook event will only be sent for events in the list.
+    """
+
+    disabled: Optional[bool]
+    """Create the webhook in a disabled state.
+
+    Default is false
+    """
+
+    filter_types: List[WebhookEventType]
+
+    headers: Optional[Dict[str, str]]
+    """Custom headers to be passed"""
+
+    idempotency_key: Optional[str]
+    """The request's idempotency key"""
+
+    metadata: Optional[Dict[str, str]]
+    """Metadata to be passed to the webhook Defaut is {}"""
+
+    rate_limit: Optional[int]

dodopayments/types/webhook_create_response.py

@@ -0,0 +1,42 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Optional
+
+from .._models import BaseModel
+
+__all__ = ["WebhookCreateResponse"]
+
+
+class WebhookCreateResponse(BaseModel):
+    id: str
+    """The webhook's ID."""
+
+    created_at: str
+    """Created at timestamp"""
+
+    description: str
+    """An example webhook name."""
+
+    metadata: Dict[str, str]
+    """Metadata of the webhook"""
+
+    updated_at: str
+    """Updated at timestamp"""
+
+    url: str
+    """Url endpoint of the webhook"""
+
+    disabled: Optional[bool] = None
+    """Status of the webhook.
+
+    If true, events are not sent
+    """
+
+    filter_types: Optional[List[str]] = None
+    """Filter events to the webhook.
+
+    Webhook event will only be sent for events in the list.
+    """
+
+    rate_limit: Optional[int] = None
+    """Configured rate limit"""

dodopayments/types/webhook_event_type.py

@@ -21,7 +21,6 @@ WebhookEventType: TypeAlias = Literal[
     "subscription.active",
     "subscription.renewed",
     "subscription.on_hold",
-    "subscription.paused",
     "subscription.cancelled",
     "subscription.failed",
     "subscription.expired",

dodopayments/types/webhook_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__ = ["WebhookListParams"]
+
+
+class WebhookListParams(TypedDict, total=False):
+    iterator: Optional[str]
+    """The iterator returned from a prior invocation"""
+
+    limit: Optional[int]
+    """Limit the number of returned items"""

dodopayments/types/webhook_list_response.py

@@ -0,0 +1,42 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Optional
+
+from .._models import BaseModel
+
+__all__ = ["WebhookListResponse"]
+
+
+class WebhookListResponse(BaseModel):
+    id: str
+    """The webhook's ID."""
+
+    created_at: str
+    """Created at timestamp"""
+
+    description: str
+    """An example webhook name."""
+
+    metadata: Dict[str, str]
+    """Metadata of the webhook"""
+
+    updated_at: str
+    """Updated at timestamp"""
+
+    url: str
+    """Url endpoint of the webhook"""
+
+    disabled: Optional[bool] = None
+    """Status of the webhook.
+
+    If true, events are not sent
+    """
+
+    filter_types: Optional[List[str]] = None
+    """Filter events to the webhook.
+
+    Webhook event will only be sent for events in the list.
+    """
+
+    rate_limit: Optional[int] = None
+    """Configured rate limit"""

dodopayments/types/webhook_retrieve_response.py

@@ -0,0 +1,42 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Optional
+
+from .._models import BaseModel
+
+__all__ = ["WebhookRetrieveResponse"]
+
+
+class WebhookRetrieveResponse(BaseModel):
+    id: str
+    """The webhook's ID."""
+
+    created_at: str
+    """Created at timestamp"""
+
+    description: str
+    """An example webhook name."""
+
+    metadata: Dict[str, str]
+    """Metadata of the webhook"""
+
+    updated_at: str
+    """Updated at timestamp"""
+
+    url: str
+    """Url endpoint of the webhook"""
+
+    disabled: Optional[bool] = None
+    """Status of the webhook.
+
+    If true, events are not sent
+    """
+
+    filter_types: Optional[List[str]] = None
+    """Filter events to the webhook.
+
+    Webhook event will only be sent for events in the list.
+    """
+
+    rate_limit: Optional[int] = None
+    """Configured rate limit"""

dodopayments/types/webhook_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 Dict, List, Optional
+from typing_extensions import TypedDict
+
+from .webhook_event_type import WebhookEventType
+
+__all__ = ["WebhookUpdateParams"]
+
+
+class WebhookUpdateParams(TypedDict, total=False):
+    description: Optional[str]
+    """Description of the webhook"""
+
+    disabled: Optional[bool]
+    """To Disable the endpoint, set it to true."""
+
+    filter_types: Optional[List[WebhookEventType]]
+    """Filter events to the endpoint.
+
+    Webhook event will only be sent for events in the list.
+    """
+
+    metadata: Optional[Dict[str, str]]
+    """Metadata"""
+
+    rate_limit: Optional[int]
+    """Rate limit"""
+
+    url: Optional[str]
+    """Url endpoint"""

dodopayments/types/webhook_update_response.py

@@ -0,0 +1,42 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Optional
+
+from .._models import BaseModel
+
+__all__ = ["WebhookUpdateResponse"]
+
+
+class WebhookUpdateResponse(BaseModel):
+    id: str
+    """The webhook's ID."""
+
+    created_at: str
+    """Created at timestamp"""
+
+    description: str
+    """An example webhook name."""
+
+    metadata: Dict[str, str]
+    """Metadata of the webhook"""
+
+    updated_at: str
+    """Updated at timestamp"""
+
+    url: str
+    """Url endpoint of the webhook"""
+
+    disabled: Optional[bool] = None
+    """Status of the webhook.
+
+    If true, events are not sent
+    """
+
+    filter_types: Optional[List[str]] = None
+    """Filter events to the webhook.
+
+    Webhook event will only be sent for events in the list.
+    """
+
+    rate_limit: Optional[int] = None
+    """Configured rate limit"""

dodopayments/types/webhooks/__init__.py

@@ -0,0 +1,6 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .header_update_params import HeaderUpdateParams as HeaderUpdateParams
+from .header_retrieve_response import HeaderRetrieveResponse as HeaderRetrieveResponse