api.md

Dodo Payments API

CheckoutSessions

Methods:

• client.checkout_sessions().create().body(body: CheckoutSessionsCreateParams) -> Result<CheckoutSessionResponse>
• client.checkout_sessions().retrieve().id(id: impl Into<String>) -> Result<CheckoutSessionStatus>
• client.checkout_sessions().preview().body(body: CheckoutSessionsCreateParams) -> Result<CheckoutSessionPreviewResponse>

Payments

Methods:

• client.payments().create().body(body: PaymentsCreateParams) -> Result<PaymentCreateResponse>
• client.payments().retrieve().payment_id(payment_id: impl Into<String>) -> Result<Payment>
• client.payments().list().query(query: serde_json::Value) -> Result<DefaultPageNumberPagination<PaymentListResponse>>
• client.payments().retrieve_line_items().payment_id(payment_id: impl Into<String>) -> Result<PaymentRetrieveLineItemsResponse>

Subscriptions

Methods:

• client.subscriptions().create().body(body: SubscriptionsCreateParams) -> Result<SubscriptionCreateResponse>
• client.subscriptions().retrieve().subscription_id(subscription_id: impl Into<String>) -> Result<Subscription>
• client.subscriptions().update().subscription_id(subscription_id: impl Into<String>).body(body: SubscriptionsUpdateParams) -> Result<Subscription>
• client.subscriptions().list().query(query: serde_json::Value) -> Result<DefaultPageNumberPagination<SubscriptionListResponse>>
• client.subscriptions().cancel_change_plan().subscription_id(subscription_id: impl Into<String>) -> Result<()>
• client.subscriptions().change_plan().subscription_id(subscription_id: impl Into<String>).body(body: SubscriptionsChangePlanParams) -> Result<()>
• client.subscriptions().charge().subscription_id(subscription_id: impl Into<String>).body(body: SubscriptionsChargeParams) -> Result<SubscriptionChargeResponse>
• client.subscriptions().preview_change_plan().subscription_id(subscription_id: impl Into<String>).body(body: SubscriptionsChangePlanParams) -> Result<SubscriptionPreviewChangePlanResponse>
• client.subscriptions().retrieve_credit_usage().subscription_id(subscription_id: impl Into<String>) -> Result<SubscriptionRetrieveCreditUsageResponse>
• client.subscriptions().retrieve_usage_history().subscription_id(subscription_id: impl Into<String>).query(query: serde_json::Value) -> Result<DefaultPageNumberPagination<SubscriptionRetrieveUsageHistoryResponse>>
• client.subscriptions().update_payment_method().subscription_id(subscription_id: impl Into<String>).body(body: serde_json::Value) -> Result<SubscriptionUpdatePaymentMethodResponse>

Invoices

Payments

Methods:

• client.invoices().payments().retrieve().payment_id(payment_id: impl Into<String>) -> Result<Vec<u8>>
• client.invoices().payments().retrieve_payout().payout_id(payout_id: impl Into<String>) -> Result<Vec<u8>>
• client.invoices().payments().retrieve_refund().refund_id(refund_id: impl Into<String>) -> Result<Vec<u8>>

Licenses

Methods:

• client.licenses().activate().body(body: LicensesActivateParams) -> Result<LicenseActivateResponse>
• client.licenses().deactivate().body(body: LicensesDeactivateParams) -> Result<()>
• client.licenses().validate().body(body: LicensesValidateParams) -> Result<LicenseValidateResponse>

LicenseKeys

Methods:

• client.license_keys().create().body(body: LicenseKeysCreateParams) -> Result<LicenseKey>
• client.license_keys().retrieve().id(id: impl Into<String>) -> Result<LicenseKey>
• client.license_keys().update().id(id: impl Into<String>).body(body: LicenseKeysUpdateParams) -> Result<LicenseKey>
• client.license_keys().list().query(query: serde_json::Value) -> Result<DefaultPageNumberPagination<LicenseKey>>

LicenseKeyInstances

Methods:

• client.license_key_instances().retrieve().id(id: impl Into<String>) -> Result<LicenseKeyInstance>
• client.license_key_instances().update().id(id: impl Into<String>).body(body: LicenseKeyInstancesUpdateParams) -> Result<LicenseKeyInstance>
• client.license_key_instances().list().query(query: serde_json::Value) -> Result<DefaultPageNumberPagination<LicenseKeyInstance>>

Customers

Methods:

