@whop/sdk 0.0.38 → 0.0.40

package/src/resources/shared.ts

@@ -375,6 +375,7 @@ export type AuthorizedUserRoles =
   | 'admin'
   | 'sales_manager'
   | 'moderator'
+  | 'advertiser'
   | 'app_manager'
   | 'support'
   | 'manager'
@@ -549,6 +550,12 @@ export namespace CheckoutConfiguration {
      */
     id: string;
 
+    /**
+     * Whether the creator has turned on adaptive pricing for this plan. Raw setting —
+     * does not check processor compatibility or feature flags.
+     */
+    adaptive_pricing_enabled: boolean;
+
     /**
      * The number of days between each recurring charge. Null for one-time plans. For
      * example, 30 for monthly or 365 for annual billing.
@@ -592,6 +599,11 @@ export namespace CheckoutConfiguration {
      */
     renewal_price: number;
 
+    /**
+     * The 3D Secure behavior for a plan.
+     */
+    three_ds_level: 'mandate_challenge' | 'frictionless' | null;
+
     /**
      * The number of free trial days before the first charge on a renewal plan. Null if
      * no trial is configured or the current user has already used a trial for this
@@ -1076,7 +1088,11 @@ export type Currency =
   | 'rub'
   | 'btc'
   | 'cny'
-  | 'usdt';
+  | 'usdt'
+  | 'kzt'
+  | 'awg'
+  | 'whop_usd'
+  | 'xau';
 
 /**
  * The different types of custom CTAs that can be selected.
@@ -1872,6 +1888,13 @@ export interface Membership {
    */
   cancellation_reason: string | null;
 
+  /**
+   * The ID of the checkout session/configuration that produced this membership, if
+   * any. Use this to map memberships back to the checkout configuration that created
+   * them.
+   */
+  checkout_configuration_id: string | null;
+
   /**
    * The company this membership belongs to.
    */
@@ -2029,6 +2052,12 @@ export namespace Membership {
      * The unique identifier for the plan.
      */
     id: string;
+
+    /**
+     * Custom key-value pairs stored on the plan. Included in webhook payloads for
+     * payment and membership events.
+     */
+    metadata: { [key: string]: unknown } | null;
   }
 
   /**
@@ -2040,6 +2069,12 @@ export namespace Membership {
      */
     id: string;
 
+    /**
+     * Custom key-value pairs stored on the product. Included in webhook payloads for
+     * payment and membership events.
+     */
+    metadata: { [key: string]: unknown } | null;
+
     /**
      * The display name of the product shown to customers on the product page and in
      * search results.
@@ -2339,6 +2374,12 @@ export interface Payment {
    */
   card_last4: string | null;
 
+  /**
+   * The ID of the checkout session/configuration that produced this payment, if any.
+   * Use this to map payments back to the checkout configuration that created them.
+   */
+  checkout_configuration_id: string | null;
+
   /**
    * The company for the payment.
    */
@@ -2350,9 +2391,9 @@ export interface Payment {
   created_at: string;
 
   /**
-   * The available currencies on the platform
+   * The three-letter ISO currency code for this payment (e.g., 'usd', 'eur').
    */
-  currency: Currency | null;
+  currency: Currency;
 
   /**
    * When an alert came in that this transaction will be disputed
@@ -2475,6 +2516,22 @@ export interface Payment {
    */
   retryable: boolean;
 
+  /**
+   * The total amount charged to the customer for this payment, including taxes and
+   * after any discounts. In the currency specified by the currency field.
+   */
+  settlement_amount: number;
+
+  /**
+   * The three-letter ISO currency code for this payment (e.g., 'usd', 'eur').
+   */
+  settlement_currency: Currency;
+
+  /**
+   * Deprecated. Always returns null.
+   */
+  settlement_exchange_rate: number | null;
+
   /**
    * The status of a receipt
    */
@@ -2650,8 +2707,7 @@ export namespace Payment {
     currency: Shared.Currency;
 
     /**
-     * Whether the dispute evidence can still be edited and submitted. Returns true
-     * only when the dispute status requires a response.
+     * Whether the dispute evidence can still be edited and submitted.
      */
     editable: boolean | null;
 
@@ -2756,6 +2812,11 @@ export namespace Payment {
      */
     id: string;
 
+    /**
+     * The phone number associated with this membership.
+     */
+    phone_number: string | null;
+
     /**
      * The state of the membership.
      */
@@ -2829,6 +2890,12 @@ export namespace Payment {
      * A personal description or notes section for the business.
      */
     internal_notes: string | null;
+
+    /**
+     * Custom key-value pairs stored on the plan. Included in webhook payloads for
+     * payment and membership events.
+     */
+    metadata: { [key: string]: unknown } | null;
   }
 
   /**
@@ -2840,6 +2907,12 @@ export namespace Payment {
      */
     id: string;
 
+    /**
+     * Custom key-value pairs stored on the product. Included in webhook payloads for
+     * payment and membership events.
+     */
+    metadata: { [key: string]: unknown } | null;
+
     /**
      * The URL slug used in the product's public link (e.g., 'my-product' in
      * whop.com/company/my-product).
@@ -2982,6 +3055,12 @@ export interface Plan {
    */
   id: string;
 
+  /**
+   * Whether the creator has turned on adaptive pricing for this plan. Raw setting —
+   * does not check processor compatibility or feature flags.
+   */
+  adaptive_pricing_enabled: boolean;
+
   /**
    * The number of days between each recurring charge. Null for one-time plans. For
    * example, 30 for monthly or 365 for annual billing.
@@ -3054,6 +3133,12 @@ export interface Plan {
    */
   member_count: number | null;
 
+  /**
+   * Custom key-value pairs stored on the plan. Included in webhook payloads for
+   * payment and membership events.
+   */
+  metadata: { [key: string]: unknown } | null;
+
   /**
    * The explicit payment method configuration specifying which payment methods are
    * enabled or disabled for this plan. Null if the plan uses default settings.
@@ -3108,6 +3193,11 @@ export interface Plan {
    */
   tax_type: TaxType;
 
+  /**
+   * The 3D Secure behavior for a plan.
+   */
+  three_ds_level: 'mandate_challenge' | 'frictionless' | null;
+
   /**
    * The display name of the plan shown to customers on the product page and at
    * checkout. Maximum 30 characters. Null if no title has been set.
@@ -3344,6 +3434,12 @@ export interface Product {
    */
   member_count: number;
 
+  /**
+   * Custom key-value pairs stored on the product. Included in webhook payloads for
+   * payment and membership events.
+   */
+  metadata: { [key: string]: unknown } | null;
+
   /**
    * The user who owns the company that sells this product.
    */
@@ -3506,6 +3602,12 @@ export interface ProductListItem {
    */
   member_count: number;
 
+  /**
+   * Custom key-value pairs stored on the product. Included in webhook payloads for
+   * payment and membership events.
+   */
+  metadata: { [key: string]: unknown } | null;
+
   /**
    * The total number of published customer reviews for this product's company.
    */

package/src/resources/shipments.ts

@@ -11,6 +11,30 @@ import { path } from '../internal/utils/path';
  * Shipments
  */
 export class Shipments extends APIResource {
+  /**
+   * Returns a paginated list of shipments, with optional filtering by payment,
+   * company, or user.
+   *
+   * Required permissions:
+   *
+   * - `shipment:basic:read`
+   * - `payment:basic:read`
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const shipmentListResponse of client.shipments.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: ShipmentListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ShipmentListResponsesCursorPage, ShipmentListResponse> {
+    return this._client.getAPIList('/shipments', CursorPage<ShipmentListResponse>, { query, ...options });
+  }
+
   /**
    * Create a new shipment with a tracking code for a specific payment within a
    * company.
@@ -51,30 +75,6 @@ export class Shipments extends APIResource {
   retrieve(id: string, options?: RequestOptions): APIPromise<Shared.Shipment> {
     return this._client.get(path`/shipments/${id}`, options);
   }
-
-  /**
-   * Returns a paginated list of shipments, with optional filtering by payment,
-   * company, or user.
-   *
-   * Required permissions:
-   *
-   * - `shipment:basic:read`
-   * - `payment:basic:read`
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const shipmentListResponse of client.shipments.list()) {
-   *   // ...
-   * }
-   * ```
-   */
-  list(
-    query: ShipmentListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<ShipmentListResponsesCursorPage, ShipmentListResponse> {
-    return this._client.getAPIList('/shipments', CursorPage<ShipmentListResponse>, { query, ...options });
-  }
 }
 
 export type ShipmentListResponsesCursorPage = CursorPage<ShipmentListResponse>;
@@ -151,25 +151,6 @@ export namespace ShipmentListResponse {
   }
 }
 
-export interface ShipmentCreateParams {
-  /**
-   * The unique identifier of the company to create the shipment for, starting with
-   * 'biz\_'.
-   */
-  company_id: string;
-
-  /**
-   * The unique identifier of the payment to associate the shipment with.
-   */
-  payment_id: string;
-
-  /**
-   * The carrier tracking code for the shipment, such as a USPS, UPS, or FedEx
-   * tracking number.
-   */
-  tracking_code: string;
-}
-
 export interface ShipmentListParams extends CursorPageParams {
   /**
    * Returns the elements in the list that come before the specified cursor.
@@ -202,11 +183,30 @@ export interface ShipmentListParams extends CursorPageParams {
   user_id?: string | null;
 }
 
+export interface ShipmentCreateParams {
+  /**
+   * The unique identifier of the company to create the shipment for, starting with
+   * 'biz\_'.
+   */
+  company_id: string;
+
+  /**
+   * The unique identifier of the payment to associate the shipment with.
+   */
+  payment_id: string;
+
+  /**
+   * The carrier tracking code for the shipment, such as a USPS, UPS, or FedEx
+   * tracking number.
+   */
+  tracking_code: string;
+}
+
 export declare namespace Shipments {
   export {
     type ShipmentListResponse as ShipmentListResponse,
     type ShipmentListResponsesCursorPage as ShipmentListResponsesCursorPage,
-    type ShipmentCreateParams as ShipmentCreateParams,
     type ShipmentListParams as ShipmentListParams,
+    type ShipmentCreateParams as ShipmentCreateParams,
   };
 }

package/src/resources/support-channels.ts

@@ -12,23 +12,29 @@ import { path } from '../internal/utils/path';
  */
 export class SupportChannels extends APIResource {
   /**
-   * Open a new support channel between a company team member and a customer. Returns
-   * the existing channel if one already exists for that user.
+   * Returns a paginated list of support channels for a specific company, with
+   * optional filtering by resolution status and custom sorting.
    *
    * Required permissions:
    *
-   * - `support_chat:create`
+   * - `support_chat:read`
    *
    * @example
    * ```ts
-   * const supportChannel = await client.supportChannels.create({
-   *   company_id: 'biz_xxxxxxxxxxxxxx',
-   *   user_id: 'user_xxxxxxxxxxxxx',
-   * });
+   * // Automatically fetches more pages as needed.
+   * for await (const supportChannelListResponse of client.supportChannels.list()) {
+   *   // ...
+   * }
    * ```
    */
-  create(body: SupportChannelCreateParams, options?: RequestOptions): APIPromise<Shared.SupportChannel> {
-    return this._client.post('/support_channels', { body, ...options });
+  list(
+    query: SupportChannelListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<SupportChannelListResponsesCursorPage, SupportChannelListResponse> {
+    return this._client.getAPIList('/support_channels', CursorPage<SupportChannelListResponse>, {
+      query,
+      ...options,
+    });
   }
 
   /**
@@ -49,31 +55,23 @@ export class SupportChannels extends APIResource {
   }
 
   /**
-   * Returns a paginated list of support channels for a specific company, with
-   * optional filtering by resolution status and custom sorting.
+   * Open a new support channel between a company team member and a customer. Returns
+   * the existing channel if one already exists for that user.
    *
    * Required permissions:
    *
-   * - `support_chat:read`
+   * - `support_chat:create`
    *
    * @example
    * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const supportChannelListResponse of client.supportChannels.list(
-   *   { company_id: 'biz_xxxxxxxxxxxxxx' },
-   * )) {
-   *   // ...
-   * }
+   * const supportChannel = await client.supportChannels.create({
+   *   company_id: 'biz_xxxxxxxxxxxxxx',
+   *   user_id: 'user_xxxxxxxxxxxxx',
+   * });
    * ```
    */
-  list(
-    query: SupportChannelListParams,
-    options?: RequestOptions,
-  ): PagePromise<SupportChannelListResponsesCursorPage, SupportChannelListResponse> {
-    return this._client.getAPIList('/support_channels', CursorPage<SupportChannelListResponse>, {
-      query,
-      ...options,
-    });
+  create(body: SupportChannelCreateParams, options?: RequestOptions): APIPromise<Shared.SupportChannel> {
+    return this._client.post('/support_channels', { body, ...options });
   }
 }
 
@@ -143,34 +141,18 @@ export namespace SupportChannelListResponse {
   }
 }
 
-export interface SupportChannelCreateParams {
-  /**
-   * The unique identifier of the company to create the support channel in.
-   */
-  company_id: string;
-
-  /**
-   * The user ID (e.g. 'user_xxxxx') or username of the customer to open a support
-   * channel for.
-   */
-  user_id: string;
-
-  /**
-   * Optional custom display name for the support channel.
-   */
-  custom_name?: string | null;
-}
-
 export interface SupportChannelListParams extends CursorPageParams {
   /**
-   * The unique identifier of the company to list support channels for.
+   * Returns the elements in the list that come before the specified cursor.
    */
-  company_id: string;
+  before?: string | null;
 
   /**
-   * Returns the elements in the list that come before the specified cursor.
+   * The unique identifier of the company to list support channels for. Includes
+   * channels of child companies. When omitted, returns support channels across all
+   * companies the user has access to.
    */
-  before?: string | null;
+  company_id?: string | null;
 
   /**
    * The direction of the sort.
@@ -197,13 +179,36 @@ export interface SupportChannelListParams extends CursorPageParams {
    * Sort options for message channels
    */
   order?: 'created_at' | 'last_post_sent_at' | null;
+
+  /**
+   * The perspective to filter support channels by.
+   */
+  view?: 'all' | 'admin' | 'customer' | null;
+}
+
+export interface SupportChannelCreateParams {
+  /**
+   * The unique identifier of the company to create the support channel in.
+   */
+  company_id: string;
+
+  /**
+   * The user ID (e.g. 'user_xxxxx') or username of the customer to open a support
+   * channel for.
+   */
+  user_id: string;
+
+  /**
+   * Optional custom display name for the support channel.
+   */
+  custom_name?: string | null;
 }
 
 export declare namespace SupportChannels {
   export {
     type SupportChannelListResponse as SupportChannelListResponse,
     type SupportChannelListResponsesCursorPage as SupportChannelListResponsesCursorPage,
-    type SupportChannelCreateParams as SupportChannelCreateParams,
     type SupportChannelListParams as SupportChannelListParams,
+    type SupportChannelCreateParams as SupportChannelCreateParams,
   };
 }

package/src/resources/swaps.ts

@@ -0,0 +1,87 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+export class Swaps extends APIResource {
+  /**
+   * Returns a stateless swap price preview. No funds move and nothing is persisted.
+   */
+  createQuote(body: SwapCreateQuoteParams, options?: RequestOptions): APIPromise<SwapCreateQuoteResponse> {
+    return this._client.post('/swaps/quote', { body, ...options });
+  }
+}
+
+export interface SwapCreateQuoteResponse {
+  amount_in: string;
+
+  amount_out: string;
+
+  cross_chain: boolean;
+
+  fee_bps: number;
+
+  from_token: { [key: string]: unknown };
+
+  metadata: { [key: string]: unknown };
+
+  object: 'swap_quote';
+
+  rate: string;
+
+  to_token: { [key: string]: unknown };
+
+  amount_out_min?: string;
+
+  bridge_fee?: string | null;
+
+  estimated_duration_seconds?: number | null;
+
+  from_address?: string | null;
+
+  requires_token_approval?: boolean | null;
+
+  to_address?: string | null;
+}
+
+export interface SwapCreateQuoteParams {
+  /**
+   * Input token amount.
+   */
+  amount: string;
+
+  /**
+   * Source token contract address.
+   */
+  from_token: string;
+
+  /**
+   * Destination token contract address.
+   */
+  to_token: string;
+
+  /**
+   * Caller-owned account whose wallet address should be used.
+   */
+  account_id?: string | null;
+
+  from_address?: string | null;
+
+  from_chain?: string | number | null;
+
+  metadata?: { [key: string]: unknown };
+
+  slippage_bps?: number | null;
+
+  to_address?: string | null;
+
+  to_chain?: string | number | null;
+}
+
+export declare namespace Swaps {
+  export {
+    type SwapCreateQuoteResponse as SwapCreateQuoteResponse,
+    type SwapCreateQuoteParams as SwapCreateQuoteParams,
+  };
+}