api.md

CheckoutSessions

Types:

from dodopayments.types import (
    CheckoutSessionBillingAddress,
    CheckoutSessionCustomization,
    CheckoutSessionFlags,
    CheckoutSessionRequest,
    CheckoutSessionResponse,
    CheckoutSessionStatus,
    CustomField,
    ProductItemReq,
    SubscriptionData,
    ThemeConfig,
    ThemeModeConfig,
    CheckoutSessionPreviewResponse,
)

Methods:

• client.checkout_sessions.create(**params) -> CheckoutSessionResponse
• client.checkout_sessions.retrieve(id) -> CheckoutSessionStatus
• client.checkout_sessions.preview(**params) -> CheckoutSessionPreviewResponse

Payments

Types:

from dodopayments.types import (
    AttachExistingCustomer,
    BillingAddress,
    CreateNewCustomer,
    CustomFieldResponse,
    CustomerLimitedDetails,
    CustomerRequest,
    IntentStatus,
    NewCustomer,
    OneTimeProductCartItem,
    Payment,
    PaymentMethodTypes,
    PaymentRefundStatus,
    RefundListItem,
    PaymentCreateResponse,
    PaymentListResponse,
    PaymentRetrieveLineItemsResponse,
)

Methods:

• client.payments.create(**params) -> PaymentCreateResponse
• client.payments.retrieve(payment_id) -> Payment
• client.payments.list(**params) -> SyncDefaultPageNumberPagination[PaymentListResponse]
• client.payments.retrieve_line_items(payment_id) -> PaymentRetrieveLineItemsResponse

Subscriptions

Types:

from dodopayments.types import (
    AddonCartResponseItem,
    AttachAddon,
    CreditEntitlementCartResponse,
    MeterCartResponseItem,
    MeterCreditEntitlementCartResponse,
    OnDemandSubscription,
    Subscription,
    SubscriptionStatus,
    TimeInterval,
    UpdateSubscriptionPlanReq,
    SubscriptionCreateResponse,
    SubscriptionListResponse,
    SubscriptionChargeResponse,
    SubscriptionPreviewChangePlanResponse,
    SubscriptionRetrieveCreditUsageResponse,
    SubscriptionRetrieveUsageHistoryResponse,
    SubscriptionUpdatePaymentMethodResponse,
)

Methods:

• client.subscriptions.create(**params) -> SubscriptionCreateResponse
• client.subscriptions.retrieve(subscription_id) -> Subscription
• client.subscriptions.update(subscription_id, **params) -> Subscription
• client.subscriptions.list(**params) -> SyncDefaultPageNumberPagination[SubscriptionListResponse]
• client.subscriptions.cancel_change_plan(subscription_id) -> None
• client.subscriptions.change_plan(subscription_id, **params) -> None
• client.subscriptions.charge(subscription_id, **params) -> SubscriptionChargeResponse
• client.subscriptions.preview_change_plan(subscription_id, **params) -> SubscriptionPreviewChangePlanResponse
• client.subscriptions.retrieve_credit_usage(subscription_id) -> SubscriptionRetrieveCreditUsageResponse
• client.subscriptions.retrieve_usage_history(subscription_id, **params) -> SyncDefaultPageNumberPagination[SubscriptionRetrieveUsageHistoryResponse]
• client.subscriptions.update_payment_method(subscription_id, **params) -> SubscriptionUpdatePaymentMethodResponse

Invoices

Payments

Methods:

• client.invoices.payments.retrieve(payment_id) -> BinaryAPIResponse
• client.invoices.payments.retrieve_refund(refund_id) -> BinaryAPIResponse

Licenses

Types:

from dodopayments.types import LicenseActivateResponse, LicenseValidateResponse

Methods:

• client.licenses.activate(**params) -> LicenseActivateResponse
• client.licenses.deactivate(**params) -> None
• client.licenses.validate(**params) -> LicenseValidateResponse

LicenseKeys

Types:

from dodopayments.types import LicenseKey, LicenseKeyStatus

Methods:

• client.license_keys.create(**params) -> LicenseKey
• client.license_keys.retrieve(id) -> LicenseKey
• client.license_keys.update(id, **params) -> LicenseKey
• client.license_keys.list(**params) -> SyncDefaultPageNumberPagination[LicenseKey]

