dodopayments 2.52.0 → 2.54.0

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'
@@ -741,6 +769,22 @@ export interface UpdateSubscriptionPlanReq {
    */
   addons?: Array<AttachAddon> | null;
 
+  /**
+   * Cancel the payment link of a pending plan change, so that this change can
+   * replace it.
+   *
+   * The link is cancelled only if the customer has not started to pay. A paid or
+   * in-progress payment gives a `409`. A failed cancel gives a `503`, and a retry is
+   * safe.
+   *
+   * The request is validated before the cancel. A later failure, for example an
+   * amount below the minimum, leaves the subscription on its current plan with no
+   * open link. A retry is safe.
+   *
+   * The preview route shares this request body and ignores this field.
+   */
+  cancel_older_payment_link?: boolean;
+
   /**
    * Replace a scheduled plan change with this one.
    *
@@ -806,6 +850,20 @@ export interface UpdateSubscriptionPlanReq {
    * If not specified, uses the business-level default setting.
    */
   on_payment_failure?: 'prevent_change' | 'apply_change' | null;
+
+  /**
+   * The URL that receives the customer after they pay the payment link. Needs
+   * `collect_via_payment_link: true`. Without it, the request gets a `422`. A change
+   * that collects no money issues no link and does not use the URL. The preview
+   * route validates this field but does not use it.
+   *
+   * The redirect adds `subscription_id`, `payment_id` and `status`. The `status`
+   * value is the status of the plan-change payment. It is not the status of the
+   * subscription. When that payment fails, the subscription stays active on its
+   * current plan. To try again, call this endpoint again to get a new link. The new
+   * plan can apply after the redirect, when the payment webhook arrives.
+   */
+  return_url?: string | null;
 }
 
 export interface SubscriptionCreateResponse {
@@ -1014,6 +1072,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 +1289,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;
@@ -1767,6 +1839,22 @@ export interface SubscriptionChangePlanParams {
    */
   addons?: Array<AttachAddon> | null;
 
+  /**
+   * Cancel the payment link of a pending plan change, so that this change can
+   * replace it.
+   *
+   * The link is cancelled only if the customer has not started to pay. A paid or
+   * in-progress payment gives a `409`. A failed cancel gives a `503`, and a retry is
+   * safe.
+   *
+   * The request is validated before the cancel. A later failure, for example an
+   * amount below the minimum, leaves the subscription on its current plan with no
+   * open link. A retry is safe.
+   *
+   * The preview route shares this request body and ignores this field.
+   */
+  cancel_older_payment_link?: boolean;
+
   /**
    * Replace a scheduled plan change with this one.
    *
@@ -1832,6 +1920,20 @@ export interface SubscriptionChangePlanParams {
    * If not specified, uses the business-level default setting.
    */
   on_payment_failure?: 'prevent_change' | 'apply_change' | null;
+
+  /**
+   * The URL that receives the customer after they pay the payment link. Needs
+   * `collect_via_payment_link: true`. Without it, the request gets a `422`. A change
+   * that collects no money issues no link and does not use the URL. The preview
+   * route validates this field but does not use it.
+   *
+   * The redirect adds `subscription_id`, `payment_id` and `status`. The `status`
+   * value is the status of the plan-change payment. It is not the status of the
+   * subscription. When that payment fails, the subscription stays active on its
+   * current plan. To try again, call this endpoint again to get a new link. The new
+   * plan can apply after the redirect, when the payment webhook arrives.
+   */
+  return_url?: string | null;
 }
 
 export interface SubscriptionRetrieveUsageHistoryParams extends DefaultPageNumberPaginationParams {
@@ -1911,6 +2013,22 @@ export interface SubscriptionPreviewChangePlanParams {
    */
   addons?: Array<AttachAddon> | null;
 
+  /**
+   * Cancel the payment link of a pending plan change, so that this change can
+   * replace it.
+   *
+   * The link is cancelled only if the customer has not started to pay. A paid or
+   * in-progress payment gives a `409`. A failed cancel gives a `503`, and a retry is
+   * safe.
+   *
+   * The request is validated before the cancel. A later failure, for example an
+   * amount below the minimum, leaves the subscription on its current plan with no
+   * open link. A retry is safe.
+   *
+   * The preview route shares this request body and ignores this field.
+   */
+  cancel_older_payment_link?: boolean;
+
   /**
    * Replace a scheduled plan change with this one.
    *
@@ -1976,6 +2094,20 @@ export interface SubscriptionPreviewChangePlanParams {
    * If not specified, uses the business-level default setting.
    */
   on_payment_failure?: 'prevent_change' | 'apply_change' | null;
+
+  /**
+   * The URL that receives the customer after they pay the payment link. Needs
+   * `collect_via_payment_link: true`. Without it, the request gets a `422`. A change
+   * that collects no money issues no link and does not use the URL. The preview
+   * route validates this field but does not use it.
+   *
+   * The redirect adds `subscription_id`, `payment_id` and `status`. The `status`
+   * value is the status of the plan-change payment. It is not the status of the
+   * subscription. When that payment fails, the subscription stays active on its
+   * current plan. To try again, call this endpoint again to get a new link. The new
+   * plan can apply after the redirect, when the payment webhook arrives.
+   */
+  return_url?: string | null;
 }
 
 export declare namespace Subscriptions {
@@ -1989,6 +2121,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.54.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.54.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.54.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.54.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.54.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map