• client.customers().create().body(body: CustomersCreateParams) -> Result<Customer>
• client.customers().retrieve().customer_id(customer_id: impl Into<String>) -> Result<Customer>
• client.customers().update().customer_id(customer_id: impl Into<String>).body(body: CustomersUpdateParams) -> Result<Customer>
• client.customers().list().query(query: serde_json::Value) -> Result<DefaultPageNumberPagination<Customer>>
• client.customers().delete_payment_method().customer_id(customer_id: impl Into<String>).payment_method_id(payment_method_id: impl Into<String>) -> Result<()>
• client.customers().list_credit_entitlements().customer_id(customer_id: impl Into<String>) -> Result<CustomerListCreditEntitlementsResponse>
• client.customers().list_entitlement_grants().customer_id(customer_id: impl Into<String>).query(query: serde_json::Value) -> Result<DefaultPageNumberPagination<EntitlementGrant>>
• client.customers().list_entitlements().customer_id(customer_id: impl Into<String>) -> Result<CustomerListEntitlementsResponse>
• client.customers().retrieve_payment_methods().customer_id(customer_id: impl Into<String>) -> Result<CustomerRetrievePaymentMethodsResponse>

CustomerPortal

Methods:

• client.customers().customer_portal().create().customer_id(customer_id: impl Into<String>).query(query: serde_json::Value) -> Result<CustomerPortalSession>

Wallets

Methods:

• client.customers().wallets().list().customer_id(customer_id: impl Into<String>) -> Result<WalletListResponse>

LedgerEntries

Methods:

• client.customers().wallets().ledger_entries().create().customer_id(customer_id: impl Into<String>).body(body: CustomersWalletsLedgerEntriesCreateParams) -> Result<CustomerWallet>
• client.customers().wallets().ledger_entries().list().customer_id(customer_id: impl Into<String>).query(query: serde_json::Value) -> Result<DefaultPageNumberPagination<CustomerWalletTransaction>>

Refunds

Methods:

• client.refunds().create().body(body: RefundsCreateParams) -> Result<Refund>
• client.refunds().retrieve().refund_id(refund_id: impl Into<String>) -> Result<Refund>
• client.refunds().list().query(query: serde_json::Value) -> Result<DefaultPageNumberPagination<RefundListItem>>

Disputes

Methods:

• client.disputes().retrieve().dispute_id(dispute_id: impl Into<String>) -> Result<GetDispute>
• client.disputes().list().query(query: serde_json::Value) -> Result<DefaultPageNumberPagination<DisputeListResponse>>

Payouts

Methods:

• client.payouts().list().query(query: serde_json::Value) -> Result<DefaultPageNumberPagination<PayoutListResponse>>

Breakup

Methods:

• client.payouts().breakup().retrieve().payout_id(payout_id: impl Into<String>) -> Result<BreakupRetrieveResponse>

Details

Methods:

• client.payouts().breakup().details().list().payout_id(payout_id: impl Into<String>).query(query: serde_json::Value) -> Result<DefaultPageNumberPagination<DetailListResponse>>
• client.payouts().breakup().details().download_csv().payout_id(payout_id: impl Into<String>) -> Result<()>

Products

Methods:

• client.products().create().body(body: ProductsCreateParams) -> Result<Product>
• client.products().retrieve().id(id: impl Into<String>) -> Result<Product>
• client.products().update().id(id: impl Into<String>).body(body: ProductsUpdateParams) -> Result<()>
• client.products().list().query(query: serde_json::Value) -> Result<DefaultPageNumberPagination<ProductListResponse>>
• client.products().archive().id(id: impl Into<String>) -> Result<()>
• client.products().unarchive().id(id: impl Into<String>) -> Result<()>
• client.products().update_files().id(id: impl Into<String>).body(body: ProductsUpdateFilesParams) -> Result<ProductUpdateFilesResponse>

Images

Methods:

• client.products().images().update().id(id: impl Into<String>).query(query: serde_json::Value) -> Result<ImageUpdateResponse>

ShortLinks

Methods:

• client.products().short_links().create().id(id: impl Into<String>).body(body: ProductsShortLinksCreateParams) -> Result<ShortLinkCreateResponse>
• client.products().short_links().list().query(query: serde_json::Value) -> Result<DefaultPageNumberPagination<ShortLinkListResponse>>

LocalizedPrices

Methods:

• client.products().localized_prices().create().product_id(product_id: impl Into<String>).body(body: ProductsLocalizedPricesCreateParams) -> Result<LocalizedPrice>
• client.products().localized_prices().retrieve().product_id(product_id: impl Into<String>).id(id: impl Into<String>) -> Result<LocalizedPrice>
• client.products().localized_prices().update().product_id(product_id: impl Into<String>).id(id: impl Into<String>).body(body: ProductsLocalizedPricesUpdateParams) -> Result<LocalizedPrice>
• client.products().localized_prices().list().product_id(product_id: impl Into<String>) -> Result<ListLocalizedPricesResponse>
• client.products().localized_prices().archive().product_id(product_id: impl Into<String>).id(id: impl Into<String>) -> Result<()>