LicenseKeyInstances

Types:

from dodopayments.types import LicenseKeyInstance

Methods:

• client.license_key_instances.retrieve(id) -> LicenseKeyInstance
• client.license_key_instances.update(id, **params) -> LicenseKeyInstance
• client.license_key_instances.list(**params) -> SyncDefaultPageNumberPagination[LicenseKeyInstance]

Customers

Types:

from dodopayments.types import (
    Customer,
    CustomerPortalSession,
    CustomerListCreditEntitlementsResponse,
    CustomerRetrievePaymentMethodsResponse,
)

Methods:

• client.customers.create(**params) -> Customer
• client.customers.retrieve(customer_id) -> Customer
• client.customers.update(customer_id, **params) -> Customer
• client.customers.list(**params) -> SyncDefaultPageNumberPagination[Customer]
• client.customers.delete_payment_method(payment_method_id, *, customer_id) -> None
• client.customers.list_credit_entitlements(customer_id) -> CustomerListCreditEntitlementsResponse
• client.customers.retrieve_payment_methods(customer_id) -> CustomerRetrievePaymentMethodsResponse

CustomerPortal

Methods:

• client.customers.customer_portal.create(customer_id, **params) -> CustomerPortalSession

Wallets

Types:

from dodopayments.types.customers import CustomerWallet, WalletListResponse

Methods:

• client.customers.wallets.list(customer_id) -> WalletListResponse

LedgerEntries

Types:

from dodopayments.types.customers.wallets import CustomerWalletTransaction

Methods:

• client.customers.wallets.ledger_entries.create(customer_id, **params) -> CustomerWallet
• client.customers.wallets.ledger_entries.list(customer_id, **params) -> SyncDefaultPageNumberPagination[CustomerWalletTransaction]

Refunds

Types:

from dodopayments.types import Refund, RefundStatus

Methods:

• client.refunds.create(**params) -> Refund
• client.refunds.retrieve(refund_id) -> Refund
• client.refunds.list(**params) -> SyncDefaultPageNumberPagination[RefundListItem]

Disputes

Types:

from dodopayments.types import Dispute, DisputeStage, DisputeStatus, GetDispute, DisputeListResponse

Methods:

• client.disputes.retrieve(dispute_id) -> GetDispute
• client.disputes.list(**params) -> SyncDefaultPageNumberPagination[DisputeListResponse]

Payouts

Types:

from dodopayments.types import PayoutListResponse

Methods:

• client.payouts.list(**params) -> SyncDefaultPageNumberPagination[PayoutListResponse]

Breakup

Types:

from dodopayments.types.payouts import BreakupRetrieveResponse

Methods:

• client.payouts.breakup.retrieve(payout_id) -> BreakupRetrieveResponse

Details

Types:

from dodopayments.types.payouts.breakup import DetailListResponse

Methods:

• client.payouts.breakup.details.list(payout_id, **params) -> SyncDefaultPageNumberPagination[DetailListResponse]
• client.payouts.breakup.details.download_csv(payout_id) -> None

Products

Types:

from dodopayments.types import (
    AddMeterToPrice,
    AttachCreditEntitlement,
    CbbProrationBehavior,
    CreditEntitlementMappingResponse,
    DigitalProductDelivery,
    DigitalProductDeliveryFile,
    LicenseKeyDuration,
    Price,
    Product,
    ProductListResponse,
    ProductUpdateFilesResponse,
)

Methods:

• client.products.create(**params) -> Product
• client.products.retrieve(id) -> Product
• client.products.update(id, **params) -> None
• client.products.list(**params) -> SyncDefaultPageNumberPagination[ProductListResponse]
• client.products.archive(id) -> None
• client.products.unarchive(id) -> None
• client.products.update_files(id, **params) -> ProductUpdateFilesResponse

Images

Types:

from dodopayments.types.products import ImageUpdateResponse

Methods:

• client.products.images.update(id, **params) -> ImageUpdateResponse

ShortLinks

Types:

from dodopayments.types.products import ShortLinkCreateResponse, ShortLinkListResponse

Methods:

