dodopayments 2.32.0 → 2.32.2

package/src/resources/credit-entitlements/balances.ts

@@ -11,37 +11,6 @@ import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
 export class Balances extends APIResource {
-  /**
-   * Returns the credit balance details for a specific customer and credit
-   * entitlement.
-   *
-   * # Authentication
-   *
-   * Requires an API key with `Viewer` role or higher.
-   *
-   * # Path Parameters
-   *
-   * - `credit_entitlement_id` - The unique identifier of the credit entitlement
-   * - `customer_id` - The unique identifier of the customer
-   *
-   * # Responses
-   *
-   * - `200 OK` - Returns the customer's balance
-   * - `404 Not Found` - Credit entitlement or customer balance not found
-   * - `500 Internal Server Error` - Database or server error
-   */
-  retrieve(
-    customerID: string,
-    params: BalanceRetrieveParams,
-    options?: RequestOptions,
-  ): APIPromise<CustomerCreditBalance> {
-    const { credit_entitlement_id } = params;
-    return this._client.get(
-      path`/credit-entitlements/${credit_entitlement_id}/balances/${customerID}`,
-      options,
-    );
-  }
-
   /**
    * Returns a paginated list of customer credit balances for the given credit
    * entitlement.
@@ -79,43 +48,33 @@ export class Balances extends APIResource {
   }
 
   /**
-   * For credit entries, a new grant is created. For debit entries, credits are
-   * deducted from existing grants using FIFO (oldest first).
+   * Returns the credit balance details for a specific customer and credit
+   * entitlement.
    *
    * # Authentication
    *
-   * Requires an API key with `Editor` role.
+   * Requires an API key with `Viewer` role or higher.
    *
    * # Path Parameters
    *
    * - `credit_entitlement_id` - The unique identifier of the credit entitlement
    * - `customer_id` - The unique identifier of the customer
    *
-   * # Request Body
-   *
-   * - `entry_type` - "credit" or "debit"
-   * - `amount` - Amount to credit or debit
-   * - `reason` - Optional human-readable reason
-   * - `expires_at` - Optional expiration for credited amount (only for credit type)
-   * - `idempotency_key` - Optional key to prevent duplicate entries
-   *
    * # Responses
    *
-   * - `201 Created` - Ledger entry created successfully
-   * - `400 Bad Request` - Invalid request (e.g., debit with insufficient balance)
-   * - `404 Not Found` - Credit entitlement or customer not found
-   * - `409 Conflict` - Idempotency key already exists
+   * - `200 OK` - Returns the customer's balance
+   * - `404 Not Found` - Credit entitlement or customer balance not found
    * - `500 Internal Server Error` - Database or server error
    */
-  createLedgerEntry(
+  retrieve(
     customerID: string,
-    params: BalanceCreateLedgerEntryParams,
+    params: BalanceRetrieveParams,
     options?: RequestOptions,
-  ): APIPromise<BalanceCreateLedgerEntryResponse> {
-    const { credit_entitlement_id, ...body } = params;
-    return this._client.post(
-      path`/credit-entitlements/${credit_entitlement_id}/balances/${customerID}/ledger-entries`,
-      { body, ...options },
+  ): APIPromise<CustomerCreditBalance> {
+    const { credit_entitlement_id } = params;
+    return this._client.get(
+      path`/credit-entitlements/${credit_entitlement_id}/balances/${customerID}`,
+      options,
     );
   }
 
@@ -194,6 +153,47 @@ export class Balances extends APIResource {
       { query, ...options },
     );
   }
+
+  /**
+   * For credit entries, a new grant is created. For debit entries, credits are
+   * deducted from existing grants using FIFO (oldest first).
+   *
+   * # Authentication
+   *
+   * Requires an API key with `Editor` role.
+   *
+   * # Path Parameters
+   *
+   * - `credit_entitlement_id` - The unique identifier of the credit entitlement
+   * - `customer_id` - The unique identifier of the customer
+   *
+   * # Request Body
+   *
+   * - `entry_type` - "credit" or "debit"
+   * - `amount` - Amount to credit or debit
+   * - `reason` - Optional human-readable reason
+   * - `expires_at` - Optional expiration for credited amount (only for credit type)
+   * - `idempotency_key` - Optional key to prevent duplicate entries
+   *
+   * # Responses
+   *
+   * - `201 Created` - Ledger entry created successfully
+   * - `400 Bad Request` - Invalid request (e.g., debit with insufficient balance)
+   * - `404 Not Found` - Credit entitlement or customer not found
+   * - `409 Conflict` - Idempotency key already exists
+   * - `500 Internal Server Error` - Database or server error
+   */
+  createLedgerEntry(
+    customerID: string,
+    params: BalanceCreateLedgerEntryParams,
+    options?: RequestOptions,
+  ): APIPromise<BalanceCreateLedgerEntryResponse> {
+    const { credit_entitlement_id, ...body } = params;
+    return this._client.post(
+      path`/credit-entitlements/${credit_entitlement_id}/balances/${customerID}/ledger-entries`,
+      { body, ...options },
+    );
+  }
 }
 
 export type CustomerCreditBalancesDefaultPageNumberPagination =
@@ -340,13 +340,6 @@ export interface BalanceListGrantsResponse {
   source_id?: string | null;
 }
 
-export interface BalanceRetrieveParams {
-  /**
-   * Credit Entitlement ID
-   */
-  credit_entitlement_id: string;
-}
-
 export interface BalanceListParams extends DefaultPageNumberPaginationParams {
   /**
    * Filter by specific customer ID
@@ -354,77 +347,84 @@ export interface BalanceListParams extends DefaultPageNumberPaginationParams {
   customer_id?: string;
 }
 
-export interface BalanceCreateLedgerEntryParams {
+export interface BalanceRetrieveParams {
   /**
-   * Path param: Credit Entitlement ID
+   * Credit Entitlement ID
    */
   credit_entitlement_id: string;
+}
 
+export interface BalanceListGrantsParams extends DefaultPageNumberPaginationParams {
   /**
-   * Body param: Amount to credit or debit
+   * Path param: Credit Entitlement ID
    */
-  amount: string;
+  credit_entitlement_id: string;
 
   /**
-   * Body param: Entry type: credit or debit
+   * Query param: Filter by grant status: active, expired, depleted
    */
-  entry_type: LedgerEntryType;
+  status?: 'active' | 'expired' | 'depleted';
+}
 
+export interface BalanceListLedgerParams extends DefaultPageNumberPaginationParams {
   /**
-   * Body param: Expiration for credited amount (only for credit type)
+   * Path param: Credit Entitlement ID
    */
-  expires_at?: string | null;
+  credit_entitlement_id: string;
 
   /**
-   * Body param: Idempotency key to prevent duplicate entries
+   * Query param: Filter by end date
    */
-  idempotency_key?: string | null;
+  end_date?: string;
 
   /**
-   * Body param: Optional metadata (max 50 key-value pairs, key max 40 chars, value
-   * max 500 chars)
+   * Query param: Filter by start date
    */
-  metadata?: { [key: string]: string } | null;
+  start_date?: string;
 
   /**
-   * Body param: Human-readable reason for the entry
+   * Query param: Filter by transaction type (snake_case: credit_added,
+   * credit_deducted, credit_expired, etc.)
    */
-  reason?: string | null;
+  transaction_type?: string;
 }
 
-export interface BalanceListGrantsParams extends DefaultPageNumberPaginationParams {
+export interface BalanceCreateLedgerEntryParams {
   /**
    * Path param: Credit Entitlement ID
    */
   credit_entitlement_id: string;
 
   /**
-   * Query param: Filter by grant status: active, expired, depleted
+   * Body param: Amount to credit or debit
    */
-  status?: 'active' | 'expired' | 'depleted';
-}
+  amount: string;
 
-export interface BalanceListLedgerParams extends DefaultPageNumberPaginationParams {
   /**
-   * Path param: Credit Entitlement ID
+   * Body param: Entry type: credit or debit
    */
-  credit_entitlement_id: string;
+  entry_type: LedgerEntryType;
 
   /**
-   * Query param: Filter by end date
+   * Body param: Expiration for credited amount (only for credit type)
    */
-  end_date?: string;
+  expires_at?: string | null;
 
   /**
-   * Query param: Filter by start date
+   * Body param: Idempotency key to prevent duplicate entries
    */
-  start_date?: string;
+  idempotency_key?: string | null;
 
   /**
-   * Query param: Filter by transaction type (snake_case: credit_added,
-   * credit_deducted, credit_expired, etc.)
+   * Body param: Optional metadata (max 50 key-value pairs, key max 40 chars, value
+   * max 500 chars)
    */
-  transaction_type?: string;
+  metadata?: { [key: string]: string } | null;
+
+  /**
+   * Body param: Human-readable reason for the entry
+   */
+  reason?: string | null;
 }
 
 export declare namespace Balances {
@@ -437,10 +437,10 @@ export declare namespace Balances {
     type CustomerCreditBalancesDefaultPageNumberPagination as CustomerCreditBalancesDefaultPageNumberPagination,
     type BalanceListGrantsResponsesDefaultPageNumberPagination as BalanceListGrantsResponsesDefaultPageNumberPagination,
     type CreditLedgerEntriesDefaultPageNumberPagination as CreditLedgerEntriesDefaultPageNumberPagination,
-    type BalanceRetrieveParams as BalanceRetrieveParams,
     type BalanceListParams as BalanceListParams,
-    type BalanceCreateLedgerEntryParams as BalanceCreateLedgerEntryParams,
+    type BalanceRetrieveParams as BalanceRetrieveParams,
     type BalanceListGrantsParams as BalanceListGrantsParams,
     type BalanceListLedgerParams as BalanceListLedgerParams,
+    type BalanceCreateLedgerEntryParams as BalanceCreateLedgerEntryParams,
   };
 }

package/src/resources/credit-entitlements/credit-entitlements.ts

@@ -33,6 +33,44 @@ import { path } from '../../internal/utils/path';
 export class CreditEntitlements extends APIResource {
   balances: BalancesAPI.Balances = new BalancesAPI.Balances(this._client);
 
+  /**
+   * Returns a paginated list of credit entitlements, allowing filtering of deleted
+   * entitlements. By default, only non-deleted entitlements are returned.
+   *
+   * # Authentication
+   *
+   * Requires an API key with `Viewer` role or higher.
+   *
+   * # Query Parameters
+   *
+   * - `page_size` - Number of items per page (default: 10, max: 100)
+   * - `page_number` - Zero-based page number (default: 0)
+   * - `deleted` - Boolean flag to list deleted entitlements instead of active ones
+   *   (default: false)
+   *
+   * # Responses
+   *
+   * - `200 OK` - Returns a list of credit entitlements wrapped in a response object
+   * - `422 Unprocessable Entity` - Invalid query parameters (e.g., page_size > 100)
+   * - `500 Internal Server Error` - Database or server error
+   *
+   * # Business Logic
+   *
+   * - Results are ordered by creation date in descending order (newest first)
+   * - Only entitlements belonging to the authenticated business are returned
+   * - The `deleted` parameter controls visibility of soft-deleted entitlements
+   * - Pagination uses offset-based pagination (offset = page_number \* page_size)
+   */
+  list(
+    query: CreditEntitlementListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<CreditEntitlementsDefaultPageNumberPagination, CreditEntitlement> {
+    return this._client.getAPIList('/credit-entitlements', DefaultPageNumberPagination<CreditEntitlement>, {
+      query,
+      ...options,
+    });
+  }
+
   /**
    * Credit entitlements define reusable credit templates that can be attached to
    * products. Each entitlement defines how credits behave in terms of expiration,
@@ -112,6 +150,13 @@ export class CreditEntitlements extends APIResource {
     return this._client.get(path`/credit-entitlements/${id}`, options);
   }
 
+  delete(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/credit-entitlements/${id}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
   /**
    * Allows partial updates to a credit entitlement's configuration. Only the fields
    * provided in the request body will be updated; all other fields remain unchanged.
@@ -178,51 +223,6 @@ export class CreditEntitlements extends APIResource {
     });
   }
 
-  /**
-   * Returns a paginated list of credit entitlements, allowing filtering of deleted
-   * entitlements. By default, only non-deleted entitlements are returned.
-   *
-   * # Authentication
-   *
-   * Requires an API key with `Viewer` role or higher.
-   *
-   * # Query Parameters
-   *
-   * - `page_size` - Number of items per page (default: 10, max: 100)
-   * - `page_number` - Zero-based page number (default: 0)
-   * - `deleted` - Boolean flag to list deleted entitlements instead of active ones
-   *   (default: false)
-   *
-   * # Responses
-   *
-   * - `200 OK` - Returns a list of credit entitlements wrapped in a response object
-   * - `422 Unprocessable Entity` - Invalid query parameters (e.g., page_size > 100)
-   * - `500 Internal Server Error` - Database or server error
-   *
-   * # Business Logic
-   *
-   * - Results are ordered by creation date in descending order (newest first)
-   * - Only entitlements belonging to the authenticated business are returned
-   * - The `deleted` parameter controls visibility of soft-deleted entitlements
-   * - Pagination uses offset-based pagination (offset = page_number \* page_size)
-   */
-  list(
-    query: CreditEntitlementListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<CreditEntitlementsDefaultPageNumberPagination, CreditEntitlement> {
-    return this._client.getAPIList('/credit-entitlements', DefaultPageNumberPagination<CreditEntitlement>, {
-      query,
-      ...options,
-    });
-  }
-
-  delete(id: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.delete(path`/credit-entitlements/${id}`, {
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
-  }
-
   /**
    * Undeletes a soft-deleted credit entitlement by clearing `deleted_at`, making it
    * available again through standard list and get endpoints.
@@ -337,6 +337,13 @@ export interface CreditEntitlement {
   rollover_timeframe_interval?: SubscriptionsAPI.TimeInterval | null;
 }
 
+export interface CreditEntitlementListParams extends DefaultPageNumberPaginationParams {
+  /**
+   * List deleted credit entitlements
+   */
+  deleted?: boolean;
+}
+
 export interface CreditEntitlementCreateParams {
   /**
    * Name of the credit entitlement
@@ -487,13 +494,6 @@ export interface CreditEntitlementUpdateParams {
   unit?: string | null;
 }
 
-export interface CreditEntitlementListParams extends DefaultPageNumberPaginationParams {
-  /**
-   * List deleted credit entitlements
-   */
-  deleted?: boolean;
-}
-
 CreditEntitlements.Balances = Balances;
 
 export declare namespace CreditEntitlements {
@@ -501,9 +501,9 @@ export declare namespace CreditEntitlements {
     type CbbOverageBehavior as CbbOverageBehavior,
     type CreditEntitlement as CreditEntitlement,
     type CreditEntitlementsDefaultPageNumberPagination as CreditEntitlementsDefaultPageNumberPagination,
+    type CreditEntitlementListParams as CreditEntitlementListParams,
     type CreditEntitlementCreateParams as CreditEntitlementCreateParams,
     type CreditEntitlementUpdateParams as CreditEntitlementUpdateParams,
-    type CreditEntitlementListParams as CreditEntitlementListParams,
   };
 
   export {
@@ -516,10 +516,10 @@ export declare namespace CreditEntitlements {
     type CustomerCreditBalancesDefaultPageNumberPagination as CustomerCreditBalancesDefaultPageNumberPagination,
     type BalanceListGrantsResponsesDefaultPageNumberPagination as BalanceListGrantsResponsesDefaultPageNumberPagination,
     type CreditLedgerEntriesDefaultPageNumberPagination as CreditLedgerEntriesDefaultPageNumberPagination,
-    type BalanceRetrieveParams as BalanceRetrieveParams,
     type BalanceListParams as BalanceListParams,
-    type BalanceCreateLedgerEntryParams as BalanceCreateLedgerEntryParams,
+    type BalanceRetrieveParams as BalanceRetrieveParams,
     type BalanceListGrantsParams as BalanceListGrantsParams,
     type BalanceListLedgerParams as BalanceListLedgerParams,
+    type BalanceCreateLedgerEntryParams as BalanceCreateLedgerEntryParams,
   };
 }

package/src/resources/credit-entitlements/index.ts

@@ -7,11 +7,11 @@ export {
   type LedgerEntryType,
   type BalanceCreateLedgerEntryResponse,
   type BalanceListGrantsResponse,
-  type BalanceRetrieveParams,
   type BalanceListParams,
-  type BalanceCreateLedgerEntryParams,
+  type BalanceRetrieveParams,
   type BalanceListGrantsParams,
   type BalanceListLedgerParams,
+  type BalanceCreateLedgerEntryParams,
   type CustomerCreditBalancesDefaultPageNumberPagination,
   type BalanceListGrantsResponsesDefaultPageNumberPagination,
   type CreditLedgerEntriesDefaultPageNumberPagination,
@@ -20,8 +20,8 @@ export {
   CreditEntitlements,
   type CbbOverageBehavior,
   type CreditEntitlement,
+  type CreditEntitlementListParams,
   type CreditEntitlementCreateParams,
   type CreditEntitlementUpdateParams,
-  type CreditEntitlementListParams,
   type CreditEntitlementsDefaultPageNumberPagination,
 } from './credit-entitlements';

package/src/resources/customers/customers.ts

@@ -22,26 +22,43 @@ export class Customers extends APIResource {
   customerPortal: CustomerPortalAPI.CustomerPortal = new CustomerPortalAPI.CustomerPortal(this._client);
   wallets: WalletsAPI.Wallets = new WalletsAPI.Wallets(this._client);
 
-  create(body: CustomerCreateParams, options?: RequestOptions): APIPromise<Customer> {
-    return this._client.post('/customers', { body, ...options });
+  list(
+    query: CustomerListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<CustomersDefaultPageNumberPagination, Customer> {
+    return this._client.getAPIList('/customers', DefaultPageNumberPagination<Customer>, {
+      query,
+      ...options,
+    });
   }
 
   retrieve(customerID: string, options?: RequestOptions): APIPromise<Customer> {
     return this._client.get(path`/customers/${customerID}`, options);
   }
 
+  create(body: CustomerCreateParams, options?: RequestOptions): APIPromise<Customer> {
+    return this._client.post('/customers', { body, ...options });
+  }
+
   update(customerID: string, body: CustomerUpdateParams, options?: RequestOptions): APIPromise<Customer> {
     return this._client.patch(path`/customers/${customerID}`, { body, ...options });
   }
 
-  list(
-    query: CustomerListParams | null | undefined = {},
+  retrievePaymentMethods(
+    customerID: string,
     options?: RequestOptions,
-  ): PagePromise<CustomersDefaultPageNumberPagination, Customer> {
-    return this._client.getAPIList('/customers', DefaultPageNumberPagination<Customer>, {
-      query,
-      ...options,
-    });
+  ): APIPromise<CustomerRetrievePaymentMethodsResponse> {
+    return this._client.get(path`/customers/${customerID}/payment-methods`, options);
+  }
+
+  /**
+   * List all credit entitlements for a customer with their current balances
+   */
+  listCreditEntitlements(
+    customerID: string,
+    options?: RequestOptions,
+  ): APIPromise<CustomerListCreditEntitlementsResponse> {
+    return this._client.get(path`/customers/${customerID}/credit-entitlements`, options);
   }
 
   deletePaymentMethod(
@@ -56,16 +73,6 @@ export class Customers extends APIResource {
     });
   }
 
-  /**
-   * List all credit entitlements for a customer with their current balances
-   */
-  listCreditEntitlements(
-    customerID: string,
-    options?: RequestOptions,
-  ): APIPromise<CustomerListCreditEntitlementsResponse> {
-    return this._client.get(path`/customers/${customerID}/credit-entitlements`, options);
-  }
-
   /**
    * List all entitlement grants delivered (or in flight) to a customer.
    */
@@ -75,13 +82,6 @@ export class Customers extends APIResource {
   ): APIPromise<CustomerListEntitlementsResponse> {
     return this._client.get(path`/customers/${customerID}/entitlements`, options);
   }
-
-  retrievePaymentMethods(
-    customerID: string,
-    options?: RequestOptions,
-  ): APIPromise<CustomerRetrievePaymentMethodsResponse> {
-    return this._client.get(path`/customers/${customerID}/payment-methods`, options);
-  }
 }
 
 export type CustomersDefaultPageNumberPagination = DefaultPageNumberPagination<Customer>;
@@ -245,6 +245,28 @@ export namespace CustomerRetrievePaymentMethodsResponse {
   }
 }
 
+export interface CustomerListParams extends DefaultPageNumberPaginationParams {
+  /**
+   * Filter customers created on or after this timestamp
+   */
+  created_at_gte?: string;
+
+  /**
+   * Filter customers created on or before this timestamp
+   */
+  created_at_lte?: string;
+
+  /**
+   * Filter by customer email
+   */
+  email?: string;
+
+  /**
+   * Filter by customer name (partial match, case-insensitive)
+   */
+  name?: string;
+}
+
 export interface CustomerCreateParams {
   email: string;
 
@@ -271,28 +293,6 @@ export interface CustomerUpdateParams {
   phone_number?: string | null;
 }
 
-export interface CustomerListParams extends DefaultPageNumberPaginationParams {
-  /**
-   * Filter customers created on or after this timestamp
-   */
-  created_at_gte?: string;
-
-  /**
-   * Filter customers created on or before this timestamp
-   */
-  created_at_lte?: string;
-
-  /**
-   * Filter by customer email
-   */
-  email?: string;
-
-  /**
-   * Filter by customer name (partial match, case-insensitive)
-   */
-  name?: string;
-}
-
 export interface CustomerDeletePaymentMethodParams {
   /**
    * Customer Id
@@ -311,9 +311,9 @@ export declare namespace Customers {
     type CustomerListEntitlementsResponse as CustomerListEntitlementsResponse,
     type CustomerRetrievePaymentMethodsResponse as CustomerRetrievePaymentMethodsResponse,
     type CustomersDefaultPageNumberPagination as CustomersDefaultPageNumberPagination,
+    type CustomerListParams as CustomerListParams,
     type CustomerCreateParams as CustomerCreateParams,
     type CustomerUpdateParams as CustomerUpdateParams,
-    type CustomerListParams as CustomerListParams,
     type CustomerDeletePaymentMethodParams as CustomerDeletePaymentMethodParams,
   };
 

package/src/resources/customers/index.ts

@@ -8,9 +8,9 @@ export {
   type CustomerListCreditEntitlementsResponse,
   type CustomerListEntitlementsResponse,
   type CustomerRetrievePaymentMethodsResponse,
+  type CustomerListParams,
   type CustomerCreateParams,
   type CustomerUpdateParams,
-  type CustomerListParams,
   type CustomerDeletePaymentMethodParams,
   type CustomersDefaultPageNumberPagination,
 } from './customers';

package/src/resources/customers/wallets/index.ts

@@ -3,8 +3,8 @@
 export {
   LedgerEntries,
   type CustomerWalletTransaction,
-  type LedgerEntryCreateParams,
   type LedgerEntryListParams,
+  type LedgerEntryCreateParams,
   type CustomerWalletTransactionsDefaultPageNumberPagination,
 } from './ledger-entries';
 export { Wallets, type CustomerWallet, type WalletListResponse } from './wallets';