dodopayments 2.52.0 → 2.53.0

package/src/resources/checkout-sessions.ts

@@ -193,8 +193,10 @@ 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.
+   * 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
    */
@@ -257,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;
 
@@ -332,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
@@ -1067,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;
 
@@ -1142,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
@@ -1204,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;
 
@@ -1279,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

@@ -191,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;
 

package/src/resources/index.ts

@@ -224,6 +224,7 @@ export {
 export {
   Refunds,
   type Refund,
+  type RefundNetworkReferenceType,
   type RefundStatus,
   type RefundListParams,
   type RefundCreateParams,
@@ -239,6 +240,7 @@ export {
   type OnDemandSubscription,
   type ScheduledPlanChange,
   type Subscription,
+  type SubscriptionCancelledBy,
   type SubscriptionStatus,
   type TimeInterval,
   type UpdateSubscriptionPlanReq,

package/src/resources/payments.ts

@@ -691,6 +691,18 @@ export interface RefundListItem {
    */
   currency?: MiscAPI.Currency | null;
 
+  /**
+   * The reference number that the card network or the bank gives to the refund. The
+   * customer can give this number to their bank to trace the refund. It is null
+   * until the payment processor sends it.
+   */
+  network_reference?: string | null;
+
+  /**
+   * The kind of `network_reference`: ARN, STAN or RRN.
+   */
+  network_reference_type?: RefundsAPI.RefundNetworkReferenceType | null;
+
   /**
    * The reason provided for the refund, if any. Optional.
    */

package/src/resources/refunds.ts

@@ -114,12 +114,34 @@ export interface Refund {
    */
   currency?: MiscAPI.Currency | null;
 
+  /**
+   * The reference number that the card network or the bank gives to the refund. The
+   * customer can give this number to their bank to trace the refund. It is null
+   * until the payment processor sends it.
+   */
+  network_reference?: string | null;
+
+  /**
+   * The kind of `network_reference`: ARN, STAN or RRN.
+   */
+  network_reference_type?: RefundNetworkReferenceType | null;
+
   /**
    * The reason provided for the refund, if any. Optional.
    */
   reason?: string | null;
 }
 
+/**
+ * The kind of reference number that the card network or the bank gives to a
+ * refund.
+ */
+export type RefundNetworkReferenceType =
+  | 'acquirer_reference_number'
+  | 'system_trace_audit_number'
+  | 'retrieval_reference_number'
+  | 'other';
+
 export type RefundStatus = 'succeeded' | 'failed' | 'pending' | 'review';
 
 export interface RefundListParams extends DefaultPageNumberPaginationParams {
@@ -193,6 +215,7 @@ export namespace RefundCreateParams {
 export declare namespace Refunds {
   export {
     type Refund as Refund,
+    type RefundNetworkReferenceType as RefundNetworkReferenceType,
     type RefundStatus as RefundStatus,
     type RefundListParams as RefundListParams,
     type RefundCreateParams as RefundCreateParams,

package/src/resources/subscriptions.ts

@@ -634,6 +634,12 @@ export interface Subscription {
    */
   cancelled_at?: string | null;
 
+  /**
+   * The caller that cancelled the subscription or scheduled its cancel. `null` when
+   * no caller is known, for example when the system cancelled the subscription.
+   */
+  cancelled_by?: SubscriptionCancelledBy | null;
+
   /**
    * Customer's responses to custom fields collected during checkout
    */
@@ -694,6 +700,28 @@ export interface Subscription {
   trial_amount?: number | null;
 }
 
+/**
+ * The caller that cancelled a subscription or scheduled its cancel.
+ */
+export interface SubscriptionCancelledBy {
+  /**
+   * The kind of caller.
+   */
+  actor_type: 'customer' | 'merchant_user' | 'api_key' | 'dodo_team';
+
+  /**
+   * Email of the customer or of the dashboard user. `null` for an API key or the
+   * Dodo Payments team.
+   */
+  email?: string | null;
+
+  /**
+   * Name of the customer or of the dashboard user. `null` for an API key or the Dodo
+   * Payments team.
+   */
+  name?: string | null;
+}
+
 export type SubscriptionStatus =
   | 'pending'
   | 'active'
@@ -1014,6 +1042,12 @@ export interface SubscriptionListResponse {
    */
   cancelled_at?: string | null;
 
+  /**
+   * The caller that cancelled the subscription or scheduled its cancel. `null` when
+   * no caller is known, for example when the system cancelled the subscription.
+   */
+  cancelled_by?: SubscriptionCancelledBy | null;
+
   /**
    * Business / legal name associated with the tax id (B2B). When set this is used on
    * the invoice in place of the customer's personal name.
@@ -1225,14 +1259,22 @@ export namespace SubscriptionPreviewChangePlanResponse {
       currency: MiscAPI.Currency;
 
       /**
-       * Net credit movement in the smallest currency unit (e.g. cents). **Negative** –
-       * credits were deducted from the customer's balance to offset the charge (typical
-       * on upgrades). **Positive** – credits were added to the customer's balance,
-       * either from a downgrade proration refund or from topping-up the wallet to meet a
-       * gateway minimum-charge threshold. **Zero** – no credit movement occurred.
+       * Net credit movement in the smallest unit of `customer_credits_currency` (e.g.
+       * cents). Read `customer_credits_currency` for the currency. It can differ from
+       * `currency`. **Negative** – credits were deducted from the customer's balance to
+       * offset the charge (typical on upgrades). **Positive** – credits were added to
+       * the customer's balance, either from a downgrade proration refund or from
+       * topping-up the wallet to meet a gateway minimum-charge threshold. **Zero** – no
+       * credit movement occurred.
        */
       customer_credits: number;
 
+      /**
+       * This field gives the currency of `customer_credits`. The credit wallet uses the
+       * subscription currency.
+       */
+      customer_credits_currency: MiscAPI.Currency;
+
       settlement_amount: number;
 
       settlement_currency: MiscAPI.Currency;
@@ -1989,6 +2031,7 @@ export declare namespace Subscriptions {
     type OnDemandSubscription as OnDemandSubscription,
     type ScheduledPlanChange as ScheduledPlanChange,
     type Subscription as Subscription,
+    type SubscriptionCancelledBy as SubscriptionCancelledBy,
     type SubscriptionStatus as SubscriptionStatus,
     type TimeInterval as TimeInterval,
     type UpdateSubscriptionPlanReq as UpdateSubscriptionPlanReq,

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '2.52.0'; // x-release-please-version
+export const VERSION = '2.53.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "2.52.0";
+export declare const VERSION = "2.53.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "2.52.0";
+export declare const VERSION = "2.53.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '2.52.0'; // x-release-please-version
+exports.VERSION = '2.53.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '2.52.0'; // x-release-please-version
+export const VERSION = '2.53.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map