dodopayments 2.23.2 → 2.24.0

package/src/resources/subscriptions.ts

@@ -45,6 +45,13 @@ export class Subscriptions extends APIResource {
     });
   }
 
+  cancelChangePlan(subscriptionID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/subscriptions/${subscriptionID}/change-plan/scheduled`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
   changePlan(
     subscriptionID: string,
     body: SubscriptionChangePlanParams,
@@ -458,12 +465,83 @@ export interface Subscription {
    */
   payment_method_id?: string | null;
 
+  /**
+   * Scheduled plan change details, if any
+   */
+  scheduled_change?: Subscription.ScheduledChange | null;
+
   /**
    * Tax identifier provided for this subscription (if applicable)
    */
   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';
@@ -477,7 +555,11 @@ export interface UpdateSubscriptionPlanReq {
   /**
    * Proration Billing Mode
    */
-  proration_billing_mode: 'prorated_immediately' | 'full_immediately' | 'difference_immediately';
+  proration_billing_mode:
+    | 'prorated_immediately'
+    | 'full_immediately'
+    | 'difference_immediately'
+    | 'do_not_bill';
 
   /**
    * Number of units to subscribe for. Must be at least 1.
@@ -498,6 +580,14 @@ export interface UpdateSubscriptionPlanReq {
    */
   discount_code?: string | null;
 
+  /**
+   * When to apply the plan change.
+   *
+   * - `immediately` (default): Apply the plan change right away
+   * - `next_billing_date`: Schedule the change for the next billing date
+   */
+  effective_at?: 'immediately' | 'next_billing_date';
+
   /**
    * Metadata for the payment. If not passed, the metadata of the subscription will
    * be taken
@@ -706,12 +796,83 @@ export interface SubscriptionListResponse {
    */
   product_name?: string | null;
 
+  /**
+   * Scheduled plan change details, if any
+   */
+  scheduled_change?: SubscriptionListResponse.ScheduledChange | null;
+
   /**
    * Tax identifier provided for this subscription (if applicable)
    */
   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;
 }
@@ -727,6 +888,11 @@ export interface SubscriptionPreviewChangePlanResponse {
 
 export namespace SubscriptionPreviewChangePlanResponse {
   export interface ImmediateCharge {
+    /**
+     * When the plan change will be effective
+     */
+    effective_at: string;
+
     line_items: Array<ImmediateCharge.Subscription | ImmediateCharge.Addon | ImmediateCharge.Meter>;
 
     summary: ImmediateCharge.Summary;
@@ -1188,7 +1354,11 @@ export interface SubscriptionChangePlanParams {
   /**
    * Proration Billing Mode
    */
-  proration_billing_mode: 'prorated_immediately' | 'full_immediately' | 'difference_immediately';
+  proration_billing_mode:
+    | 'prorated_immediately'
+    | 'full_immediately'
+    | 'difference_immediately'
+    | 'do_not_bill';
 
   /**
    * Number of units to subscribe for. Must be at least 1.
@@ -1209,6 +1379,14 @@ export interface SubscriptionChangePlanParams {
    */
   discount_code?: string | null;
 
+  /**
+   * When to apply the plan change.
+   *
+   * - `immediately` (default): Apply the plan change right away
+   * - `next_billing_date`: Schedule the change for the next billing date
+   */
+  effective_at?: 'immediately' | 'next_billing_date';
+
   /**
    * Metadata for the payment. If not passed, the metadata of the subscription will
    * be taken
@@ -1291,7 +1469,11 @@ export interface SubscriptionPreviewChangePlanParams {
   /**
    * Proration Billing Mode
    */
-  proration_billing_mode: 'prorated_immediately' | 'full_immediately' | 'difference_immediately';
+  proration_billing_mode:
+    | 'prorated_immediately'
+    | 'full_immediately'
+    | 'difference_immediately'
+    | 'do_not_bill';
 
   /**
    * Number of units to subscribe for. Must be at least 1.
@@ -1312,6 +1494,14 @@ export interface SubscriptionPreviewChangePlanParams {
    */
   discount_code?: string | null;
 
+  /**
+   * When to apply the plan change.
+   *
+   * - `immediately` (default): Apply the plan change right away
+   * - `next_billing_date`: Schedule the change for the next billing date
+   */
+  effective_at?: 'immediately' | 'next_billing_date';
+
   /**
    * Metadata for the payment. If not passed, the metadata of the subscription will
    * be taken

package/src/resources/your-webhook-url.ts

@@ -0,0 +1,138 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as DisputesAPI from './disputes';
+import * as LicenseKeysAPI from './license-keys';
+import * as PaymentsAPI from './payments';
+import * as RefundsAPI from './refunds';
+import * as SubscriptionsAPI from './subscriptions';
+import * as WebhookEventsAPI from './webhook-events';
+import * as BalancesAPI from './credit-entitlements/balances';
+import { APIPromise } from '../core/api-promise';
+import { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+
+export class YourWebhookURL extends APIResource {
+  create(params: YourWebhookURLCreateParams, options?: RequestOptions): APIPromise<void> {
+    const {
+      'webhook-id': webhookID,
+      'webhook-signature': webhookSignature,
+      'webhook-timestamp': webhookTimestamp,
+      ...body
+    } = params;
+    return this._client.post('/your-webhook-url', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          Accept: '*/*',
+          'webhook-id': webhookID,
+          'webhook-signature': webhookSignature,
+          'webhook-timestamp': webhookTimestamp,
+        },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+export interface YourWebhookURLCreateParams {
+  /**
+   * Body param
+   */
+  business_id: string;
+
+  /**
+   * Body param: The latest data at the time of delivery attempt
+   */
+  data:
+    | YourWebhookURLCreateParams.Payment
+    | YourWebhookURLCreateParams.Subscription
+    | YourWebhookURLCreateParams.Refund
+    | YourWebhookURLCreateParams.Dispute
+    | YourWebhookURLCreateParams.LicenseKey
+    | YourWebhookURLCreateParams.CreditLedgerEntry
+    | YourWebhookURLCreateParams.CreditBalanceLow;
+
+  /**
+   * Body param: The timestamp of when the event occurred (not necessarily the same
+   * of when it was delivered)
+   */
+  timestamp: string;
+
+  /**
+   * Body param: Event types for Dodo events
+   */
+  type: WebhookEventsAPI.WebhookEventType;
+
+  /**
+   * Header param: Unique identifier for the webhook
+   */
+  'webhook-id': string;
+
+  /**
+   * Header param: Signature of the Webhook
+   */
+  'webhook-signature': string;
+
+  /**
+   * Header param: Unix timestamp when the webhook was sent
+   */
+  'webhook-timestamp': string;
+}
+
+export namespace YourWebhookURLCreateParams {
+  export interface Payment extends PaymentsAPI.Payment {
+    payload_type: 'Payment';
+  }
+
+  /**
+   * Response struct representing subscription details
+   */
+  export interface Subscription extends SubscriptionsAPI.Subscription {
+    payload_type: 'Subscription';
+  }
+
+  export interface Refund extends RefundsAPI.Refund {
+    payload_type: 'Refund';
+  }
+
+  export interface Dispute extends DisputesAPI.GetDispute {
+    payload_type: 'Dispute';
+  }
+
+  export interface LicenseKey extends LicenseKeysAPI.LicenseKey {
+    payload_type: 'LicenseKey';
+  }
+
+  /**
+   * Response for a ledger entry
+   */
+  export interface CreditLedgerEntry extends BalancesAPI.CreditLedgerEntry {
+    payload_type: 'CreditLedgerEntry';
+  }
+
+  export interface CreditBalanceLow {
+    available_balance: string;
+
+    credit_entitlement_id: string;
+
+    credit_entitlement_name: string;
+
+    customer_id: string;
+
+    payload_type: 'CreditBalanceLow';
+
+    subscription_credits_amount: string;
+
+    subscription_id: string;
+
+    threshold_amount: string;
+
+    threshold_percent: number;
+  }
+}
+
+export declare namespace YourWebhookURL {
+  export { type YourWebhookURLCreateParams as YourWebhookURLCreateParams };
+}

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '2.23.2'; // x-release-please-version
+export const VERSION = '2.24.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "2.23.2";
+export declare const VERSION = "2.24.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.23.2'; // x-release-please-version
+exports.VERSION = '2.24.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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