• client.products.short_links.create(id, **params) -> ShortLinkCreateResponse
• client.products.short_links.list(**params) -> SyncDefaultPageNumberPagination[ShortLinkListResponse]

Misc

Types:

from dodopayments.types import (
    CountryCode,
    Currency,
    TaxCategory,
    MiscListSupportedCountriesResponse,
)

Methods:

• client.misc.list_supported_countries() -> MiscListSupportedCountriesResponse

Discounts

Types:

from dodopayments.types import Discount, DiscountType

Methods:

• client.discounts.create(**params) -> Discount
• client.discounts.retrieve(discount_id) -> Discount
• client.discounts.update(discount_id, **params) -> Discount
• client.discounts.list(**params) -> SyncDefaultPageNumberPagination[Discount]
• client.discounts.delete(discount_id) -> None
• client.discounts.retrieve_by_code(code) -> Discount

Addons

Types:

from dodopayments.types import AddonResponse, AddonUpdateImagesResponse

Methods:

• client.addons.create(**params) -> AddonResponse
• client.addons.retrieve(id) -> AddonResponse
• client.addons.update(id, **params) -> AddonResponse
• client.addons.list(**params) -> SyncDefaultPageNumberPagination[AddonResponse]
• client.addons.update_images(id) -> AddonUpdateImagesResponse

Brands

Types:

from dodopayments.types import Brand, BrandListResponse, BrandUpdateImagesResponse

Methods:

• client.brands.create(**params) -> Brand
• client.brands.retrieve(id) -> Brand
• client.brands.update(id, **params) -> Brand
• client.brands.list() -> BrandListResponse
• client.brands.update_images(id) -> BrandUpdateImagesResponse

Webhooks

Types:

from dodopayments.types import (
    WebhookDetails,
    WebhookRetrieveSecretResponse,
    AbandonedCheckoutDetectedWebhookEvent,
    AbandonedCheckoutRecoveredWebhookEvent,
    CreditAddedWebhookEvent,
    CreditBalanceLowWebhookEvent,
    CreditDeductedWebhookEvent,
    CreditExpiredWebhookEvent,
    CreditManualAdjustmentWebhookEvent,
    CreditOverageChargedWebhookEvent,
    CreditRolledOverWebhookEvent,
    CreditRolloverForfeitedWebhookEvent,
    DisputeAcceptedWebhookEvent,
    DisputeCancelledWebhookEvent,
    DisputeChallengedWebhookEvent,
    DisputeExpiredWebhookEvent,
    DisputeLostWebhookEvent,
    DisputeOpenedWebhookEvent,
    DisputeWonWebhookEvent,
    DunningRecoveredWebhookEvent,
    DunningStartedWebhookEvent,
    LicenseKeyCreatedWebhookEvent,
    PaymentCancelledWebhookEvent,
    PaymentFailedWebhookEvent,
    PaymentProcessingWebhookEvent,
    PaymentSucceededWebhookEvent,
    RefundFailedWebhookEvent,
    RefundSucceededWebhookEvent,
    SubscriptionActiveWebhookEvent,
    SubscriptionCancelledWebhookEvent,
    SubscriptionExpiredWebhookEvent,
    SubscriptionFailedWebhookEvent,
    SubscriptionOnHoldWebhookEvent,
    SubscriptionPlanChangedWebhookEvent,
    SubscriptionRenewedWebhookEvent,
    SubscriptionUpdatedWebhookEvent,
    AbandonedCheckoutDetectedWebhookEvent,
    AbandonedCheckoutRecoveredWebhookEvent,
    CreditAddedWebhookEvent,
    CreditBalanceLowWebhookEvent,
    CreditDeductedWebhookEvent,
    CreditExpiredWebhookEvent,
    CreditManualAdjustmentWebhookEvent,
    CreditOverageChargedWebhookEvent,
    CreditRolledOverWebhookEvent,
    CreditRolloverForfeitedWebhookEvent,
    DisputeAcceptedWebhookEvent,
    DisputeCancelledWebhookEvent,
    DisputeChallengedWebhookEvent,
    DisputeExpiredWebhookEvent,
    DisputeLostWebhookEvent,
    DisputeOpenedWebhookEvent,
    DisputeWonWebhookEvent,
    DunningRecoveredWebhookEvent,
    DunningStartedWebhookEvent,
    LicenseKeyCreatedWebhookEvent,
    PaymentCancelledWebhookEvent,
    PaymentFailedWebhookEvent,
    PaymentProcessingWebhookEvent,
    PaymentSucceededWebhookEvent,
    RefundFailedWebhookEvent,
    RefundSucceededWebhookEvent,
    SubscriptionActiveWebhookEvent,
    SubscriptionCancelledWebhookEvent,
    SubscriptionExpiredWebhookEvent,
    SubscriptionFailedWebhookEvent,
    SubscriptionOnHoldWebhookEvent,
    SubscriptionPlanChangedWebhookEvent,
    SubscriptionRenewedWebhookEvent,
    SubscriptionUpdatedWebhookEvent,
    UnsafeUnwrapWebhookEvent,
    UnwrapWebhookEvent,
)

