dodopayments 2.32.1 → 2.33.0

package/src/resources/subscriptions.ts

@@ -17,6 +17,16 @@ import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
 export class Subscriptions extends APIResource {
+  list(
+    query: SubscriptionListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<SubscriptionListResponsesDefaultPageNumberPagination, SubscriptionListResponse> {
+    return this._client.getAPIList('/subscriptions', DefaultPageNumberPagination<SubscriptionListResponse>, {
+      query,
+      ...options,
+    });
+  }
+
   /**
    * @deprecated
    */
@@ -36,35 +46,6 @@ export class Subscriptions extends APIResource {
     return this._client.patch(path`/subscriptions/${subscriptionID}`, { body, ...options });
   }
 
-  list(
-    query: SubscriptionListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<SubscriptionListResponsesDefaultPageNumberPagination, SubscriptionListResponse> {
-    return this._client.getAPIList('/subscriptions', DefaultPageNumberPagination<SubscriptionListResponse>, {
-      query,
-      ...options,
-    });
-  }
-
-  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,
-    options?: RequestOptions,
-  ): APIPromise<void> {
-    return this._client.post(path`/subscriptions/${subscriptionID}/change-plan`, {
-      body,
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
-  }
-
   charge(
     subscriptionID: string,
     body: SubscriptionChargeParams,
@@ -73,24 +54,18 @@ export class Subscriptions extends APIResource {
     return this._client.post(path`/subscriptions/${subscriptionID}/charge`, { body, ...options });
   }
 
-  previewChangePlan(
+  changePlan(
     subscriptionID: string,
-    body: SubscriptionPreviewChangePlanParams,
+    body: SubscriptionChangePlanParams,
     options?: RequestOptions,
-  ): APIPromise<SubscriptionPreviewChangePlanResponse> {
-    return this._client.post(path`/subscriptions/${subscriptionID}/change-plan/preview`, {
+  ): APIPromise<void> {
+    return this._client.post(path`/subscriptions/${subscriptionID}/change-plan`, {
       body,
       ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 
-  retrieveCreditUsage(
-    subscriptionID: string,
-    options?: RequestOptions,
-  ): APIPromise<SubscriptionRetrieveCreditUsageResponse> {
-    return this._client.get(path`/subscriptions/${subscriptionID}/credit-usage`, options);
-  }
-
   /**
    * Get detailed usage history for a subscription that includes usage-based billing
    * (metered components). This endpoint provides insights into customer usage
@@ -161,6 +136,31 @@ export class Subscriptions extends APIResource {
       ...options,
     });
   }
+
+  previewChangePlan(
+    subscriptionID: string,
+    body: SubscriptionPreviewChangePlanParams,
+    options?: RequestOptions,
+  ): APIPromise<SubscriptionPreviewChangePlanResponse> {
+    return this._client.post(path`/subscriptions/${subscriptionID}/change-plan/preview`, {
+      body,
+      ...options,
+    });
+  }
+
+  retrieveCreditUsage(
+    subscriptionID: string,
+    options?: RequestOptions,
+  ): APIPromise<SubscriptionRetrieveCreditUsageResponse> {
+    return this._client.get(path`/subscriptions/${subscriptionID}/credit-usage`, options);
+  }
+
+  cancelChangePlan(subscriptionID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/subscriptions/${subscriptionID}/change-plan/scheduled`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
 }
 
 export type SubscriptionListResponsesDefaultPageNumberPagination =
@@ -1146,6 +1146,38 @@ export interface SubscriptionUpdatePaymentMethodResponse {
   payment_link?: string | null;
 }
 
+export interface SubscriptionListParams extends DefaultPageNumberPaginationParams {
+  /**
+   * filter by Brand id
+   */
+  brand_id?: string;
+
+  /**
+   * Get events after this created time
+   */
+  created_at_gte?: string;
+
+  /**
+   * Get events created before this time
+   */
+  created_at_lte?: string;
+
+  /**
+   * Filter by customer id
+   */
+  customer_id?: string;
+
+  /**
+   * Filter by product id
+   */
+  product_id?: string;
+
+  /**
+   * Filter by status
+   */
+  status?: 'pending' | 'active' | 'on_hold' | 'cancelled' | 'failed' | 'expired';
+}
+
 export interface SubscriptionCreateParams {
   /**
    * Billing address information for the subscription
@@ -1370,36 +1402,59 @@ export namespace SubscriptionUpdateParams {
   }
 }
 
-export interface SubscriptionListParams extends DefaultPageNumberPaginationParams {
+export interface SubscriptionChargeParams {
   /**
-   * filter by Brand id
+   * The product price. Represented in the lowest denomination of the currency (e.g.,
+   * cents for USD). For example, to charge $1.00, pass `100`.
    */
-  brand_id?: string;
+  product_price: number;
 
   /**
-   * Get events after this created time
+   * Whether adaptive currency fees should be included in the product_price (true) or
+   * added on top (false). This field is ignored if adaptive pricing is not enabled
+   * for the business.
    */
-  created_at_gte?: string;
+  adaptive_currency_fees_inclusive?: boolean | null;
 
   /**
-   * Get events created before this time
+   * Specify how customer balance is used for the payment
    */
-  created_at_lte?: string;
+  customer_balance_config?: SubscriptionChargeParams.CustomerBalanceConfig | null;
 
   /**
-   * Filter by customer id
+   * Metadata for the payment. If not passed, the metadata of the subscription will
+   * be taken
    */
-  customer_id?: string;
+  metadata?: { [key: string]: string } | null;
 
   /**
-   * Filter by product id
+   * Optional currency of the product price. If not specified, defaults to the
+   * currency of the product.
    */
-  product_id?: string;
+  product_currency?: MiscAPI.Currency | null;
 
   /**
-   * Filter by status
+   * Optional product description override for billing and line items. If not
+   * specified, the stored description of the product will be used.
    */
-  status?: 'pending' | 'active' | 'on_hold' | 'cancelled' | 'failed' | 'expired';
+  product_description?: string | null;
+}
+
+export namespace SubscriptionChargeParams {
+  /**
+   * Specify how customer balance is used for the payment
+   */
+  export interface CustomerBalanceConfig {
+    /**
+     * Allows Customer Credit to be purchased to settle payments
+     */
+    allow_customer_credits_purchase?: boolean | null;
+
+    /**
+     * Allows Customer Credit Balance to be used to settle payments
+     */
+    allow_customer_credits_usage?: boolean | null;
+  }
 }
 
 export interface SubscriptionChangePlanParams {
@@ -1473,58 +1528,38 @@ export interface SubscriptionChangePlanParams {
   on_payment_failure?: 'prevent_change' | 'apply_change' | null;
 }
 
-export interface SubscriptionChargeParams {
+export interface SubscriptionRetrieveUsageHistoryParams extends DefaultPageNumberPaginationParams {
   /**
-   * The product price. Represented in the lowest denomination of the currency (e.g.,
-   * cents for USD). For example, to charge $1.00, pass `100`.
+   * Filter by end date (inclusive)
    */
-  product_price: number;
+  end_date?: string | null;
 
   /**
-   * Whether adaptive currency fees should be included in the product_price (true) or
-   * added on top (false). This field is ignored if adaptive pricing is not enabled
-   * for the business.
+   * Filter by specific meter ID
    */
-  adaptive_currency_fees_inclusive?: boolean | null;
+  meter_id?: string | null;
 
   /**
-   * Specify how customer balance is used for the payment
+   * Filter by start date (inclusive)
    */
-  customer_balance_config?: SubscriptionChargeParams.CustomerBalanceConfig | null;
+  start_date?: string | null;
+}
 
-  /**
-   * Metadata for the payment. If not passed, the metadata of the subscription will
-   * be taken
-   */
-  metadata?: { [key: string]: string } | null;
+export interface SubscriptionUpdatePaymentMethodParams {
+  payment_method: SubscriptionUpdatePaymentMethodParams.New | SubscriptionUpdatePaymentMethodParams.Existing;
+}
 
-  /**
-   * Optional currency of the product price. If not specified, defaults to the
-   * currency of the product.
-   */
-  product_currency?: MiscAPI.Currency | null;
+export namespace SubscriptionUpdatePaymentMethodParams {
+  export interface New {
+    type: 'new';
 
-  /**
-   * Optional product description override for billing and line items. If not
-   * specified, the stored description of the product will be used.
-   */
-  product_description?: string | null;
-}
+    return_url?: string | null;
+  }
 
-export namespace SubscriptionChargeParams {
-  /**
-   * Specify how customer balance is used for the payment
-   */
-  export interface CustomerBalanceConfig {
-    /**
-     * Allows Customer Credit to be purchased to settle payments
-     */
-    allow_customer_credits_purchase?: boolean | null;
+  export interface Existing {
+    payment_method_id: string;
 
-    /**
-     * Allows Customer Credit Balance to be used to settle payments
-     */
-    allow_customer_credits_usage?: boolean | null;
+    type: 'existing';
   }
 }
 
@@ -1599,41 +1634,6 @@ export interface SubscriptionPreviewChangePlanParams {
   on_payment_failure?: 'prevent_change' | 'apply_change' | null;
 }
 
-export interface SubscriptionRetrieveUsageHistoryParams extends DefaultPageNumberPaginationParams {
-  /**
-   * Filter by end date (inclusive)
-   */
-  end_date?: string | null;
-
-  /**
-   * Filter by specific meter ID
-   */
-  meter_id?: string | null;
-
-  /**
-   * Filter by start date (inclusive)
-   */
-  start_date?: string | null;
-}
-
-export interface SubscriptionUpdatePaymentMethodParams {
-  payment_method: SubscriptionUpdatePaymentMethodParams.New | SubscriptionUpdatePaymentMethodParams.Existing;
-}
-
-export namespace SubscriptionUpdatePaymentMethodParams {
-  export interface New {
-    type: 'new';
-
-    return_url?: string | null;
-  }
-
-  export interface Existing {
-    payment_method_id: string;
-
-    type: 'existing';
-  }
-}
-
 export declare namespace Subscriptions {
   export {
     type AddonCartResponseItem as AddonCartResponseItem,
@@ -1657,13 +1657,13 @@ export declare namespace Subscriptions {
     type SubscriptionUpdatePaymentMethodResponse as SubscriptionUpdatePaymentMethodResponse,
     type SubscriptionListResponsesDefaultPageNumberPagination as SubscriptionListResponsesDefaultPageNumberPagination,
     type SubscriptionRetrieveUsageHistoryResponsesDefaultPageNumberPagination as SubscriptionRetrieveUsageHistoryResponsesDefaultPageNumberPagination,
+    type SubscriptionListParams as SubscriptionListParams,
     type SubscriptionCreateParams as SubscriptionCreateParams,
     type SubscriptionUpdateParams as SubscriptionUpdateParams,
-    type SubscriptionListParams as SubscriptionListParams,
-    type SubscriptionChangePlanParams as SubscriptionChangePlanParams,
     type SubscriptionChargeParams as SubscriptionChargeParams,
-    type SubscriptionPreviewChangePlanParams as SubscriptionPreviewChangePlanParams,
+    type SubscriptionChangePlanParams as SubscriptionChangePlanParams,
     type SubscriptionRetrieveUsageHistoryParams as SubscriptionRetrieveUsageHistoryParams,
     type SubscriptionUpdatePaymentMethodParams as SubscriptionUpdatePaymentMethodParams,
+    type SubscriptionPreviewChangePlanParams as SubscriptionPreviewChangePlanParams,
   };
 }

package/src/resources/usage-events.ts

@@ -12,37 +12,47 @@ import { path } from '../internal/utils/path';
 
 export class UsageEvents extends APIResource {
   /**
-   * Fetch detailed information about a single event using its unique event ID. This
-   * endpoint is useful for:
-   *
-   * - Debugging specific event ingestion issues
-   * - Retrieving event details for customer support
-   * - Validating that events were processed correctly
-   * - Getting the complete metadata for an event
-   *
-   * ## Event ID Format:
-   *
-   * The event ID should be the same value that was provided during event ingestion
-   * via the `/events/ingest` endpoint. Event IDs are case-sensitive and must match
-   * exactly.
+   * This endpoint allows you to ingest custom events that can be used for:
    *
-   * ## Response Details:
+   * - Usage-based billing and metering
+   * - Analytics and reporting
+   * - Customer behavior tracking
    *
-   * The response includes all event data including:
+   * ## Important Notes:
    *
-   * - Complete metadata key-value pairs
-   * - Original timestamp (preserved from ingestion)
-   * - Customer and business association
-   * - Event name and processing information
+   * - **Duplicate Prevention**:
+   *   - Duplicate `event_id` values within the same request are rejected (entire
+   *     request fails)
+   *   - Subsequent requests with existing `event_id` values are ignored (idempotent
+   *     behavior)
+   * - **Rate Limiting**: Maximum 1000 events per request
+   * - **Time Validation**: Events with timestamps older than 1 hour or more than 5
+   *   minutes in the future will be rejected
+   * - **Metadata Limits**: Maximum 50 key-value pairs per event, keys max 100 chars,
+   *   values max 500 chars
    *
    * ## Example Usage:
    *
-   * ```text
-   * GET /events/api_call_12345
+   * ```json
+   * {
+   *   "events": [
+   *     {
+   *       "event_id": "api_call_12345",
+   *       "customer_id": "cus_abc123",
+   *       "event_name": "api_request",
+   *       "timestamp": "2024-01-15T10:30:00Z",
+   *       "metadata": {
+   *         "endpoint": "/api/v1/users",
+   *         "method": "GET",
+   *         "tokens_used": "150"
+   *       }
+   *     }
+   *   ]
+   * }
    * ```
    */
-  retrieve(eventID: string, options?: RequestOptions): APIPromise<Event> {
-    return this._client.get(path`/events/${eventID}`, options);
+  ingest(body: UsageEventIngestParams, options?: RequestOptions): APIPromise<UsageEventIngestResponse> {
+    return this._client.post('/events/ingest', { body, ...options });
   }
 
   /**
@@ -88,47 +98,37 @@ export class UsageEvents extends APIResource {
   }
 
   /**
-   * This endpoint allows you to ingest custom events that can be used for:
+   * Fetch detailed information about a single event using its unique event ID. This
+   * endpoint is useful for:
    *
-   * - Usage-based billing and metering
-   * - Analytics and reporting
-   * - Customer behavior tracking
+   * - Debugging specific event ingestion issues
+   * - Retrieving event details for customer support
+   * - Validating that events were processed correctly
+   * - Getting the complete metadata for an event
    *
-   * ## Important Notes:
+   * ## Event ID Format:
    *
-   * - **Duplicate Prevention**:
-   *   - Duplicate `event_id` values within the same request are rejected (entire
-   *     request fails)
-   *   - Subsequent requests with existing `event_id` values are ignored (idempotent
-   *     behavior)
-   * - **Rate Limiting**: Maximum 1000 events per request
-   * - **Time Validation**: Events with timestamps older than 1 hour or more than 5
-   *   minutes in the future will be rejected
-   * - **Metadata Limits**: Maximum 50 key-value pairs per event, keys max 100 chars,
-   *   values max 500 chars
+   * The event ID should be the same value that was provided during event ingestion
+   * via the `/events/ingest` endpoint. Event IDs are case-sensitive and must match
+   * exactly.
+   *
+   * ## Response Details:
+   *
+   * The response includes all event data including:
+   *
+   * - Complete metadata key-value pairs
+   * - Original timestamp (preserved from ingestion)
+   * - Customer and business association
+   * - Event name and processing information
    *
    * ## Example Usage:
    *
-   * ```json
-   * {
-   *   "events": [
-   *     {
-   *       "event_id": "api_call_12345",
-   *       "customer_id": "cus_abc123",
-   *       "event_name": "api_request",
-   *       "timestamp": "2024-01-15T10:30:00Z",
-   *       "metadata": {
-   *         "endpoint": "/api/v1/users",
-   *         "method": "GET",
-   *         "tokens_used": "150"
-   *       }
-   *     }
-   *   ]
-   * }
+   * ```text
+   * GET /events/api_call_12345
    * ```
    */
-  ingest(body: UsageEventIngestParams, options?: RequestOptions): APIPromise<UsageEventIngestResponse> {
-    return this._client.post('/events/ingest', { body, ...options });
+  retrieve(eventID: string, options?: RequestOptions): APIPromise<Event> {
+    return this._client.get(path`/events/${eventID}`, options);
   }
 }
 
@@ -185,6 +185,13 @@ export interface UsageEventIngestResponse {
   ingested_count: number;
 }
 
+export interface UsageEventIngestParams {
+  /**
+   * List of events to be pushed
+   */
+  events: Array<EventInput>;
+}
+
 export interface UsageEventListParams extends DefaultPageNumberPaginationParams {
   /**
    * Filter events by customer ID
@@ -214,20 +221,13 @@ export interface UsageEventListParams extends DefaultPageNumberPaginationParams
   start?: string;
 }
 
-export interface UsageEventIngestParams {
-  /**
-   * List of events to be pushed
-   */
-  events: Array<EventInput>;
-}
-
 export declare namespace UsageEvents {
   export {
     type Event as Event,
     type EventInput as EventInput,
     type UsageEventIngestResponse as UsageEventIngestResponse,
     type EventsDefaultPageNumberPagination as EventsDefaultPageNumberPagination,
-    type UsageEventListParams as UsageEventListParams,
     type UsageEventIngestParams as UsageEventIngestParams,
+    type UsageEventListParams as UsageEventListParams,
   };
 }

package/src/resources/webhooks/index.ts

@@ -46,8 +46,8 @@ export {
   type SubscriptionUpdatedWebhookEvent,
   type UnsafeUnwrapWebhookEvent,
   type UnwrapWebhookEvent,
+  type WebhookListParams,
   type WebhookCreateParams,
   type WebhookUpdateParams,
-  type WebhookListParams,
   type WebhookDetailsCursorPagePagination,
 } from './webhooks';

package/src/resources/webhooks/webhooks.ts

@@ -21,6 +21,16 @@ import { path } from '../../internal/utils/path';
 export class Webhooks extends APIResource {
   headers: HeadersAPI.Headers = new HeadersAPI.Headers(this._client);
 
+  /**
+   * List all webhooks
+   */
+  list(
+    query: WebhookListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<WebhookDetailsCursorPagePagination, WebhookDetails> {
+    return this._client.getAPIList('/webhooks', CursorPagePagination<WebhookDetails>, { query, ...options });
+  }
+
   /**
    * Create a new webhook
    */
@@ -35,23 +45,6 @@ export class Webhooks extends APIResource {
     return this._client.get(path`/webhooks/${webhookID}`, options);
   }
 
-  /**
-   * Patch a webhook by id
-   */
-  update(webhookID: string, body: WebhookUpdateParams, options?: RequestOptions): APIPromise<WebhookDetails> {
-    return this._client.patch(path`/webhooks/${webhookID}`, { body, ...options });
-  }
-
-  /**
-   * List all webhooks
-   */
-  list(
-    query: WebhookListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<WebhookDetailsCursorPagePagination, WebhookDetails> {
-    return this._client.getAPIList('/webhooks', CursorPagePagination<WebhookDetails>, { query, ...options });
-  }
-
   /**
    * Delete a webhook by id
    */
@@ -62,6 +55,13 @@ export class Webhooks extends APIResource {
     });
   }
 
+  /**
+   * Patch a webhook by id
+   */
+  update(webhookID: string, body: WebhookUpdateParams, options?: RequestOptions): APIPromise<WebhookDetails> {
+    return this._client.patch(path`/webhooks/${webhookID}`, { body, ...options });
+  }
+
   /**
    * Get webhook secret by id
    */
@@ -69,10 +69,6 @@ export class Webhooks extends APIResource {
     return this._client.get(path`/webhooks/${webhookID}/secret`, options);
   }
 
-  unsafeUnwrap(body: string): UnsafeUnwrapWebhookEvent {
-    return JSON.parse(body) as UnsafeUnwrapWebhookEvent;
-  }
-
   unwrap(
     body: string,
     { headers, key }: { headers: Record<string, string>; key?: string },
@@ -85,6 +81,10 @@ export class Webhooks extends APIResource {
     }
     return JSON.parse(body) as UnwrapWebhookEvent;
   }
+
+  unsafeUnwrap(body: string): UnsafeUnwrapWebhookEvent {
+    return JSON.parse(body) as UnsafeUnwrapWebhookEvent;
+  }
 }
 
 export type WebhookDetailsCursorPagePagination = CursorPagePagination<WebhookDetails>;
@@ -2072,6 +2072,8 @@ export type UnwrapWebhookEvent =
   | SubscriptionRenewedWebhookEvent
   | SubscriptionUpdatedWebhookEvent;
 
+export interface WebhookListParams extends CursorPagePaginationParams {}
+
 export interface WebhookCreateParams {
   /**
    * Url of the webhook
@@ -2146,8 +2148,6 @@ export interface WebhookUpdateParams {
   url?: string | null;
 }
 
-export interface WebhookListParams extends CursorPagePaginationParams {}
-
 Webhooks.Headers = Headers;
 
 export declare namespace Webhooks {
@@ -2196,9 +2196,9 @@ export declare namespace Webhooks {
     type UnsafeUnwrapWebhookEvent as UnsafeUnwrapWebhookEvent,
     type UnwrapWebhookEvent as UnwrapWebhookEvent,
     type WebhookDetailsCursorPagePagination as WebhookDetailsCursorPagePagination,
+    type WebhookListParams as WebhookListParams,
     type WebhookCreateParams as WebhookCreateParams,
     type WebhookUpdateParams as WebhookUpdateParams,
-    type WebhookListParams as WebhookListParams,
   };
 
   export {

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '2.32.1'; // x-release-please-version
+export const VERSION = '2.33.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

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

package/version.mjs

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