dodopayments 2.29.1 → 2.30.0

package/src/resources/subscriptions.ts

@@ -182,6 +182,16 @@ export interface AttachAddon {
   quantity: number;
 }
 
+export type CancellationFeedback =
+  | 'too_expensive'
+  | 'missing_features'
+  | 'switched_service'
+  | 'unused'
+  | 'customer_service'
+  | 'low_quality'
+  | 'too_complex'
+  | 'other';
+
 /**
  * Response struct representing credit entitlement cart details for a subscription
  */
@@ -309,6 +319,67 @@ export interface OnDemandSubscription {
   product_price?: number | null;
 }
 
+export interface ScheduledPlanChange {
+  /**
+   * The scheduled plan change ID
+   */
+  id: string;
+
+  /**
+   * Addons included in the scheduled change
+   */
+  addons: Array<ScheduledPlanChange.Addon>;
+
+  /**
+   * When this scheduled change was created
+   */
+  created_at: string;
+
+  /**
+   * When the change will be applied
+   */
+  effective_at: string;
+
+  /**
+   * The product ID the subscription will change to
+   */
+  product_id: string;
+
+  /**
+   * Quantity for the new plan
+   */
+  quantity: number;
+
+  /**
+   * Description of the product being changed to
+   */
+  product_description?: string | null;
+
+  /**
+   * Name of the product being changed to
+   */
+  product_name?: string | null;
+}
+
+export namespace ScheduledPlanChange {
+  export interface Addon {
+    /**
+     * The addon ID
+     */
+    addon_id: string;
+
+    /**
+     * Name of the addon
+     */
+    name: string;
+
+    /**
+     * Quantity of the addon
+     */
+    quantity: number;
+  }
+}
+
 /**
  * Response struct representing subscription details
  */
