dodopayments 2.31.2 → 2.32.0

package/src/client.ts

@@ -68,6 +68,7 @@ import {
 import {
   Discount,
   DiscountCreateParams,
+  DiscountDetail,
   DiscountListParams,
   DiscountType,
   DiscountUpdateParams,
@@ -111,6 +112,7 @@ import {
 import {
   Conjunction,
   FilterOperator,
+  FilterType,
   Meter,
   MeterAggregation,
   MeterCreateParams,
@@ -221,6 +223,7 @@ import {
   EntitlementUpdateParams,
   Entitlements,
   EntitlementsDefaultPageNumberPagination,
+  GitHubPermission,
   IntegrationConfig,
   IntegrationConfigResponse,
 } from './resources/entitlements/entitlements';
@@ -231,6 +234,18 @@ import {
   PayoutListResponsesDefaultPageNumberPagination,
   Payouts,
 } from './resources/payouts/payouts';
+import {
+  ProductCollection,
+  ProductCollectionCreateParams,
+  ProductCollectionListParams,
+  ProductCollectionListResponse,
+  ProductCollectionListResponsesDefaultPageNumberPagination,
+  ProductCollectionUnarchiveResponse,
+  ProductCollectionUpdateImagesParams,
+  ProductCollectionUpdateImagesResponse,
+  ProductCollectionUpdateParams,
+  ProductCollections,
+} from './resources/product-collections/product-collections';
 import {
   AddMeterToPrice,
   AttachCreditEntitlement,
@@ -1096,6 +1111,7 @@ export class DodoPayments {
   balances: API.Balances = new API.Balances(this);
   creditEntitlements: API.CreditEntitlements = new API.CreditEntitlements(this);
   entitlements: API.Entitlements = new API.Entitlements(this);
+  productCollections: API.ProductCollections = new API.ProductCollections(this);
 }
 
 DodoPayments.CheckoutSessions = CheckoutSessions;
@@ -1121,6 +1137,7 @@ DodoPayments.Meters = Meters;
 DodoPayments.Balances = Balances;
 DodoPayments.CreditEntitlements = CreditEntitlements;
 DodoPayments.Entitlements = Entitlements;
+DodoPayments.ProductCollections = ProductCollections;
 
 export declare namespace DodoPayments {
   export type RequestOptions = Opts.RequestOptions;
@@ -1313,6 +1330,7 @@ export declare namespace DodoPayments {
   export {
     Discounts as Discounts,
     type Discount as Discount,
+    type DiscountDetail as DiscountDetail,
     type DiscountType as DiscountType,
     type DiscountsDefaultPageNumberPagination as DiscountsDefaultPageNumberPagination,
     type DiscountCreateParams as DiscountCreateParams,
@@ -1410,6 +1428,7 @@ export declare namespace DodoPayments {
     Meters as Meters,
     type Conjunction as Conjunction,
     type FilterOperator as FilterOperator,
+    type FilterType as FilterType,
     type Meter as Meter,
     type MeterAggregation as MeterAggregation,
     type MeterFilter as MeterFilter,
@@ -1439,6 +1458,7 @@ export declare namespace DodoPayments {
     Entitlements as Entitlements,
     type Entitlement as Entitlement,
     type EntitlementIntegrationType as EntitlementIntegrationType,
+    type GitHubPermission as GitHubPermission,
     type IntegrationConfig as IntegrationConfig,
     type IntegrationConfigResponse as IntegrationConfigResponse,
     type EntitlementsDefaultPageNumberPagination as EntitlementsDefaultPageNumberPagination,
@@ -1446,4 +1466,17 @@ export declare namespace DodoPayments {
     type EntitlementUpdateParams as EntitlementUpdateParams,
     type EntitlementListParams as EntitlementListParams,
   };
+
+  export {
+    ProductCollections as ProductCollections,
+    type ProductCollection as ProductCollection,
+    type ProductCollectionListResponse as ProductCollectionListResponse,
+    type ProductCollectionUnarchiveResponse as ProductCollectionUnarchiveResponse,
+    type ProductCollectionUpdateImagesResponse as ProductCollectionUpdateImagesResponse,
+    type ProductCollectionListResponsesDefaultPageNumberPagination as ProductCollectionListResponsesDefaultPageNumberPagination,
+    type ProductCollectionCreateParams as ProductCollectionCreateParams,
+    type ProductCollectionUpdateParams as ProductCollectionUpdateParams,
+    type ProductCollectionListParams as ProductCollectionListParams,
+    type ProductCollectionUpdateImagesParams as ProductCollectionUpdateImagesParams,
+  };
 }

package/src/resources/checkout-sessions.ts

@@ -93,6 +93,17 @@ export interface CheckoutSessionFlags {
    */
   allow_currency_selection?: boolean;
 
+  /**
+   * If true, the customer can supply or edit the business name associated with the
+   * tax id during checkout. Works independently of `allow_customer_editing_tax_id` —
+   * either flag (or `allow_tax_id`) is sufficient to let the customer override the
+   * session's business name. Typically set together with
+   * `allow_customer_editing_tax_id`.
+   *
+   * Default is false
+   */
+  allow_customer_editing_business_name?: boolean;
+
   allow_customer_editing_city?: boolean;
 
   allow_customer_editing_country?: boolean;
@@ -199,6 +210,13 @@ export interface CheckoutSessionRequest {
    */
   customer?: PaymentsAPI.CustomerRequest | null;
 
+  /**
+   * Optional business / legal name associated with the tax id. When provided
+   * together with a valid tax id for a B2B purchase, this name is rendered on the
+   * invoice instead of the customer's personal name.
+   */
+  customer_business_name?: string | null;
+
   /**
    * Customization for the checkout session page
    */
@@ -289,6 +307,26 @@ export interface CheckoutSessionResponse {
    * Checkout url (None when payment_method_id is provided)
    */
   checkout_url?: string | null;
+
+  /**
+   * Client secret used to load the Dodo Payments checkout SDK. Returned when
+   * `confirm: true` was passed and a PaymentIntent was created at session-creation
+   * time. `None` otherwise.
+   */
+  client_secret?: string | null;
+
+  /**
+   * Underlying payment id when `confirm: true` was passed and a PaymentIntent was
+   * created at session-creation time. `None` otherwise.
+   */
+  payment_id?: string | null;
+
+  /**
+   * Publishable key for the Dodo Payments checkout SDK. Returned when
+   * `confirm: true` was passed and a PaymentIntent was created at session-creation
+   * time. `None` otherwise.
+   */
+  publishable_key?: string | null;
 }
 
 export interface CheckoutSessionStatus {
@@ -867,6 +905,13 @@ export interface CheckoutSessionCreateParams {
    */
   customer?: PaymentsAPI.CustomerRequest | null;
 
+  /**
+   * Optional business / legal name associated with the tax id. When provided
+   * together with a valid tax id for a B2B purchase, this name is rendered on the
+   * invoice instead of the customer's personal name.
+   */
+  customer_business_name?: string | null;
+
   /**
    * Customization for the checkout session page
    */
@@ -992,6 +1037,13 @@ export interface CheckoutSessionPreviewParams {
    */
   customer?: PaymentsAPI.CustomerRequest | null;
 
+  /**
+   * Optional business / legal name associated with the tax id. When provided
+   * together with a valid tax id for a B2B purchase, this name is rendered on the
+   * invoice instead of the customer's personal name.
+   */
+  customer_business_name?: string | null;
+
   /**
    * Customization for the checkout session page
    */

package/src/resources/discounts.ts

@@ -145,6 +145,93 @@ export interface Discount {
   usage_limit?: number | null;
 }
 
+/**
+ * Response struct for a discount with its position in a stack and optional
+ * cycle-tracking information (for subscriptions).
+ */
+export interface DiscountDetail {
+  /**
+   * The discount amount (basis points for percentage, USD cents for flat)
+   */
+  amount: number;
+
+  /**
+   * The business this discount belongs to
+   */
+  business_id: string;
+
+  /**
+   * The discount code
+   */
+  code: string;
+
+  /**
+   * Timestamp when the discount was created
+   */
+  created_at: string;
+
+  /**
+   * The unique discount ID
+   */
+  discount_id: string;
+
+  /**
+   * Additional metadata
+   */
+  metadata: { [key: string]: string };
+
+  /**
+   * Position of this discount in the stack (0-based)
+   */
+  position: number;
+
+  /**
+   * Whether this discount should be preserved when a subscription changes plans
+   */
+  preserve_on_plan_change: boolean;
+
+  /**
+   * List of product IDs to which this discount is restricted
+   */
+  restricted_to: Array<string>;
+
+  /**
+   * How many times this discount has been used
+   */
+  times_used: number;
+
+  /**
+   * The type of discount
+   */
+  type: DiscountType;
+
+  /**
+   * Remaining billing cycles for this discount on this subscription (None for
+   * one-time payments)
+   */
+  cycles_remaining?: number | null;
+
+  /**
+   * Optional date/time after which discount is expired
+   */
+  expires_at?: string | null;
+
+  /**
+   * Name for the Discount
+   */
+  name?: string | null;
+
+  /**
+   * Number of subscription billing cycles this discount is valid for
+   */
+  subscription_cycles?: number | null;
+
+  /**
+   * Usage limit for this discount, if any
+   */
+  usage_limit?: number | null;
+}
+
 export type DiscountType = 'percentage';
 
 export interface DiscountCreateParams {
@@ -287,6 +374,7 @@ export interface DiscountListParams extends DefaultPageNumberPaginationParams {
 export declare namespace Discounts {
   export {
     type Discount as Discount,
+    type DiscountDetail as DiscountDetail,
     type DiscountType as DiscountType,
     type DiscountsDefaultPageNumberPagination as DiscountsDefaultPageNumberPagination,
     type DiscountCreateParams as DiscountCreateParams,

package/src/resources/entitlements/entitlements.ts

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
+import * as EntitlementsAPI from './entitlements';
 import * as SubscriptionsAPI from '../subscriptions';
 import * as FilesAPI from './files';
 import { FileDeleteParams, FileUploadResponse, Files } from './files';
@@ -142,6 +143,11 @@ export type EntitlementIntegrationType =
   | 'digital_files'
   | 'license_key';
 
+/**
+ * Repository permission to grant on a `github` entitlement.
+ */
+export type GitHubPermission = 'pull' | 'push' | 'admin' | 'maintain' | 'triage';
+
 /**
  * Integration-specific configuration supplied when creating or updating an
  * entitlement. The shape required matches the entitlement's `integration_type`.
@@ -161,7 +167,7 @@ export namespace IntegrationConfig {
     /**
      * Permission to grant on the repository.
      */
-    permission: 'pull' | 'push' | 'admin' | 'maintain' | 'triage';
+    permission: EntitlementsAPI.GitHubPermission;
 
     /**
      * Repository or organisation slug to grant access to.
@@ -288,7 +294,7 @@ export namespace IntegrationConfigResponse {
     /**
      * Permission to grant on the repository.
      */
-    permission: 'pull' | 'push' | 'admin' | 'maintain' | 'triage';
+    permission: EntitlementsAPI.GitHubPermission;
 
     /**
      * Repository or organisation slug to grant access to.
@@ -494,6 +500,7 @@ export declare namespace Entitlements {
   export {
     type Entitlement as Entitlement,
     type EntitlementIntegrationType as EntitlementIntegrationType,
+    type GitHubPermission as GitHubPermission,
     type IntegrationConfig as IntegrationConfig,
     type IntegrationConfigResponse as IntegrationConfigResponse,
     type EntitlementsDefaultPageNumberPagination as EntitlementsDefaultPageNumberPagination,

package/src/resources/entitlements/index.ts

@@ -4,6 +4,7 @@ export {
   Entitlements,
   type Entitlement,
   type EntitlementIntegrationType,
+  type GitHubPermission,
   type IntegrationConfig,
   type IntegrationConfigResponse,
   type EntitlementCreateParams,

package/src/resources/index.ts

@@ -65,6 +65,7 @@ export {
 export {
   Discounts,
   type Discount,
+  type DiscountDetail,
   type DiscountType,
   type DiscountCreateParams,
   type DiscountUpdateParams,
@@ -85,6 +86,7 @@ export {
   Entitlements,
   type Entitlement,
   type EntitlementIntegrationType,
+  type GitHubPermission,
   type IntegrationConfig,
   type IntegrationConfigResponse,
   type EntitlementCreateParams,
@@ -121,6 +123,7 @@ export {
   Meters,
   type Conjunction,
   type FilterOperator,
+  type FilterType,
   type Meter,
   type MeterAggregation,
   type MeterFilter,
@@ -164,6 +167,18 @@ export {
   type PayoutListParams,
   type PayoutListResponsesDefaultPageNumberPagination,
 } from './payouts/payouts';
+export {
+  ProductCollections,
+  type ProductCollection,
+  type ProductCollectionListResponse,
+  type ProductCollectionUnarchiveResponse,
+  type ProductCollectionUpdateImagesResponse,
+  type ProductCollectionCreateParams,
+  type ProductCollectionUpdateParams,
+  type ProductCollectionListParams,
+  type ProductCollectionUpdateImagesParams,
+  type ProductCollectionListResponsesDefaultPageNumberPagination,
+} from './product-collections/product-collections';
 export {
   Products,
   type AddMeterToPrice,

package/src/resources/invoices/payments.ts

@@ -15,6 +15,14 @@ export class Payments extends APIResource {
     });
   }
 
+  retrievePayout(payoutID: string, options?: RequestOptions): APIPromise<Response> {
+    return this._client.get(path`/invoices/payouts/${payoutID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: 'application/pdf' }, options?.headers]),
+      __binaryResponse: true,
+    });
+  }
+
   retrieveRefund(refundID: string, options?: RequestOptions): APIPromise<Response> {
     return this._client.get(path`/invoices/refunds/${refundID}`, {
       ...options,

package/src/resources/meters.ts

@@ -57,6 +57,32 @@ export type FilterOperator =
   | 'contains'
   | 'does_not_contain';
 
+/**
+ * Filter clauses — either a flat list of `MeterFilterCondition`s or a list of
+ * nested `MeterFilter`s. Up to 3 levels of nesting are accepted; the limit is
+ * enforced at runtime.
+ */
+export type FilterType = Array<FilterType.MeterFilterConditionList> | Array<MeterFilter>;
+
+export namespace FilterType {
+  export interface MeterFilterConditionList {
+    /**
+     * Filter key to apply
+     */
+    key: string;
+
+    /**
+     * Filter operator
+     */
+    operator: MetersAPI.FilterOperator;
+
+    /**
+     * Filter value - can be string, number, or boolean
+     */
+    value: string | number | boolean;
+  }
+}
+
 export interface Meter {
   id: string;
 
@@ -112,7 +138,7 @@ export interface MeterFilter {
    * Filter clauses - can be direct conditions or nested filters (up to 3 levels
    * deep)
    */
-  clauses: Array<MeterFilter.DirectFilterCondition> | Array<MeterFilter.NestedMeterFilter>;
+  clauses: FilterType;
 
   /**
    * Logical conjunction to apply between clauses (and/or)
@@ -120,118 +146,6 @@ export interface MeterFilter {
   conjunction: Conjunction;
 }
 
-export namespace MeterFilter {
-  /**
-   * Filter condition with key, operator, and value
-   */
-  export interface DirectFilterCondition {
-    /**
-     * Filter key to apply
-     */
-    key: string;
-
-    operator: MetersAPI.FilterOperator;
-
-    /**
-     * Filter value - can be string, number, or boolean
-     */
-    value: string | number | boolean;
-  }
-
-  /**
-   * Level 1 nested filter - can contain Level 2 filters
-   */
-  export interface NestedMeterFilter {
-    /**
-     * Level 1: Can be conditions or nested filters (2 more levels allowed)
-     */
-    clauses: Array<NestedMeterFilter.Level1FilterCondition> | Array<NestedMeterFilter.Level1NestedFilter>;
-
-    conjunction: MetersAPI.Conjunction;
-  }
-
-  export namespace NestedMeterFilter {
-    /**
-     * Filter condition with key, operator, and value
-     */
-    export interface Level1FilterCondition {
-      /**
-       * Filter key to apply
-       */
-      key: string;
-
-      operator: MetersAPI.FilterOperator;
-
-      /**
-       * Filter value - can be string, number, or boolean
-       */
-      value: string | number | boolean;
-    }
-
-    /**
-     * Level 2 nested filter
-     */
-    export interface Level1NestedFilter {
-      /**
-       * Level 2: Can be conditions or nested filters (1 more level allowed)
-       */
-      clauses: Array<Level1NestedFilter.Level2FilterCondition> | Array<Level1NestedFilter.Level2NestedFilter>;
-
-      conjunction: MetersAPI.Conjunction;
-    }
-
-    export namespace Level1NestedFilter {
-      /**
-       * Filter condition with key, operator, and value
-       */
-      export interface Level2FilterCondition {
-        /**
-         * Filter key to apply
-         */
-        key: string;
-
-        operator: MetersAPI.FilterOperator;
-
-        /**
-         * Filter value - can be string, number, or boolean
-         */
-        value: string | number | boolean;
-      }
-
-      /**
-       * Level 3 nested filter (final nesting level)
-       */
-      export interface Level2NestedFilter {
-        /**
-         * Level 3: Filter conditions only (max depth reached)
-         */
-        clauses: Array<Level2NestedFilter.Clause>;
-
-        conjunction: MetersAPI.Conjunction;
-      }
-
-      export namespace Level2NestedFilter {
-        /**
-         * Filter condition with key, operator, and value
-         */
-        export interface Clause {
-          /**
-           * Filter key to apply
-           */
-          key: string;
-
-          operator: MetersAPI.FilterOperator;
-
-          /**
-           * Filter value - can be string, number, or boolean
-           */
-          value: string | number | boolean;
-        }
-      }
-    }
-  }
-}
-
 export interface MeterCreateParams {
   /**
    * Aggregation configuration for the meter
@@ -275,6 +189,7 @@ export declare namespace Meters {
   export {
     type Conjunction as Conjunction,
     type FilterOperator as FilterOperator,
+    type FilterType as FilterType,
     type Meter as Meter,
     type MeterAggregation as MeterAggregation,
     type MeterFilter as MeterFilter,

package/src/resources/payments.ts

@@ -301,7 +301,7 @@ export interface Payment {
   /**
    * All stacked discounts applied, ordered by position
    */
-  discounts?: Array<Payment.Discount> | null;
+  discounts?: Array<DiscountsAPI.DiscountDetail> | null;
 
   /**
    * An error code if the payment failed
@@ -378,93 +378,6 @@ export interface Payment {
 }
 
 export namespace Payment {
-  /**
-   * Response struct for a discount with its position in a stack and optional
-   * cycle-tracking information (for subscriptions).
-   */
-  export interface Discount {
-    /**
-     * The discount amount (basis points for percentage, USD cents for flat)
-     */
-    amount: number;
-
-    /**
-     * The business this discount belongs to
-     */
-    business_id: string;
-
-    /**
-     * The discount code
-     */
-    code: string;
-
-    /**
-     * Timestamp when the discount was created
-     */
-    created_at: string;
-
-    /**
-     * The unique discount ID
-     */
-    discount_id: string;
-
-    /**
-     * Additional metadata
-     */
-    metadata: { [key: string]: string };
-
-    /**
-     * Position of this discount in the stack (0-based)
-     */
-    position: number;
-
-    /**
-     * Whether this discount should be preserved when a subscription changes plans
-     */
-    preserve_on_plan_change: boolean;
-
-    /**
-     * List of product IDs to which this discount is restricted
-     */
-    restricted_to: Array<string>;
-
-    /**
-     * How many times this discount has been used
-     */
-    times_used: number;
-
-    /**
-     * The type of discount
-     */
-    type: DiscountsAPI.DiscountType;
-
-    /**
-     * Remaining billing cycles for this discount on this subscription (None for
-     * one-time payments)
-     */
-    cycles_remaining?: number | null;
-
-    /**
-     * Optional date/time after which discount is expired
-     */
-    expires_at?: string | null;
-
-    /**
-     * Name for the Discount
-     */
-    name?: string | null;
-
-    /**
-     * Number of subscription billing cycles this discount is valid for
-     */
-    subscription_cycles?: number | null;
-
-    /**
-     * Usage limit for this discount, if any
-     */
-    usage_limit?: number | null;
-  }
-
   export interface ProductCart {
     product_id: string;
 
@@ -555,6 +468,7 @@ export type PaymentMethodTypes =
   | 'sepa'
   | 'sepa_bank_transfer'
   | 'sofort'
+  | 'sunbit'
   | 'swish'
   | 'touch_n_go'
   | 'trustly'
@@ -794,6 +708,13 @@ export interface PaymentCreateParams {
    */
   billing_currency?: MiscAPI.Currency | null;
 
+  /**
+   * Optional business / legal name associated with the tax id. When provided
+   * together with a valid tax id for a B2B purchase, this name is rendered on the
+   * invoice instead of the customer's personal name.
+   */
+  customer_business_name?: string | null;
+
   /**
    * @deprecated Use `discount_id` instead.
    */