dodopayments 2.25.0 → 2.26.0

package/src/resources/payouts/breakup/breakup.ts

@@ -0,0 +1,61 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as DetailsAPI from './details';
+import {
+  DetailListParams,
+  DetailListResponse,
+  DetailListResponsesDefaultPageNumberPagination,
+  Details,
+} from './details';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export class Breakup extends APIResource {
+  details: DetailsAPI.Details = new DetailsAPI.Details(this._client);
+
+  /**
+   * Returns the breakdown of a payout by event type (payments, refunds, disputes,
+   * fees, etc.) in the payout's currency. Each amount is proportionally allocated
+   * based on USD equivalent values, ensuring the total sums exactly to the payout
+   * amount.
+   */
+  retrieve(payoutID: string, options?: RequestOptions): APIPromise<BreakupRetrieveResponse> {
+    return this._client.get(path`/payouts/${payoutID}/breakup`, options);
+  }
+}
+
+export type BreakupRetrieveResponse = Array<BreakupRetrieveResponse.BreakupRetrieveResponseItem>;
+
+export namespace BreakupRetrieveResponse {
+  /**
+   * Payout breakup aggregated by event type, with amounts in the payout's currency.
+   */
+  export interface BreakupRetrieveResponseItem {
+    /**
+     * The type of balance ledger event (e.g., "payment", "refund", "dispute",
+     * "payment_fees").
+     */
+    event_type: string;
+
+    /**
+     * Total amount for this event type in the payout's currency (in smallest currency
+     * unit, e.g., cents).
+     */
+    total: number;
+  }
+}
+
+Breakup.Details = Details;
+
+export declare namespace Breakup {
+  export { type BreakupRetrieveResponse as BreakupRetrieveResponse };
+
+  export {
+    Details as Details,
+    type DetailListResponse as DetailListResponse,
+    type DetailListResponsesDefaultPageNumberPagination as DetailListResponsesDefaultPageNumberPagination,
+    type DetailListParams as DetailListParams,
+  };
+}

package/src/resources/payouts/breakup/details.ts