Misc

Methods:

• client.misc().list_supported_countries() -> Result<MiscListSupportedCountriesResponse>

Discounts

Methods:

• client.discounts().create().body(body: DiscountsCreateParams) -> Result<Discount>
• client.discounts().retrieve().discount_id(discount_id: impl Into<String>) -> Result<Discount>
• client.discounts().update().discount_id(discount_id: impl Into<String>).body(body: DiscountsUpdateParams) -> Result<Discount>
• client.discounts().list().query(query: serde_json::Value) -> Result<DefaultPageNumberPagination<Discount>>
• client.discounts().delete().discount_id(discount_id: impl Into<String>) -> Result<()>
• client.discounts().retrieve_by_code().code(code: impl Into<String>) -> Result<Discount>

Addons

Methods:

• client.addons().create().body(body: AddonsCreateParams) -> Result<AddonResponse>
• client.addons().retrieve().id(id: impl Into<String>) -> Result<AddonResponse>
• client.addons().update().id(id: impl Into<String>).body(body: AddonsUpdateParams) -> Result<AddonResponse>
• client.addons().list().query(query: serde_json::Value) -> Result<DefaultPageNumberPagination<AddonResponse>>
• client.addons().update_images().id(id: impl Into<String>) -> Result<AddonUpdateImagesResponse>

Brands

Methods:

• client.brands().create().body(body: BrandsCreateParams) -> Result<Brand>
• client.brands().retrieve().id(id: impl Into<String>) -> Result<Brand>
• client.brands().update().id(id: impl Into<String>).body(body: BrandsUpdateParams) -> Result<Brand>
• client.brands().list() -> Result<BrandListResponse>
• client.brands().update_images().id(id: impl Into<String>) -> Result<BrandUpdateImagesResponse>

Webhooks

Methods:

• client.webhooks().create().body(body: WebhooksCreateParams) -> Result<WebhookDetails>
• client.webhooks().retrieve().webhook_id(webhook_id: impl Into<String>) -> Result<WebhookDetails>
• client.webhooks().update().webhook_id(webhook_id: impl Into<String>).body(body: WebhooksUpdateParams) -> Result<WebhookDetails>
• client.webhooks().list().query(query: serde_json::Value) -> Result<CursorPagePagination<WebhookDetails>>
• client.webhooks().delete().webhook_id(webhook_id: impl Into<String>) -> Result<()>
• client.webhooks().retrieve_secret().webhook_id(webhook_id: impl Into<String>) -> Result<WebhookRetrieveSecretResponse>

Headers

Methods:

• client.webhooks().headers().retrieve().webhook_id(webhook_id: impl Into<String>) -> Result<HeaderRetrieveResponse>
• client.webhooks().headers().update().webhook_id(webhook_id: impl Into<String>).body(body: WebhooksHeadersUpdateParams) -> Result<()>

UsageEvents

Methods:

• client.usage_events().retrieve().event_id(event_id: impl Into<String>) -> Result<Event>
• client.usage_events().list().query(query: serde_json::Value) -> Result<DefaultPageNumberPagination<Event>>
• client.usage_events().ingest().body(body: UsageEventsIngestParams) -> Result<UsageEventIngestResponse>

Meters

Methods:

• client.meters().create().body(body: MetersCreateParams) -> Result<Meter>
• client.meters().retrieve().id(id: impl Into<String>) -> Result<Meter>
• client.meters().list().query(query: serde_json::Value) -> Result<DefaultPageNumberPagination<Meter>>
• client.meters().archive().id(id: impl Into<String>) -> Result<()>
• client.meters().unarchive().id(id: impl Into<String>) -> Result<()>

Balances

Methods:

• client.balances().retrieve_ledger().query(query: serde_json::Value) -> Result<DefaultPageNumberPagination<BalanceLedgerEntry>>

CreditEntitlements

Methods:

• client.credit_entitlements().create().body(body: CreditEntitlementsCreateParams) -> Result<CreditEntitlement>
• client.credit_entitlements().retrieve().id(id: impl Into<String>) -> Result<CreditEntitlement>
• client.credit_entitlements().update().id(id: impl Into<String>).body(body: CreditEntitlementsUpdateParams) -> Result<()>
• client.credit_entitlements().list().query(query: serde_json::Value) -> Result<DefaultPageNumberPagination<CreditEntitlement>>
• client.credit_entitlements().delete().id(id: impl Into<String>) -> Result<()>
• client.credit_entitlements().undelete().id(id: impl Into<String>) -> Result<()>