@@ -435,6 +506,16 @@ export interface Subscription {
    */
   trial_period_days: number;
 
+  /**
+   * Free-text cancellation comment, if any
+   */
+  cancellation_comment?: string | null;
+
+  /**
+   * Customer-supplied churn reason, if any
+   */
+  cancellation_feedback?: CancellationFeedback | null;
+
   /**
    * Cancelled timestamp if the subscription is cancelled
    */
@@ -468,7 +549,7 @@ export interface Subscription {
   /**
    * Scheduled plan change details, if any
    */
-  scheduled_change?: Subscription.ScheduledChange | null;
+  scheduled_change?: ScheduledPlanChange | null;
 
   /**
    * Tax identifier provided for this subscription (if applicable)
@@ -476,72 +557,6 @@ export interface Subscription {
   tax_id?: string | null;
 }
 
-export namespace Subscription {
-  /**
-   * Scheduled plan change details, if any
-   */
-  export interface ScheduledChange {
-    /**
-     * The scheduled plan change ID
-     */
-    id: string;
-
-    /**
-     * Addons included in the scheduled change
-     */
-    addons: Array<ScheduledChange.Addon>;
-
-    /**
-     * When this scheduled change was created
-     */
-    created_at: string;
-
-    /**
-     * When the change will be applied
-     */
-    effective_at: string;
-
-    /**
-     * The product ID the subscription will change to
-     */
-    product_id: string;
-
-    /**
-     * Quantity for the new plan
-     */
-    quantity: number;
-
-    /**
-     * Description of the product being changed to
-     */
-    product_description?: string | null;
-
-    /**
-     * Name of the product being changed to
-     */
-    product_name?: string | null;
-  }
-
-  export namespace ScheduledChange {
-    export interface Addon {
-      /**
-       * The addon ID
-       */
-      addon_id: string;
-
-      /**
-       * Name of the addon
-       */
-      name: string;
-
-      /**
-       * Quantity of the addon
-       */
-      quantity: number;
-    }
-  }
-}
-
 export type SubscriptionStatus = 'pending' | 'active' | 'on_hold' | 'cancelled' | 'failed' | 'expired';
 
 export type TimeInterval = 'Day' | 'Week' | 'Month' | 'Year';
@@ -566,6 +581,12 @@ export interface UpdateSubscriptionPlanReq {
    */
   quantity: number;
 
+  /**
+   * Whether adaptive currency fees should be included in the price (true) or added
+   * on top (false). If not specified, uses the subscription's stored setting.
+   */
+  adaptive_currency_fees_inclusive?: boolean | null;
+
   /**
    * Addons for the new plan. Note : Leaving this empty would remove any existing
    * addons
@@ -657,7 +678,7 @@ export interface SubscriptionCreateResponse {
   /**
    * One time products associated with the purchase of subscription
    */
-  one_time_product_cart?: Array<PaymentsAPI.OneTimeProductCartItem> | null;
+  one_time_product_cart?: Array<SubscriptionCreateResponse.OneTimeProductCart> | null;
 
   /**
    * URL to checkout page
@@ -665,6 +686,14 @@ export interface SubscriptionCreateResponse {
   payment_link?: string | null;
 }
 
+export namespace SubscriptionCreateResponse {
+  export interface OneTimeProductCart {
+    product_id: string;
+
+    quantity: number;
+  }
+}
+
 /**
  * Response struct representing subscription details
  */
@@ -799,7 +828,7 @@ export interface SubscriptionListResponse {
   /**
    * Scheduled plan change details, if any
    */
-  scheduled_change?: SubscriptionListResponse.ScheduledChange | null;
+  scheduled_change?: ScheduledPlanChange | null;
 
   /**
    * Tax identifier provided for this subscription (if applicable)
@@ -807,72 +836,6 @@ export interface SubscriptionListResponse {
   tax_id?: string | null;
 }
 
-export namespace SubscriptionListResponse {
-  /**
-   * Scheduled plan change details, if any
-   */
-  export interface ScheduledChange {
-    /**
-     * The scheduled plan change ID
-     */
-    id: string;
-
-    /**
-     * Addons included in the scheduled change
-     */
-    addons: Array<ScheduledChange.Addon>;
-
-    /**
-     * When this scheduled change was created
-     */
-    created_at: string;
-
-    /**
-     * When the change will be applied
-     */
-    effective_at: string;
-
-    /**
-     * The product ID the subscription will change to
-     */
-    product_id: string;
-
-    /**
-     * Quantity for the new plan
-     */
-    quantity: number;
-
-    /**
-     * Description of the product being changed to
-     */
-    product_description?: string | null;
-
-    /**
-     * Name of the product being changed to
-     */
-    product_name?: string | null;
-  }
-
-  export namespace ScheduledChange {
-    export interface Addon {
-      /**
-       * The addon ID
-       */
-      addon_id: string;
-
-      /**
-       * Name of the addon
-       */
-      name: string;
-
-      /**
-       * Quantity of the addon
-       */
-      quantity: number;
-    }
-  }
-}
-
 export interface SubscriptionChargeResponse {
   payment_id: string;
 }
@@ -1183,6 +1146,16 @@ export interface SubscriptionCreateParams {
    */
   force_3ds?: boolean | null;
 
+  /**
+   * Override the merchant-level mandate floor (in INR paise) for INR e-mandates on
+   * Indian-card recurring payments. The mandate amount sent to the processor is
+   * `max(this_floor, actual_billing_amount)`, so this is effectively the
+   * customer-facing authorization ceiling whenever billing is lower. When unset, the
+   * merchant setting applies; when that's also unset, the system default of ₹15,000
+   * applies.
+   */
+  mandate_min_amount_inr_paise?: number | null;
+
   /**
    * Additional metadata for the subscription Defaults to empty if not specified
    */
@@ -1194,7 +1167,7 @@ export interface SubscriptionCreateParams {
    * List of one time products that will be bundled with the first payment for this
    * subscription
    */
-  one_time_product_cart?: Array<SubscriptionCreateParams.OneTimeProductCart> | null;
+  one_time_product_cart?: Array<PaymentsAPI.OneTimeProductCartItem> | null;
 
   /**
    * If true, generates a payment link. Defaults to false if not specified.
@@ -1214,6 +1187,13 @@ export interface SubscriptionCreateParams {
    */
   redirect_immediately?: boolean;
 
+  /**
+   * If true, the customer's phone number is required to create this subscription.
+   * Typically set alongside `payment_link=true` so merchants can enforce phone
+   * collection on the hosted payment page. Defaults to false.
+   */
+  require_phone_number?: boolean;
+
   /**
    * Optional URL to redirect after successful subscription creation
    */
@@ -1242,21 +1222,6 @@ export interface SubscriptionCreateParams {
   trial_period_days?: number | null;
 }
 
-export namespace SubscriptionCreateParams {
-  export interface OneTimeProductCart {
-    product_id: string;
-
-    quantity: number;
-
-    /**
-     * Amount the customer pays if pay_what_you_want is enabled. If disabled then
-     * amount will be ignored Represented in the lowest denomination of the currency
-     * (e.g., cents for USD). For example, to charge $1.00, pass `100`.
-     */
-    amount?: number | null;
-  }
-}
-
 export interface SubscriptionUpdateParams {
   billing?: PaymentsAPI.BillingAddress | null;
 
@@ -1269,8 +1234,21 @@ export interface SubscriptionUpdateParams {
     | 'cancelled_by_customer'
     | 'cancelled_by_merchant'
     | 'cancelled_by_merchant_send_dunning'
+    | 'dodo_team'
     | null;
 
+  /**
+   * Free-text cancellation comment (only valid when cancelling or scheduling
+   * cancellation).
+   */
+  cancellation_comment?: string | null;
+
+  /**
+   * Customer-supplied churn reason (only valid when cancelling or scheduling
+   * cancellation).
+   */
+  cancellation_feedback?: CancellationFeedback | null;
+
   /**
    * Update credit entitlement cart settings
    */
@@ -1371,6 +1349,12 @@ export interface SubscriptionChangePlanParams {
    */
   quantity: number;
 
+  /**
+   * Whether adaptive currency fees should be included in the price (true) or added
+   * on top (false). If not specified, uses the subscription's stored setting.
+   */
+  adaptive_currency_fees_inclusive?: boolean | null;
+
   /**
    * Addons for the new plan. Note : Leaving this empty would remove any existing
    * addons
@@ -1486,6 +1470,12 @@ export interface SubscriptionPreviewChangePlanParams {
    */
   quantity: number;
 
+  /**
+   * Whether adaptive currency fees should be included in the price (true) or added
+   * on top (false). If not specified, uses the subscription's stored setting.
+   */
+  adaptive_currency_fees_inclusive?: boolean | null;
+
   /**
    * Addons for the new plan. Note : Leaving this empty would remove any existing
    * addons
@@ -1565,10 +1555,12 @@ export declare namespace Subscriptions {
   export {
     type AddonCartResponseItem as AddonCartResponseItem,
     type AttachAddon as AttachAddon,
+    type CancellationFeedback as CancellationFeedback,
     type CreditEntitlementCartResponse as CreditEntitlementCartResponse,
     type MeterCartResponseItem as MeterCartResponseItem,
     type MeterCreditEntitlementCartResponse as MeterCreditEntitlementCartResponse,
     type OnDemandSubscription as OnDemandSubscription,
+    type ScheduledPlanChange as ScheduledPlanChange,
     type Subscription as Subscription,
     type SubscriptionStatus as SubscriptionStatus,
     type TimeInterval as TimeInterval,

package/src/resources/webhook-events.ts

@@ -7,6 +7,7 @@ import * as PaymentsAPI from './payments';
 import * as RefundsAPI from './refunds';
 import * as SubscriptionsAPI from './subscriptions';
 import * as BalancesAPI from './credit-entitlements/balances';
+import * as GrantsAPI from './entitlements/grants';
 
 export class WebhookEvents extends APIResource {}
 
@@ -47,6 +48,7 @@ export type WebhookEventType =
   | 'credit.rolled_over'
   | 'credit.rollover_forfeited'
   | 'credit.overage_charged'
+  | 'credit.overage_reset'
   | 'credit.manual_adjustment'
   | 'credit.balance_low'
   | 'abandoned_checkout.detected'
@@ -173,54 +175,8 @@ export namespace WebhookPayload {
     payment_id?: string | null;
   }
 
-  export interface EntitlementGrant {
-    id: string;
-
-    business_id: string;
-
-    created_at: string;
-
-    customer_id: string;
-
-    entitlement_id: string;
-
-    external_id: string;
-
+  export interface EntitlementGrant extends GrantsAPI.EntitlementGrant {
     payload_type: 'EntitlementGrant';
-
-    status: 'Pending' | 'Delivered' | 'Failed' | 'Revoked';
-
-    updated_at: string;
-
-    delivered_at?: string | null;
-
-    error_code?: string | null;
-
-    error_message?: string | null;
-
-    license_key?: string | null;
-
-    license_key_activations_limit?: number | null;
-
-    license_key_activations_used?: number | null;
-
-    license_key_expires_at?: string | null;
-
-    license_key_status?: string | null;
-
-    metadata?: unknown;
-
-    oauth_expires_at?: string | null;
-
-    oauth_url?: string | null;
-
-    payment_id?: string | null;
-
-    revocation_reason?: string | null;
-
-    revoked_at?: string | null;
-
-    subscription_id?: string | null;
   }
 }
 

package/src/resources/webhooks/index.ts

@@ -13,6 +13,7 @@ export {
   type CreditExpiredWebhookEvent,
   type CreditManualAdjustmentWebhookEvent,
   type CreditOverageChargedWebhookEvent,
+  type CreditOverageResetWebhookEvent,
   type CreditRolledOverWebhookEvent,
   type CreditRolloverForfeitedWebhookEvent,
   type DisputeAcceptedWebhookEvent,
@@ -24,6 +25,10 @@ export {
   type DisputeWonWebhookEvent,
   type DunningRecoveredWebhookEvent,
   type DunningStartedWebhookEvent,
+  type EntitlementGrantCreatedWebhookEvent,
+  type EntitlementGrantDeliveredWebhookEvent,
+  type EntitlementGrantFailedWebhookEvent,
+  type EntitlementGrantRevokedWebhookEvent,
   type LicenseKeyCreatedWebhookEvent,
   type PaymentCancelledWebhookEvent,
   type PaymentFailedWebhookEvent,