dodopayments 2.51.0 → 2.53.0

package/src/resources/checkout-sessions.ts

@@ -192,6 +192,16 @@ export interface CheckoutSessionFlags {
    */
   redirect_immediately?: boolean;
 
+  /**
+   * If true, the customer must give the name on the card to pay by card. Apple Pay
+   * and Google Pay also collect the payer name, and the payment stores it as the
+   * card holder name. 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.
@@ -226,6 +236,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>;
 
   /**
@@ -244,7 +259,14 @@ export interface CheckoutSessionRequest {
   billing_address?: CheckoutSessionBillingAddress | null;
 
   /**
-   * This field is ingored if adaptive pricing is disabled
+   * The currency to charge the customer in.
+   *
+   * Adaptive pricing must be enabled for the business. The customer then pays in
+   * this currency. If you do not set it, the currency comes from the billing
+   * country.
+   *
+   * If adaptive pricing is disabled, the API discards this field. The currency then
+   * comes from the product price, or from the billing country.
    */
   billing_currency?: MiscAPI.Currency | null;
 
@@ -319,8 +341,11 @@ export interface CheckoutSessionRequest {
   /**
    * If true, only zipcode is required when confirm is true; other address fields
    * remain optional
+   *
+   * Default is true when `feature_flags.single_page` is true. Otherwise, default is
+   * false.
    */
-  minimal_address?: boolean;
+  minimal_address?: boolean | null;
 
   /**
    * Optional payment method ID to use for this checkout session. Only allowed when
@@ -713,7 +738,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;
 
@@ -722,6 +749,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
    */
@@ -745,13 +778,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;
 }
@@ -976,9 +1012,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>;
 
   /**
@@ -997,7 +1079,14 @@ export interface CheckoutSessionCreateParams {
   billing_address?: CheckoutSessionBillingAddress | null;
 
   /**
-   * This field is ingored if adaptive pricing is disabled
+   * The currency to charge the customer in.
+   *
+   * Adaptive pricing must be enabled for the business. The customer then pays in
+   * this currency. If you do not set it, the currency comes from the billing
+   * country.
+   *
+   * If adaptive pricing is disabled, the API discards this field. The currency then
+   * comes from the product price, or from the billing country.
    */
   billing_currency?: MiscAPI.Currency | null;
 
@@ -1072,8 +1161,11 @@ export interface CheckoutSessionCreateParams {
   /**
    * If true, only zipcode is required when confirm is true; other address fields
    * remain optional
+   *
+   * Default is true when `feature_flags.single_page` is true. Otherwise, default is
+   * false.
    */
-  minimal_address?: boolean;
+  minimal_address?: boolean | null;
 
   /**
    * Optional payment method ID to use for this checkout session. Only allowed when
@@ -1111,6 +1203,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>;
 
   /**
@@ -1129,7 +1226,14 @@ export interface CheckoutSessionPreviewParams {
   billing_address?: CheckoutSessionBillingAddress | null;
 
   /**
-   * This field is ingored if adaptive pricing is disabled
+   * The currency to charge the customer in.
+   *
+   * Adaptive pricing must be enabled for the business. The customer then pays in
+   * this currency. If you do not set it, the currency comes from the billing
+   * country.
+   *
+   * If adaptive pricing is disabled, the API discards this field. The currency then
+   * comes from the product price, or from the billing country.
    */
   billing_currency?: MiscAPI.Currency | null;
 
@@ -1204,8 +1308,11 @@ export interface CheckoutSessionPreviewParams {
   /**
    * If true, only zipcode is required when confirm is true; other address fields
    * remain optional
+   *
+   * Default is true when `feature_flags.single_page` is true. Otherwise, default is
+   * false.
    */
-  minimal_address?: boolean;
+  minimal_address?: boolean | null;
 
   /**
    * Optional payment method ID to use for this checkout session. Only allowed when

package/src/resources/customers/emails.ts

@@ -166,7 +166,8 @@ export interface EmailLogItem {
   from?: 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;
 
@@ -190,7 +191,8 @@ export type EmailLogStatus = 'sent' | 'delivered' | 'failed' | 'complained' | 'b
  */
 export interface EmailPolicies {
   /**
-   * A permanent failure was recorded, so the same address would be a no-op.
+   * A permanent failure was recorded, so a send to the same address delivers
+   * nothing. It is false for a suppressed address that a resend can clear.
    */
   requires_different_address: boolean;
 
@@ -210,8 +212,9 @@ export interface EmailPolicies {
   retry_allowed: boolean;
 
   /**
-   * A later send of this email reached the provider, so this row is history. To send
-   * it again would deliver a second copy.
+   * 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;
 }

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,
@@ -213,6 +224,7 @@ export {
 export {
   Refunds,
   type Refund,
+  type RefundNetworkReferenceType,
   type RefundStatus,
   type RefundListParams,
   type RefundCreateParams,
@@ -228,6 +240,7 @@ export {
   type OnDemandSubscription,
   type ScheduledPlanChange,
   type Subscription,
+  type SubscriptionCancelledBy,
   type SubscriptionStatus,
   type TimeInterval,
   type UpdateSubscriptionPlanReq,