Balances

Methods:

• client.credit_entitlements().balances().retrieve().credit_entitlement_id(credit_entitlement_id: impl Into<String>).customer_id(customer_id: impl Into<String>) -> Result<CustomerCreditBalance>
• client.credit_entitlements().balances().list().credit_entitlement_id(credit_entitlement_id: impl Into<String>).query(query: serde_json::Value) -> Result<DefaultPageNumberPagination<CustomerCreditBalance>>
• client.credit_entitlements().balances().create_ledger_entry().credit_entitlement_id(credit_entitlement_id: impl Into<String>).customer_id(customer_id: impl Into<String>).body(body: CreditEntitlementsBalancesCreateLedgerEntryParams) -> Result<BalanceCreateLedgerEntryResponse>
• client.credit_entitlements().balances().list_grants().credit_entitlement_id(credit_entitlement_id: impl Into<String>).customer_id(customer_id: impl Into<String>).query(query: serde_json::Value) -> Result<DefaultPageNumberPagination<BalanceListGrantsResponse>>
• client.credit_entitlements().balances().list_ledger().credit_entitlement_id(credit_entitlement_id: impl Into<String>).customer_id(customer_id: impl Into<String>).query(query: serde_json::Value) -> Result<DefaultPageNumberPagination<CreditLedgerEntry>>

Entitlements

Methods:

• client.entitlements().create().body(body: EntitlementsCreateParams) -> Result<Entitlement>
• client.entitlements().retrieve().id(id: impl Into<String>) -> Result<Entitlement>
• client.entitlements().update().id(id: impl Into<String>).body(body: EntitlementsUpdateParams) -> Result<Entitlement>
• client.entitlements().list().query(query: serde_json::Value) -> Result<DefaultPageNumberPagination<Entitlement>>
• client.entitlements().delete().id(id: impl Into<String>) -> Result<()>

Files

Methods:

• client.entitlements().files().delete().id(id: impl Into<String>).file_id(file_id: impl Into<String>) -> Result<()>
• client.entitlements().files().upload().id(id: impl Into<String>) -> Result<FileUploadResponse>

Grants

Methods:

• client.entitlements().grants().list().id(id: impl Into<String>).query(query: serde_json::Value) -> Result<DefaultPageNumberPagination<EntitlementGrant>>
• client.entitlements().grants().fulfill_license_key().grant_id(grant_id: impl Into<String>).body(body: EntitlementsGrantsFulfillLicenseKeyParams) -> Result<EntitlementGrant>
• client.entitlements().grants().revoke().id(id: impl Into<String>).grant_id(grant_id: impl Into<String>) -> Result<EntitlementGrant>

ProductCollections

Methods:

• client.product_collections().create().body(body: ProductCollectionsCreateParams) -> Result<ProductCollection>
• client.product_collections().retrieve().id(id: impl Into<String>) -> Result<ProductCollection>
• client.product_collections().update().id(id: impl Into<String>).body(body: ProductCollectionsUpdateParams) -> Result<()>
• client.product_collections().list().query(query: serde_json::Value) -> Result<DefaultPageNumberPagination<ProductCollectionListResponse>>
• client.product_collections().delete().id(id: impl Into<String>) -> Result<()>
• client.product_collections().unarchive().id(id: impl Into<String>) -> Result<ProductCollectionUnarchiveResponse>
• client.product_collections().update_images().id(id: impl Into<String>).query(query: serde_json::Value) -> Result<ProductCollectionUpdateImagesResponse>

Groups

Methods:

• client.product_collections().groups().create().id(id: impl Into<String>).body(body: ProductCollectionsGroupsCreateParams) -> Result<ProductCollectionGroupResponse>
• client.product_collections().groups().update().id(id: impl Into<String>).group_id(group_id: impl Into<String>).body(body: ProductCollectionsGroupsUpdateParams) -> Result<()>
• client.product_collections().groups().delete().id(id: impl Into<String>).group_id(group_id: impl Into<String>) -> Result<()>

Items

Methods:

• client.product_collections().groups().items().create().id(id: impl Into<String>).group_id(group_id: impl Into<String>).body(body: ProductCollectionsGroupsItemsCreateParams) -> Result<ItemCreateResponse>
• client.product_collections().groups().items().update().id(id: impl Into<String>).group_id(group_id: impl Into<String>).item_id(item_id: impl Into<String>).body(body: ProductCollectionsGroupsItemsUpdateParams) -> Result<()>
• client.product_collections().groups().items().delete().id(id: impl Into<String>).group_id(group_id: impl Into<String>).item_id(item_id: impl Into<String>) -> Result<()>