@@ -0,0 +1,111 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import { APIPromise } from '../../../core/api-promise';
+import {
+  DefaultPageNumberPagination,
+  type DefaultPageNumberPaginationParams,
+  PagePromise,
+} from '../../../core/pagination';
+import { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export class Details extends APIResource {
+  /**
+   * Returns paginated individual balance ledger entries for a payout, with each
+   * entry's amount pro-rated into the payout's currency. Supports pagination via
+   * `page_size` (default 10, max 100) and `page_number` (default 0) query
+   * parameters.
+   */
+  list(
+    payoutID: string,
+    query: DetailListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<DetailListResponsesDefaultPageNumberPagination, DetailListResponse> {
+    return this._client.getAPIList(
+      path`/payouts/${payoutID}/breakup/details`,
+      DefaultPageNumberPagination<DetailListResponse>,
+      { query, ...options },
+    );
+  }
+
+  /**
+   * Downloads the complete payout breakup as a CSV file. Each row represents a
+   * balance ledger entry with columns: Ledger ID, Event Type, Original Amount,
+   * Original Currency, Reference Object ID, Description, Created At, USD Equivalent
+   * Amount, and Payout Currency Amount.
+   */
+  downloadCsv(payoutID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.get(path`/payouts/${payoutID}/breakup/details/csv`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export type DetailListResponsesDefaultPageNumberPagination = DefaultPageNumberPagination<DetailListResponse>;
+
+/**
+ * Individual balance ledger entry for a payout, with amounts pro-rated into the
+ * payout's currency.
+ */
+export interface DetailListResponse {
+  /**
+   * Unique identifier of the balance ledger entry.
+   */
+  id: string;
+
+  /**
+   * Timestamp when this entry was created.
+   */
+  created_at: string;
+
+  /**
+   * The type of balance ledger event (e.g., "payment", "refund", "dispute",
+   * "payment_fees").
+   */
+  event_type: string;
+
+  /**
+   * Original amount in the original currency (in smallest currency unit, e.g.,
+   * cents).
+   */
+  original_amount: number;
+
+  /**
+   * Original currency as ISO 4217 code (e.g., "USD", "EUR").
+   */
+  original_currency: string;
+
+  /**
+   * Amount in the payout's currency (in smallest currency unit). Uses cumulative
+   * rounding to ensure sum matches payout total exactly.
+   */
+  payout_currency_amount: number;
+
+  /**
+   * USD equivalent of the original amount (in cents).
+   */
+  usd_equivalent_amount: number;
+
+  /**
+   * Human-readable description of the transaction.
+   */
+  description?: string | null;
+
+  /**
+   * ID of the related object (e.g., payment ID, refund ID) if applicable.
+   */
+  reference_object_id?: string | null;
+}
+
+export interface DetailListParams extends DefaultPageNumberPaginationParams {}
+
+export declare namespace Details {
+  export {
+    type DetailListResponse as DetailListResponse,
+    type DetailListResponsesDefaultPageNumberPagination as DetailListResponsesDefaultPageNumberPagination,
+    type DetailListParams as DetailListParams,
+  };
+}

package/src/resources/payouts/breakup/index.ts

@@ -0,0 +1,9 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Breakup, type BreakupRetrieveResponse } from './breakup';
+export {
+  Details,
+  type DetailListResponse,
+  type DetailListParams,
+  type DetailListResponsesDefaultPageNumberPagination,
+} from './details';

package/src/resources/payouts/breakup.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './breakup/index';

package/src/resources/payouts/index.ts

@@ -0,0 +1,9 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Breakup, type BreakupRetrieveResponse } from './breakup/index';
+export {
+  Payouts,
+  type PayoutListResponse,
+  type PayoutListParams,
+  type PayoutListResponsesDefaultPageNumberPagination,
+} from './payouts';

package/src/resources/payouts/payouts.ts

@@ -0,0 +1,129 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as MiscAPI from '../misc';
+import * as BreakupAPI from './breakup/breakup';
+import { Breakup, BreakupRetrieveResponse } from './breakup/breakup';
+import {
+  DefaultPageNumberPagination,
+  type DefaultPageNumberPaginationParams,
+  PagePromise,
+} from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
+
+export class Payouts extends APIResource {
+  breakup: BreakupAPI.Breakup = new BreakupAPI.Breakup(this._client);
+
+  list(
+    query: PayoutListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<PayoutListResponsesDefaultPageNumberPagination, PayoutListResponse> {
+    return this._client.getAPIList('/payouts', DefaultPageNumberPagination<PayoutListResponse>, {
+      query,
+      ...options,
+    });
+  }
+}
+
+export type PayoutListResponsesDefaultPageNumberPagination = DefaultPageNumberPagination<PayoutListResponse>;
+
+export interface PayoutListResponse {
+  /**
+   * The total amount of the payout.
+   */
+  amount: number;
+
+  /**
+   * The unique identifier of the business associated with the payout.
+   */
+  business_id: string;
+
+  /**
+   * @deprecated The total value of chargebacks associated with the payout.
+   */
+  chargebacks: number;
+
+  /**
+   * The timestamp when the payout was created, in UTC.
+   */
+  created_at: string;
+
+  /**
+   * The currency of the payout, represented as an ISO 4217 currency code.
+   */
+  currency: MiscAPI.Currency;
+
+  /**
+   * The fee charged for processing the payout.
+   */
+  fee: number;
+
+  /**
+   * The payment method used for the payout (e.g., bank transfer, card, etc.).
+   */
+  payment_method: string;
+
+  /**
+   * The unique identifier of the payout.
+   */
+  payout_id: string;
+
+  /**
+   * @deprecated The total value of refunds associated with the payout.
+   */
+  refunds: number;
+
+  /**
+   * The current status of the payout.
+   */
+  status: 'not_initiated' | 'in_progress' | 'on_hold' | 'failed' | 'success';
+
+  /**
+   * @deprecated The tax applied to the payout.
+   */
+  tax: number;
+
+  /**
+   * The timestamp when the payout was last updated, in UTC.
+   */
+  updated_at: string;
+
+  /**
+   * The name of the payout recipient or purpose.
+   */
+  name?: string | null;
+
+  /**
+   * The URL of the document associated with the payout.
+   */
+  payout_document_url?: string | null;
+
+  /**
+   * Any additional remarks or notes associated with the payout.
+   */
+  remarks?: string | null;
+}
+
+export interface PayoutListParams extends DefaultPageNumberPaginationParams {
+  /**
+   * Get payouts created after this time (inclusive)
+   */
+  created_at_gte?: string;
+
+  /**
+   * Get payouts created before this time (inclusive)
+   */
+  created_at_lte?: string;
+}
+
+Payouts.Breakup = Breakup;
+
+export declare namespace Payouts {
+  export {
+    type PayoutListResponse as PayoutListResponse,
+    type PayoutListResponsesDefaultPageNumberPagination as PayoutListResponsesDefaultPageNumberPagination,
+    type PayoutListParams as PayoutListParams,
+  };
+
+  export { Breakup as Breakup, type BreakupRetrieveResponse as BreakupRetrieveResponse };
+}

package/src/resources/payouts.ts

@@ -1,121 +1,3 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../core/resource';
-import * as MiscAPI from './misc';
-import {
-  DefaultPageNumberPagination,
-  type DefaultPageNumberPaginationParams,
-  PagePromise,
-} from '../core/pagination';
-import { RequestOptions } from '../internal/request-options';
-
-export class Payouts extends APIResource {
-  list(
-    query: PayoutListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<PayoutListResponsesDefaultPageNumberPagination, PayoutListResponse> {
-    return this._client.getAPIList('/payouts', DefaultPageNumberPagination<PayoutListResponse>, {
-      query,
-      ...options,
-    });
-  }
-}
-
-export type PayoutListResponsesDefaultPageNumberPagination = DefaultPageNumberPagination<PayoutListResponse>;
-
-export interface PayoutListResponse {
-  /**
-   * The total amount of the payout.
-   */
-  amount: number;
-
-  /**
-   * The unique identifier of the business associated with the payout.
-   */
-  business_id: string;
-
-  /**
-   * @deprecated The total value of chargebacks associated with the payout.
-   */
-  chargebacks: number;
-
-  /**
-   * The timestamp when the payout was created, in UTC.
-   */
-  created_at: string;
-
-  /**
-   * The currency of the payout, represented as an ISO 4217 currency code.
-   */
-  currency: MiscAPI.Currency;
-
-  /**
-   * The fee charged for processing the payout.
-   */
-  fee: number;
-
-  /**
-   * The payment method used for the payout (e.g., bank transfer, card, etc.).
-   */
-  payment_method: string;
-
-  /**
-   * The unique identifier of the payout.
-   */
-  payout_id: string;
-
-  /**
-   * @deprecated The total value of refunds associated with the payout.
-   */
-  refunds: number;
-
-  /**
-   * The current status of the payout.
-   */
-  status: 'not_initiated' | 'in_progress' | 'on_hold' | 'failed' | 'success';
-
-  /**
-   * @deprecated The tax applied to the payout.
-   */
-  tax: number;
-
-  /**
-   * The timestamp when the payout was last updated, in UTC.
-   */
-  updated_at: string;
-
-  /**
-   * The name of the payout recipient or purpose.
-   */
-  name?: string | null;
-
-  /**
-   * The URL of the document associated with the payout.
-   */
-  payout_document_url?: string | null;
-
-  /**
-   * Any additional remarks or notes associated with the payout.
-   */
-  remarks?: string | null;
-}
-
-export interface PayoutListParams extends DefaultPageNumberPaginationParams {
-  /**
-   * Get payouts created after this time (inclusive)
-   */
-  created_at_gte?: string;
-
-  /**
-   * Get payouts created before this time (inclusive)
-   */
-  created_at_lte?: string;
-}
-
-export declare namespace Payouts {
-  export {
-    type PayoutListResponse as PayoutListResponse,
-    type PayoutListResponsesDefaultPageNumberPagination as PayoutListResponsesDefaultPageNumberPagination,
-    type PayoutListParams as PayoutListParams,
-  };
-}
+export * from './payouts/index';

package/src/resources/subscriptions.ts

@@ -1265,6 +1265,12 @@ export interface SubscriptionUpdateParams {
    */
   cancel_at_next_billing_date?: boolean | null;
 
+  cancel_reason?:
+    | 'cancelled_by_customer'
+    | 'cancelled_by_merchant'
+    | 'cancelled_by_merchant_send_dunning'
+    | null;
+
   /**
    * Update credit entitlement cart settings
    */

package/src/resources/webhook-events.ts

@@ -48,7 +48,13 @@ export type WebhookEventType =
   | 'credit.rollover_forfeited'
   | 'credit.overage_charged'
   | 'credit.manual_adjustment'
-  | 'credit.balance_low';
+  | 'credit.balance_low'
+  | 'abandoned_checkout.detected'
+  | 'abandoned_checkout.recovered'
+  | 'dunning.started'
+  | 'dunning.recovered'
+  | 'acr.email'
+  | 'dunning.email';
 
 export interface WebhookPayload {
   business_id: string;
@@ -63,7 +69,9 @@ export interface WebhookPayload {
     | WebhookPayload.Dispute
     | WebhookPayload.LicenseKey
     | WebhookPayload.CreditLedgerEntry
-    | WebhookPayload.CreditBalanceLow;
+    | WebhookPayload.CreditBalanceLow
+    | WebhookPayload.AbandonedCheckout
+    | WebhookPayload.DunningAttempt;
 
   /**
    * The timestamp of when the event occurred (not necessarily the same of when it
@@ -127,6 +135,38 @@ export namespace WebhookPayload {
 
     threshold_percent: number;
   }
+
+  export interface AbandonedCheckout {
+    abandoned_at: string;
+
+    abandonment_reason: 'payment_failed' | 'checkout_incomplete';
+
+    customer_id: string;
+
+    payload_type: 'AbandonedCheckout';
+
+    payment_id: string;
+
+    status: 'abandoned' | 'recovering' | 'recovered' | 'exhausted' | 'opted_out';
+
+    recovered_payment_id?: string | null;
+  }
+
+  export interface DunningAttempt {
+    created_at: string;
+
+    customer_id: string;
+
+    payload_type: 'DunningAttempt';
+
+    status: 'recovering' | 'recovered' | 'exhausted';
+
+    subscription_id: string;
+
+    trigger_state: 'on_hold' | 'cancelled';
+
+    payment_id?: string | null;
+  }
 }
 
 export declare namespace WebhookEvents {

package/src/resources/webhooks/index.ts

@@ -5,6 +5,8 @@ export {
   Webhooks,
   type WebhookDetails,
   type WebhookRetrieveSecretResponse,
+  type AbandonedCheckoutDetectedWebhookEvent,
+  type AbandonedCheckoutRecoveredWebhookEvent,
   type CreditAddedWebhookEvent,
   type CreditBalanceLowWebhookEvent,
   type CreditDeductedWebhookEvent,
@@ -20,6 +22,8 @@ export {
   type DisputeLostWebhookEvent,
   type DisputeOpenedWebhookEvent,
   type DisputeWonWebhookEvent,
+  type DunningRecoveredWebhookEvent,
+  type DunningStartedWebhookEvent,
   type LicenseKeyCreatedWebhookEvent,
   type PaymentCancelledWebhookEvent,
   type PaymentFailedWebhookEvent,