Methods:

• client.webhooks.create(**params) -> WebhookDetails
• client.webhooks.retrieve(webhook_id) -> WebhookDetails
• client.webhooks.update(webhook_id, **params) -> WebhookDetails
• client.webhooks.list(**params) -> SyncCursorPagePagination[WebhookDetails]
• client.webhooks.delete(webhook_id) -> None
• client.webhooks.retrieve_secret(webhook_id) -> WebhookRetrieveSecretResponse

Headers

Types:

from dodopayments.types.webhooks import HeaderRetrieveResponse

Methods:

• client.webhooks.headers.retrieve(webhook_id) -> HeaderRetrieveResponse
• client.webhooks.headers.update(webhook_id, **params) -> None

WebhookEvents

Types:

from dodopayments.types import WebhookEventType, WebhookPayload

UsageEvents

Types:

from dodopayments.types import Event, EventInput, UsageEventIngestResponse

Methods:

• client.usage_events.retrieve(event_id) -> Event
• client.usage_events.list(**params) -> SyncDefaultPageNumberPagination[Event]
• client.usage_events.ingest(**params) -> UsageEventIngestResponse

Meters

Types:

from dodopayments.types import Conjunction, FilterOperator, Meter, MeterAggregation, MeterFilter

Methods:

• client.meters.create(**params) -> Meter
• client.meters.retrieve(id) -> Meter
• client.meters.list(**params) -> SyncDefaultPageNumberPagination[Meter]
• client.meters.archive(id) -> None
• client.meters.unarchive(id) -> None

Balances

Types:

from dodopayments.types import BalanceLedgerEntry

Methods:

• client.balances.retrieve_ledger(**params) -> SyncDefaultPageNumberPagination[BalanceLedgerEntry]

CreditEntitlements

Types:

from dodopayments.types import CbbOverageBehavior, CreditEntitlement

Methods:

• client.credit_entitlements.create(**params) -> CreditEntitlement
• client.credit_entitlements.retrieve(id) -> CreditEntitlement
• client.credit_entitlements.update(id, **params) -> None
• client.credit_entitlements.list(**params) -> SyncDefaultPageNumberPagination[CreditEntitlement]
• client.credit_entitlements.delete(id) -> None
• client.credit_entitlements.undelete(id) -> None

Balances

Types:

from dodopayments.types.credit_entitlements import (
    CreditLedgerEntry,
    CustomerCreditBalance,
    LedgerEntryType,
    BalanceCreateLedgerEntryResponse,
    BalanceListGrantsResponse,
)

Methods:

• client.credit_entitlements.balances.retrieve(customer_id, *, credit_entitlement_id) -> CustomerCreditBalance
• client.credit_entitlements.balances.list(credit_entitlement_id, **params) -> SyncDefaultPageNumberPagination[CustomerCreditBalance]
• client.credit_entitlements.balances.create_ledger_entry(customer_id, *, credit_entitlement_id, **params) -> BalanceCreateLedgerEntryResponse
• client.credit_entitlements.balances.list_grants(customer_id, *, credit_entitlement_id, **params) -> SyncDefaultPageNumberPagination[BalanceListGrantsResponse]
• client.credit_entitlements.balances.list_ledger(customer_id, *, credit_entitlement_id, **params) -> SyncDefaultPageNumberPagination[CreditLedgerEntry]