dodopayments 2.50.0 → 2.52.0

package/resources/payouts/breakup/breakup.d.mts

@@ -24,11 +24,27 @@ export type BreakupRetrieveResponse = Array<BreakupRetrieveResponse.BreakupRetri
 export declare namespace BreakupRetrieveResponse {
     /**
      * Payout breakup aggregated by event type, with amounts in the payout's currency.
+     *
+     * The rows sum to the payout amount. The last row can be `unattributed`, which is
+     * not a ledger event type. It holds the payout amount less the entries that fund
+     * it, and it takes either sign:
+     *
+     * - Positive: the entries come to less than the payout, so the payout drew on the
+     *   balance an earlier cycle left over. A cycle of refunds and disputes produces a
+     *   large positive value.
+     * - Negative: the entries come to more than the payout, and the remainder funds a
+     *   later payout. This is the common case, for two reasons. The walk that claims
+     *   the entries stops at the first one that reaches its target, so it passes the
+     *   target by part of an entry. The target is also the gross debit, which holds
+     *   the payout fee, and the fee is not a line here.
+     *
+     * The row is absent when the two are equal.
      */
     interface BreakupRetrieveResponseItem {
         /**
          * The type of balance ledger event (e.g., "payment", "refund", "dispute",
-         * "payment_fees").
+         * "payment_fees"), or `unattributed` for the payout amount the entries do not
+         * account for.
          */
         event_type: string;
         /**

package/resources/payouts/breakup/breakup.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"breakup.d.mts","sourceRoot":"","sources":["../../../src/resources/payouts/breakup/breakup.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,mCAA+B;AACrD,OAAO,KAAK,UAAU,sBAAkB;AACxC,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,8CAA8C,EAC9C,OAAO,EACR,sBAAkB;AACnB,OAAO,EAAE,UAAU,EAAE,sCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,8CAA0C;AAGnE,qBAAa,OAAQ,SAAQ,WAAW;IACtC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IAEnE;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;CAG1F;AAED,MAAM,MAAM,uBAAuB,GAAG,KAAK,CAAC,uBAAuB,CAAC,2BAA2B,CAAC,CAAC;AAEjG,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,2BAA2B;QAC1C;;;WAGG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAID,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EAAE,KAAK,uBAAuB,IAAI,uBAAuB,EAAE,CAAC;IAEnE,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,8CAA8C,IAAI,8CAA8C,EACrG,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
+{"version":3,"file":"breakup.d.mts","sourceRoot":"","sources":["../../../src/resources/payouts/breakup/breakup.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,mCAA+B;AACrD,OAAO,KAAK,UAAU,sBAAkB;AACxC,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,8CAA8C,EAC9C,OAAO,EACR,sBAAkB;AACnB,OAAO,EAAE,UAAU,EAAE,sCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,8CAA0C;AAGnE,qBAAa,OAAQ,SAAQ,WAAW;IACtC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IAEnE;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;CAG1F;AAED,MAAM,MAAM,uBAAuB,GAAG,KAAK,CAAC,uBAAuB,CAAC,2BAA2B,CAAC,CAAC;AAEjG,yBAAiB,uBAAuB,CAAC;IACvC;;;;;;;;;;;;;;;;;OAiBG;IACH,UAAiB,2BAA2B;QAC1C;;;;WAIG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAID,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EAAE,KAAK,uBAAuB,IAAI,uBAAuB,EAAE,CAAC;IAEnE,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,8CAA8C,IAAI,8CAA8C,EACrG,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}

package/resources/payouts/breakup/breakup.d.ts

@@ -24,11 +24,27 @@ export type BreakupRetrieveResponse = Array<BreakupRetrieveResponse.BreakupRetri
 export declare namespace BreakupRetrieveResponse {
     /**
      * Payout breakup aggregated by event type, with amounts in the payout's currency.
+     *
+     * The rows sum to the payout amount. The last row can be `unattributed`, which is
+     * not a ledger event type. It holds the payout amount less the entries that fund
+     * it, and it takes either sign:
+     *
+     * - Positive: the entries come to less than the payout, so the payout drew on the
+     *   balance an earlier cycle left over. A cycle of refunds and disputes produces a
+     *   large positive value.
+     * - Negative: the entries come to more than the payout, and the remainder funds a
+     *   later payout. This is the common case, for two reasons. The walk that claims
+     *   the entries stops at the first one that reaches its target, so it passes the
+     *   target by part of an entry. The target is also the gross debit, which holds
+     *   the payout fee, and the fee is not a line here.
+     *
+     * The row is absent when the two are equal.
      */
     interface BreakupRetrieveResponseItem {
         /**
          * The type of balance ledger event (e.g., "payment", "refund", "dispute",
-         * "payment_fees").
+         * "payment_fees"), or `unattributed` for the payout amount the entries do not
+         * account for.
          */
         event_type: string;
         /**

package/resources/payouts/breakup/breakup.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"breakup.d.ts","sourceRoot":"","sources":["../../../src/resources/payouts/breakup/breakup.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,KAAK,UAAU,qBAAkB;AACxC,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,8CAA8C,EAC9C,OAAO,EACR,qBAAkB;AACnB,OAAO,EAAE,UAAU,EAAE,qCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAGnE,qBAAa,OAAQ,SAAQ,WAAW;IACtC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IAEnE;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;CAG1F;AAED,MAAM,MAAM,uBAAuB,GAAG,KAAK,CAAC,uBAAuB,CAAC,2BAA2B,CAAC,CAAC;AAEjG,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,2BAA2B;QAC1C;;;WAGG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAID,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EAAE,KAAK,uBAAuB,IAAI,uBAAuB,EAAE,CAAC;IAEnE,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,8CAA8C,IAAI,8CAA8C,EACrG,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
+{"version":3,"file":"breakup.d.ts","sourceRoot":"","sources":["../../../src/resources/payouts/breakup/breakup.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,KAAK,UAAU,qBAAkB;AACxC,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,8CAA8C,EAC9C,OAAO,EACR,qBAAkB;AACnB,OAAO,EAAE,UAAU,EAAE,qCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAGnE,qBAAa,OAAQ,SAAQ,WAAW;IACtC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IAEnE;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;CAG1F;AAED,MAAM,MAAM,uBAAuB,GAAG,KAAK,CAAC,uBAAuB,CAAC,2BAA2B,CAAC,CAAC;AAEjG,yBAAiB,uBAAuB,CAAC;IACvC;;;;;;;;;;;;;;;;;OAiBG;IACH,UAAiB,2BAA2B;QAC1C;;;;WAIG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAID,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EAAE,KAAK,uBAAuB,IAAI,uBAAuB,EAAE,CAAC;IAEnE,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,8CAA8C,IAAI,8CAA8C,EACrG,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}

package/resources/payouts/breakup/breakup.js.map

@@ -1 +1 @@
-{"version":3,"file":"breakup.js","sourceRoot":"","sources":["../../../src/resources/payouts/breakup/breakup.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,wDAAqD;AACrD,iEAAwC;AACxC,0CAKmB;AAGnB,0DAAoD;AAEpD,MAAa,OAAQ,SAAQ,sBAAW;IAAxC;;QACE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAkBrE,CAAC;IAhBC;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,QAAgB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,UAAU,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;CACF;AAnBD,0BAmBC;AAuBD,OAAO,CAAC,OAAO,GAAG,iBAAO,CAAC"}
+{"version":3,"file":"breakup.js","sourceRoot":"","sources":["../../../src/resources/payouts/breakup/breakup.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,wDAAqD;AACrD,iEAAwC;AACxC,0CAKmB;AAGnB,0DAAoD;AAEpD,MAAa,OAAQ,SAAQ,sBAAW;IAAxC;;QACE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAkBrE,CAAC;IAhBC;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,QAAgB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,UAAU,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;CACF;AAnBD,0BAmBC;AAuCD,OAAO,CAAC,OAAO,GAAG,iBAAO,CAAC"}

package/resources/payouts/breakup/breakup.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"breakup.mjs","sourceRoot":"","sources":["../../../src/resources/payouts/breakup/breakup.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,mCAA+B;AACrD,OAAO,KAAK,UAAU,sBAAkB;AACxC,OAAO,EAIL,OAAO,GACR,sBAAkB;AAGnB,OAAO,EAAE,IAAI,EAAE,yCAAqC;AAEpD,MAAM,OAAO,OAAQ,SAAQ,WAAW;IAAxC;;QACE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAkBrE,CAAC;IAhBC;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,QAAgB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,QAAQ,UAAU,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;CACF;AAuBD,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC"}
+{"version":3,"file":"breakup.mjs","sourceRoot":"","sources":["../../../src/resources/payouts/breakup/breakup.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,mCAA+B;AACrD,OAAO,KAAK,UAAU,sBAAkB;AACxC,OAAO,EAIL,OAAO,GACR,sBAAkB;AAGnB,OAAO,EAAE,IAAI,EAAE,yCAAqC;AAEpD,MAAM,OAAO,OAAQ,SAAQ,WAAW;IAAxC;;QACE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAkBrE,CAAC;IAhBC;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,QAAgB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,QAAQ,UAAU,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;CACF;AAuCD,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC"}

package/resources/payouts/breakup/details.d.mts

@@ -4,10 +4,10 @@ import { DefaultPageNumberPagination, type DefaultPageNumberPaginationParams, Pa
 import { RequestOptions } from "../../../internal/request-options.mjs";
 export declare 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.
+     * Returns paginated individual balance ledger entries for a payout. Each entry is
+     * converted into the payout's currency at the rate the payout settled at. Supports
+     * pagination via `page_size` (default 10, max 100) and `page_number` (default 0)
+     * query parameters.
      *
      * @example
      * ```ts
@@ -37,8 +37,8 @@ export declare class Details extends APIResource {
 }
 export type DetailListResponsesDefaultPageNumberPagination = DefaultPageNumberPagination<DetailListResponse>;
 /**
- * Individual balance ledger entry for a payout, with amounts pro-rated into the
- * payout's currency.
+ * Individual balance ledger entry for a payout, converted into the payout's
+ * currency.
  */
 export interface DetailListResponse {
     /**
@@ -65,8 +65,9 @@ export interface DetailListResponse {
     original_currency: string;
     /**
      * Amount in the payout's currency, in that currency's smallest unit (cents for
-     * USD, yen for JPY, fils for KWD). Uses cumulative rounding to ensure sum matches
-     * payout total exactly.
+     * USD, yen for JPY, fils for KWD). The entry is converted at the rate the payout
+     * settled at. These amounts sum to the value of the entries, which can be less
+     * than the payout: the grouped breakup reports the difference as `unattributed`.
      */
     payout_currency_amount: number;
     /**

package/resources/payouts/breakup/details.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"details.d.mts","sourceRoot":"","sources":["../../../src/resources/payouts/breakup/details.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,mCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,sCAAkC;AACvD,OAAO,EACL,2BAA2B,EAC3B,KAAK,iCAAiC,EACtC,WAAW,EACZ,qCAAiC;AAElC,OAAO,EAAE,cAAc,EAAE,8CAA0C;AAGnE,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACF,QAAQ,EAAE,MAAM,EAChB,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,8CAA8C,EAAE,kBAAkB,CAAC;IAQlF;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAM1E;AAED,MAAM,MAAM,8CAA8C,GAAG,2BAA2B,CAAC,kBAAkB,CAAC,CAAC;AAE7G;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;;;OAIG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACrC;AAED,MAAM,WAAW,gBAAiB,SAAQ,iCAAiC;CAAG;AAE9E,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,8CAA8C,IAAI,8CAA8C,EACrG,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
+{"version":3,"file":"details.d.mts","sourceRoot":"","sources":["../../../src/resources/payouts/breakup/details.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,mCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,sCAAkC;AACvD,OAAO,EACL,2BAA2B,EAC3B,KAAK,iCAAiC,EACtC,WAAW,EACZ,qCAAiC;AAElC,OAAO,EAAE,cAAc,EAAE,8CAA0C;AAGnE,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACF,QAAQ,EAAE,MAAM,EAChB,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,8CAA8C,EAAE,kBAAkB,CAAC;IAQlF;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAM1E;AAED,MAAM,MAAM,8CAA8C,GAAG,2BAA2B,CAAC,kBAAkB,CAAC,CAAC;AAE7G;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;;;;OAKG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACrC;AAED,MAAM,WAAW,gBAAiB,SAAQ,iCAAiC;CAAG;AAE9E,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,8CAA8C,IAAI,8CAA8C,EACrG,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}

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

@@ -4,10 +4,10 @@ import { DefaultPageNumberPagination, type DefaultPageNumberPaginationParams, Pa
 import { RequestOptions } from "../../../internal/request-options.js";
 export declare 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.
+     * Returns paginated individual balance ledger entries for a payout. Each entry is
+     * converted into the payout's currency at the rate the payout settled at. Supports
+     * pagination via `page_size` (default 10, max 100) and `page_number` (default 0)
+     * query parameters.
      *
      * @example
      * ```ts
@@ -37,8 +37,8 @@ export declare class Details extends APIResource {
 }
 export type DetailListResponsesDefaultPageNumberPagination = DefaultPageNumberPagination<DetailListResponse>;
 /**
- * Individual balance ledger entry for a payout, with amounts pro-rated into the
- * payout's currency.
+ * Individual balance ledger entry for a payout, converted into the payout's
+ * currency.
  */
 export interface DetailListResponse {
     /**
@@ -65,8 +65,9 @@ export interface DetailListResponse {
     original_currency: string;
     /**
      * Amount in the payout's currency, in that currency's smallest unit (cents for
-     * USD, yen for JPY, fils for KWD). Uses cumulative rounding to ensure sum matches
-     * payout total exactly.
+     * USD, yen for JPY, fils for KWD). The entry is converted at the rate the payout
+     * settled at. These amounts sum to the value of the entries, which can be less
+     * than the payout: the grouped breakup reports the difference as `unattributed`.
      */
     payout_currency_amount: number;
     /**

package/resources/payouts/breakup/details.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"details.d.ts","sourceRoot":"","sources":["../../../src/resources/payouts/breakup/details.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,qCAAkC;AACvD,OAAO,EACL,2BAA2B,EAC3B,KAAK,iCAAiC,EACtC,WAAW,EACZ,oCAAiC;AAElC,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAGnE,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACF,QAAQ,EAAE,MAAM,EAChB,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,8CAA8C,EAAE,kBAAkB,CAAC;IAQlF;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAM1E;AAED,MAAM,MAAM,8CAA8C,GAAG,2BAA2B,CAAC,kBAAkB,CAAC,CAAC;AAE7G;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;;;OAIG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACrC;AAED,MAAM,WAAW,gBAAiB,SAAQ,iCAAiC;CAAG;AAE9E,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,8CAA8C,IAAI,8CAA8C,EACrG,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
+{"version":3,"file":"details.d.ts","sourceRoot":"","sources":["../../../src/resources/payouts/breakup/details.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,qCAAkC;AACvD,OAAO,EACL,2BAA2B,EAC3B,KAAK,iCAAiC,EACtC,WAAW,EACZ,oCAAiC;AAElC,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAGnE,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACF,QAAQ,EAAE,MAAM,EAChB,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,8CAA8C,EAAE,kBAAkB,CAAC;IAQlF;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAM1E;AAED,MAAM,MAAM,8CAA8C,GAAG,2BAA2B,CAAC,kBAAkB,CAAC,CAAC;AAE7G;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;;;;OAKG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACrC;AAED,MAAM,WAAW,gBAAiB,SAAQ,iCAAiC;CAAG;AAE9E,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,8CAA8C,IAAI,8CAA8C,EACrG,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}

package/resources/payouts/breakup/details.js

@@ -8,10 +8,10 @@ const headers_1 = require("../../../internal/headers.js");
 const path_1 = require("../../../internal/utils/path.js");
 class Details extends resource_1.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.
+     * Returns paginated individual balance ledger entries for a payout. Each entry is
+     * converted into the payout's currency at the rate the payout settled at. Supports
+     * pagination via `page_size` (default 10, max 100) and `page_number` (default 0)
+     * query parameters.
      *
      * @example
      * ```ts

package/resources/payouts/breakup/details.mjs

@@ -5,10 +5,10 @@ import { buildHeaders } from "../../../internal/headers.mjs";
 import { path } from "../../../internal/utils/path.mjs";
 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.
+     * Returns paginated individual balance ledger entries for a payout. Each entry is
+     * converted into the payout's currency at the rate the payout settled at. Supports
+     * pagination via `page_size` (default 10, max 100) and `page_number` (default 0)
+     * query parameters.
      *
      * @example
      * ```ts

package/src/client.ts

@@ -132,6 +132,17 @@ import {
   MiscListSupportedCountriesResponse,
   TaxCategory,
 } from './resources/misc';
+import {
+  Moderation,
+  ModerationCategory,
+  ModerationCategoryProvenance,
+  ModerationCategoryScores,
+  ModerationDecision,
+  ModerationProvenance,
+  ModerationRetrieveUsageResponse,
+  ModerationScreenParams,
+  ModerationScreenResponse,
+} from './resources/moderation';
 import {
   AttachExistingCustomer,
   BillingAddress,
@@ -1133,6 +1144,7 @@ export class DodoPayments {
   creditEntitlements: API.CreditEntitlements = new API.CreditEntitlements(this);
   entitlements: API.Entitlements = new API.Entitlements(this);
   productCollections: API.ProductCollections = new API.ProductCollections(this);
+  moderation: API.Moderation = new API.Moderation(this);
 }
 
 DodoPayments.CheckoutSessions = CheckoutSessions;
@@ -1160,6 +1172,7 @@ DodoPayments.Balances = Balances;
 DodoPayments.CreditEntitlements = CreditEntitlements;
 DodoPayments.Entitlements = Entitlements;
 DodoPayments.ProductCollections = ProductCollections;
+DodoPayments.Moderation = Moderation;
 
 export declare namespace DodoPayments {
   export type RequestOptions = Opts.RequestOptions;
@@ -1522,4 +1535,16 @@ export declare namespace DodoPayments {
     type ProductCollectionUpdateParams as ProductCollectionUpdateParams,
     type ProductCollectionUpdateImagesParams as ProductCollectionUpdateImagesParams,
   };
+
+  export {
+    Moderation as Moderation,
+    type ModerationCategory as ModerationCategory,
+    type ModerationCategoryProvenance as ModerationCategoryProvenance,
+    type ModerationCategoryScores as ModerationCategoryScores,
+    type ModerationDecision as ModerationDecision,
+    type ModerationProvenance as ModerationProvenance,
+    type ModerationRetrieveUsageResponse as ModerationRetrieveUsageResponse,
+    type ModerationScreenResponse as ModerationScreenResponse,
+    type ModerationScreenParams as ModerationScreenParams,
+  };
 }

package/src/resources/balances.ts

@@ -58,7 +58,14 @@ export interface BalanceLedgerEntry {
     | 'payment_retry_fee'
     | 'byop_fee'
     | 'ethoca_fees'
-    | 'ethoca_fees_reversal';
+    | 'ethoca_fees_reversal'
+    | 'visa_rdr_fee'
+    | 'dispute_fees_reversal'
+    | 'deflection_fees'
+    | 'deflection_fees_reversal'
+    | 'reserve_hold'
+    | 'reserve_release'
+    | 'moderation_fees';
 
   is_credit: boolean;
 
@@ -263,7 +270,14 @@ export interface BalanceRetrieveLedgerParams extends DefaultPageNumberPagination
     | 'payment_retry_fee'
     | 'byop_fee'
     | 'ethoca_fees'
-    | 'ethoca_fees_reversal';
+    | 'ethoca_fees_reversal'
+    | 'visa_rdr_fee'
+    | 'dispute_fees_reversal'
+    | 'deflection_fees'
+    | 'deflection_fees_reversal'
+    | 'reserve_hold'
+    | 'reserve_release'
+    | 'moderation_fees';
 
   /**
    * Min : 1, Max : 100, default 10

package/src/resources/checkout-sessions.ts

@@ -192,6 +192,14 @@ export interface CheckoutSessionFlags {
    */
   redirect_immediately?: boolean;
 
+  /**
+   * If true, the customer must give the name on the card to pay by card. The
+   * checkout page enforces this. Other payment methods ignore it.
+   *
+   * Default is false
+   */
+  require_cardholder_name?: boolean;
+
   /**
    * If true, the customer must provide a phone number to complete checkout. Requires
    * `allow_phone_number_collection` to also be true.
@@ -200,6 +208,21 @@ export interface CheckoutSessionFlags {
    */
   require_phone_number?: boolean;
 
+  /**
+   * If true, the customer must give a tax id to check out as a business. A tax id is
+   * the GST number in India, or the VAT number in the EU. You must also set
+   * `allow_tax_id` to true.
+   *
+   * On the checkout page, this field does not change checkout for a customer who
+   * buys as an individual.
+   *
+   * A `confirm: true` request skips the checkout page. The request must contain
+   * `tax_id`.
+   *
+   * Default is false
+   */
+  require_tax_id?: boolean;
+
   /**
    * If true, the session uses the single-page checkout flow: the page initializes
    * the payment at load time and confirms it in place, with no separate payment
@@ -211,6 +234,11 @@ export interface CheckoutSessionFlags {
 }
 
 export interface CheckoutSessionRequest {
+  /**
+   * The products of the checkout. A cart holds at most 20 of them, one-time and
+   * subscription products together. An empty cart is valid for the
+   * product-collection flow, where the customer chooses the product later.
+   */
   product_cart: Array<ProductItemReq>;
 
   /**
@@ -698,7 +726,9 @@ export interface CheckoutSessionPreviewResponse {
    * The upcoming billing date for subscriptions, computed relative to now: with a
    * trial it is `now + trial_period_days`, otherwise `now + payment frequency`.
    * `None` for one-time-only carts. This is a preview estimate; the authoritative
-   * value is set when the subscription activates.
+   * value is set when the subscription activates. For a cart of more than one
+   * subscription, this is the earliest date of the cart. `subscriptions` gives the
+   * date of each subscription.
    */
   next_billing_date?: string | null;
 
@@ -707,6 +737,12 @@ export interface CheckoutSessionPreviewResponse {
    */
   recurring_breakup?: CheckoutSessionPreviewResponse.RecurringBreakup | null;
 
+  /**
+   * One entry for each subscription of a cart that holds more than one. Each
+   * subscription renews on its own schedule, so the checkout shows each one here.
+   */
+  subscriptions?: Array<CheckoutSessionPreviewResponse.Subscription> | null;
+
   /**
    * Registered business name from the official registry (EU/GB/AU) when found
    */
@@ -730,13 +766,16 @@ export interface CheckoutSessionPreviewResponse {
   /**
    * Per-unit trial amount after discounts, in the price currency's minor units
    * (pre-quantity, pre-tax; see `current_breakup` for the taxed total due today).
-   * Only present for a paid trial; `None` for a free trial or no trial.
+   * Only present for a paid trial; `None` for a free trial or no trial. Always
+   * `None` for a cart of more than one subscription.
    */
   trial_amount?: number | null;
 
   /**
    * Effective trial duration in days for the subscription line, when there's a trial
-   * (free or paid). `None` if no subscription or no trial.
+   * (free or paid). `None` if no subscription or no trial. Always `None` for a cart
+   * of more than one subscription. Read the trial of each subscription from
+   * `subscriptions`.
    */
   trial_period_days?: number | null;
 }
@@ -961,9 +1000,55 @@ export namespace CheckoutSessionPreviewResponse {
      */
     tax?: number | null;
   }
+
+  /**
+   * The quote of one subscription in a cart of several.
+   */
+  export interface Subscription {
+    /**
+     * The amount this subscription charges today, including tax.
+     */
+    amount_due_now: number;
+
+    /**
+     * The subscription product.
+     */
+    product_id: string;
+
+    /**
+     * The amount of each renewal, including tax.
+     */
+    recurring_amount: number;
+
+    /**
+     * A preview of the first renewal date. The date is set when the subscription
+     * activates.
+     */
+    next_billing_date?: string | null;
+
+    /**
+     * The tax in `recurring_amount`.
+     */
+    recurring_tax?: number | null;
+
+    /**
+     * The tax in `amount_due_now`.
+     */
+    tax_due_now?: number | null;
+
+    /**
+     * The trial duration in days. `None` when the subscription has no trial.
+     */
+    trial_period_days?: number | null;
+  }
 }
 
 export interface CheckoutSessionCreateParams {
+  /**
+   * The products of the checkout. A cart holds at most 20 of them, one-time and
+   * subscription products together. An empty cart is valid for the
+   * product-collection flow, where the customer chooses the product later.
+   */
   product_cart: Array<ProductItemReq>;
 
   /**
@@ -1096,6 +1181,11 @@ export interface CheckoutSessionCreateParams {
 }
 
 export interface CheckoutSessionPreviewParams {
+  /**
+   * The products of the checkout. A cart holds at most 20 of them, one-time and
+   * subscription products together. An empty cart is valid for the
+   * product-collection flow, where the customer chooses the product later.
+   */
   product_cart: Array<ProductItemReq>;
 
   /**

package/src/resources/customers/emails.ts

@@ -109,7 +109,8 @@ export type EmailFailureCode =
   | 'temporary_failure'
   | 'message_too_large'
   | 'marked_as_spam'
-  | 'send_failed';
+  | 'send_failed'
+  | 'test_mode_quota_spent';
 
 export interface EmailLogItem {
   /**
@@ -165,13 +166,8 @@ export interface EmailLogItem {
   from?: string | null;
 
   /**
-   * What the merchant typed, when test mode redirected the send to the business
-   * owner.
-   */
-  intended_recipient?: string | null;
-
-  /**
-   * The address the email reached.
+   * The address the email went to. On a failed email this is the address the
+   * provider reports as bounced.
    */
   recipient?: string | null;
 
@@ -213,6 +209,13 @@ export interface EmailPolicies {
    * The row failed and may be sent again.
    */
   retry_allowed: boolean;
+
+  /**
+   * A later send of this email replaced this row, so this row is history. A row that
+   * never went out needs a later send that reached the provider. A failed row needs
+   * a later send that was delivered.
+   */
+  superseded: boolean;
 }
 
 export interface EmailListParams extends DefaultPageNumberPaginationParams {}

package/src/resources/discounts.ts

@@ -375,9 +375,11 @@ export interface DiscountCreateParams {
 
   /**
    * Per-currency options (flat deduction / percentage cap + minimum subtotal).
-   * Required for `flat` codes (must include a resolvable default); optional
-   * per-currency caps for `percentage` codes. Per-row invariants are checked in
-   * `normalize_currency_options`, not via `#[validate(nested)]`.
+   * Checkout uses the row for the currency the buyer pays in. For any other currency
+   * it converts the default row. Required for `flat` codes (must include a
+   * resolvable default); optional per-currency caps for `percentage` codes. Per-row
+   * invariants are checked in `normalize_currency_options`, not via
+   * `#[validate(nested)]`.
    */
   currency_options?: Array<DiscountCreateParams.CurrencyOption> | null;
 
@@ -446,13 +448,14 @@ export namespace DiscountCreateParams {
    */
   export interface CurrencyOption {
     /**
-     * The currency this option applies to.
+     * The currency this option applies to. The row applies when the buyer pays in this
+     * currency.
      */
     currency: MiscAPI.Currency;
 
     /**
-     * Whether this row is the default to convert from for unconfigured currencies. At
-     * most one row per discount may be default.
+     * Whether this row is the default to convert from when the buyer pays in a
+     * currency that has no row. At most one row per discount may be default.
      */
     is_default?: boolean;
 
@@ -555,13 +558,14 @@ export namespace DiscountUpdateParams {
    */
   export interface CurrencyOption {
     /**
-     * The currency this option applies to.
+     * The currency this option applies to. The row applies when the buyer pays in this
+     * currency.
      */
     currency: MiscAPI.Currency;
 
     /**
-     * Whether this row is the default to convert from for unconfigured currencies. At
-     * most one row per discount may be default.
+     * Whether this row is the default to convert from when the buyer pays in a
+     * currency that has no row. At most one row per discount may be default.
      */
     is_default?: boolean;
 

package/src/resources/index.ts

@@ -146,6 +146,17 @@ export {
   type TaxCategory,
   type MiscListSupportedCountriesResponse,
 } from './misc';
+export {
+  Moderation,
+  type ModerationCategory,
+  type ModerationCategoryProvenance,
+  type ModerationCategoryScores,
+  type ModerationDecision,
+  type ModerationProvenance,
+  type ModerationRetrieveUsageResponse,
+  type ModerationScreenResponse,
+  type ModerationScreenParams,
+} from './moderation';
 export {
   Payments,
   type AttachExistingCustomer,