@whop/sdk 0.0.38 → 0.0.40

package/src/resources/plans.ts

@@ -13,6 +13,31 @@ import { path } from '../internal/utils/path';
  * Plans
  */
 export class Plans extends APIResource {
+  /**
+   * Returns a paginated list of plans belonging to a company, with optional
+   * filtering by visibility, type, release method, and product.
+   *
+   * Required permissions:
+   *
+   * - `plan:basic:read`
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const planListResponse of client.plans.list({
+   *   company_id: 'biz_xxxxxxxxxxxxxx',
+   * })) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: PlanListParams,
+    options?: RequestOptions,
+  ): PagePromise<PlanListResponsesCursorPage, PlanListResponse> {
+    return this._client.getAPIList('/plans', CursorPage<PlanListResponse>, { query, ...options });
+  }
+
   /**
    * Create a new pricing plan for a product. The plan defines the billing interval,
    * price, and availability for customers.
@@ -78,31 +103,6 @@ export class Plans extends APIResource {
     return this._client.patch(path`/plans/${id}`, { body, ...options });
   }
 
-  /**
-   * Returns a paginated list of plans belonging to a company, with optional
-   * filtering by visibility, type, release method, and product.
-   *
-   * Required permissions:
-   *
-   * - `plan:basic:read`
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const planListResponse of client.plans.list({
-   *   company_id: 'biz_xxxxxxxxxxxxxx',
-   * })) {
-   *   // ...
-   * }
-   * ```
-   */
-  list(
-    query: PlanListParams,
-    options?: RequestOptions,
-  ): PagePromise<PlanListResponsesCursorPage, PlanListResponse> {
-    return this._client.getAPIList('/plans', CursorPage<PlanListResponse>, { query, ...options });
-  }
-
   /**
    * Permanently delete a plan from a product. Existing memberships on this plan will
    * not be affected.
@@ -146,6 +146,12 @@ export interface PlanListResponse {
    */
   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.
@@ -206,6 +212,12 @@ export interface PlanListResponse {
    */
   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.
@@ -254,6 +266,11 @@ export interface PlanListResponse {
    */
   stock: number | null;
 
+  /**
+   * 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.
@@ -363,6 +380,68 @@ export namespace PlanListResponse {
  */
 export type PlanDeleteResponse = boolean;
 
+export interface PlanListParams extends CursorPageParams {
+  /**
+   * The unique identifier of the company to list plans for.
+   */
+  company_id: string;
+
+  /**
+   * Returns the elements in the list that come before the specified cursor.
+   */
+  before?: string | null;
+
+  /**
+   * Only return plans created after this timestamp.
+   */
+  created_after?: string | null;
+
+  /**
+   * Only return plans created before this timestamp.
+   */
+  created_before?: string | null;
+
+  /**
+   * The direction of the sort.
+   */
+  direction?: Shared.Direction | null;
+
+  /**
+   * Returns the first _n_ elements from the list.
+   */
+  first?: number | null;
+
+  /**
+   * Returns the last _n_ elements from the list.
+   */
+  last?: number | null;
+
+  /**
+   * The ways a relation of Plans can be ordered
+   */
+  order?: 'id' | 'active_members_count' | 'created_at' | 'internal_notes' | 'expires_at' | null;
+
+  /**
+   * Filter to only plans matching these billing types.
+   */
+  plan_types?: Array<Shared.PlanType> | null;
+
+  /**
+   * Filter to only plans belonging to these product identifiers.
+   */
+  product_ids?: Array<string> | null;
+
+  /**
+   * Filter to only plans matching these release methods.
+   */
+  release_methods?: Array<Shared.ReleaseMethod> | null;
+
+  /**
+   * Filter to only plans matching these visibility states.
+   */
+  visibilities?: Array<Shared.VisibilityFilter> | null;
+}
+
 export interface PlanCreateParams {
   /**
    * The unique identifier of the company to create this plan for.
@@ -374,6 +453,11 @@ export interface PlanCreateParams {
    */
   product_id: string;
 
+  /**
+   * Whether this plan accepts local currency payments via adaptive pricing.
+   */
+  adaptive_pricing_enabled?: boolean | null;
+
   /**
    * The number of days between recurring charges. For example, 30 for monthly or 365
    * for yearly.
@@ -429,6 +513,13 @@ export interface PlanCreateParams {
    */
   legacy_payment_method_controls?: boolean | null;
 
+  /**
+   * Custom key-value pairs to store on the plan. Included in webhook payloads for
+   * payment and membership events. Max 50 keys, 500 chars per key, 5000 chars per
+   * value.
+   */
+  metadata?: { [key: string]: unknown } | null;
+
   /**
    * Whether or not the tax is included in a plan's price (or if it hasn't been set
    * up)
@@ -468,6 +559,11 @@ export interface PlanCreateParams {
    */
   stock?: number | null;
 
+  /**
+   * 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.
    */
@@ -496,6 +592,12 @@ export namespace PlanCreateParams {
    * default.
    */
   export interface CheckoutStyling {
+    /**
+     * A hex color code for the checkout page background, applied to the order summary
+     * panel (e.g. #F4F4F5).
+     */
+    background_color?: string | null;
+
     /**
      * The different border-radius styles available for checkout pages.
      */
@@ -578,11 +680,16 @@ export namespace PlanCreateParams {
      * in this configuration. The full list of default payment methods can be found in
      * the documentation at docs.whop.com/payments.
      */
-    include_platform_defaults: boolean;
+    include_platform_defaults?: boolean | null;
   }
 }
 
 export interface PlanUpdateParams {
+  /**
+   * Whether this plan accepts local currency payments via adaptive pricing.
+   */
+  adaptive_pricing_enabled?: boolean | null;
+
   /**
    * The number of days between recurring charges. For example, 30 for monthly or 365
    * for yearly.
@@ -637,6 +744,13 @@ export interface PlanUpdateParams {
    */
   legacy_payment_method_controls?: boolean | null;
 
+  /**
+   * Custom key-value pairs to store on the plan. Included in webhook payloads for
+   * payment and membership events. Max 50 keys, 500 chars per key, 5000 chars per
+   * value.
+   */
+  metadata?: { [key: string]: unknown } | null;
+
   /**
    * Whether to offer a retention discount when a customer attempts to cancel.
    */
@@ -678,6 +792,11 @@ export interface PlanUpdateParams {
    */
   strike_through_renewal_price?: number | null;
 
+  /**
+   * 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.
    */
@@ -705,6 +824,12 @@ export namespace PlanUpdateParams {
    * inherit from the company default.
    */
   export interface CheckoutStyling {
+    /**
+     * A hex color code for the checkout page background, applied to the order summary
+     * panel (e.g. #F4F4F5).
+     */
+    background_color?: string | null;
+
     /**
      * The different border-radius styles available for checkout pages.
      */
@@ -787,72 +912,10 @@ export namespace PlanUpdateParams {
      * in this configuration. The full list of default payment methods can be found in
      * the documentation at docs.whop.com/payments.
      */
-    include_platform_defaults: boolean;
+    include_platform_defaults?: boolean | null;
   }
 }
 
-export interface PlanListParams extends CursorPageParams {
-  /**
-   * The unique identifier of the company to list plans for.
-   */
-  company_id: string;
-
-  /**
-   * Returns the elements in the list that come before the specified cursor.
-   */
-  before?: string | null;
-
-  /**
-   * Only return plans created after this timestamp.
-   */
-  created_after?: string | null;
-
-  /**
-   * Only return plans created before this timestamp.
-   */
-  created_before?: string | null;
-
-  /**
-   * The direction of the sort.
-   */
-  direction?: Shared.Direction | null;
-
-  /**
-   * Returns the first _n_ elements from the list.
-   */
-  first?: number | null;
-
-  /**
-   * Returns the last _n_ elements from the list.
-   */
-  last?: number | null;
-
-  /**
-   * The ways a relation of Plans can be ordered
-   */
-  order?: 'id' | 'active_members_count' | 'created_at' | 'internal_notes' | 'expires_at' | null;
-
-  /**
-   * Filter to only plans matching these billing types.
-   */
-  plan_types?: Array<Shared.PlanType> | null;
-
-  /**
-   * Filter to only plans belonging to these product identifiers.
-   */
-  product_ids?: Array<string> | null;
-
-  /**
-   * Filter to only plans matching these release methods.
-   */
-  release_methods?: Array<Shared.ReleaseMethod> | null;
-
-  /**
-   * Filter to only plans matching these visibility states.
-   */
-  visibilities?: Array<Shared.VisibilityFilter> | null;
-}
-
 export declare namespace Plans {
   export {
     type CheckoutFont as CheckoutFont,
@@ -860,8 +923,8 @@ export declare namespace Plans {
     type PlanListResponse as PlanListResponse,
     type PlanDeleteResponse as PlanDeleteResponse,
     type PlanListResponsesCursorPage as PlanListResponsesCursorPage,
+    type PlanListParams as PlanListParams,
     type PlanCreateParams as PlanCreateParams,
     type PlanUpdateParams as PlanUpdateParams,
-    type PlanListParams as PlanListParams,
   };
 }

package/src/resources/products.ts

@@ -13,24 +13,28 @@ import { path } from '../internal/utils/path';
  */
 export class Products extends APIResource {
   /**
-   * Create a new product for a company. The product serves as the top-level
-   * container for plans and experiences.
+   * Returns a paginated list of products belonging to a company, with optional
+   * filtering by type, visibility, and creation date.
    *
    * Required permissions:
    *
-   * - `access_pass:create`
    * - `access_pass:basic:read`
    *
    * @example
    * ```ts
-   * const product = await client.products.create({
+   * // Automatically fetches more pages as needed.
+   * for await (const productListItem of client.products.list({
    *   company_id: 'biz_xxxxxxxxxxxxxx',
-   *   title: 'title',
-   * });
+   * })) {
+   *   // ...
+   * }
    * ```
    */
-  create(body: ProductCreateParams, options?: RequestOptions): APIPromise<Shared.Product> {
-    return this._client.post('/products', { body, ...options });
+  list(
+    query: ProductListParams,
+    options?: RequestOptions,
+  ): PagePromise<ProductListItemsCursorPage, Shared.ProductListItem> {
+    return this._client.getAPIList('/products', CursorPage<Shared.ProductListItem>, { query, ...options });
   }
 
   /**
@@ -52,51 +56,47 @@ export class Products extends APIResource {
   }
 
   /**
-   * Update a product's title, description, visibility, and other settings.
+   * Create a new product for a company. The product serves as the top-level
+   * container for plans and experiences.
    *
    * Required permissions:
    *
-   * - `access_pass:update`
+   * - `access_pass:create`
    * - `access_pass:basic:read`
    *
    * @example
    * ```ts
-   * const product = await client.products.update(
-   *   'prod_xxxxxxxxxxxxx',
-   * );
+   * const product = await client.products.create({
+   *   company_id: 'biz_xxxxxxxxxxxxxx',
+   *   title: 'title',
+   * });
    * ```
    */
-  update(
-    id: string,
-    body: ProductUpdateParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<Shared.Product> {
-    return this._client.patch(path`/products/${id}`, { body, ...options });
+  create(body: ProductCreateParams, options?: RequestOptions): APIPromise<Shared.Product> {
+    return this._client.post('/products', { body, ...options });
   }
 
   /**
-   * Returns a paginated list of products belonging to a company, with optional
-   * filtering by type, visibility, and creation date.
+   * Update a product's title, description, visibility, and other settings.
    *
    * Required permissions:
    *
+   * - `access_pass:update`
    * - `access_pass:basic:read`
    *
    * @example
    * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const productListItem of client.products.list({
-   *   company_id: 'biz_xxxxxxxxxxxxxx',
-   * })) {
-   *   // ...
-   * }
+   * const product = await client.products.update(
+   *   'prod_xxxxxxxxxxxxx',
+   * );
    * ```
    */
-  list(
-    query: ProductListParams,
+  update(
+    id: string,
+    body: ProductUpdateParams | null | undefined = {},
     options?: RequestOptions,
-  ): PagePromise<ProductListItemsCursorPage, Shared.ProductListItem> {
-    return this._client.getAPIList('/products', CursorPage<Shared.ProductListItem>, { query, ...options });
+  ): APIPromise<Shared.Product> {
+    return this._client.patch(path`/products/${id}`, { body, ...options });
   }
 
   /**
@@ -123,6 +123,58 @@ export class Products extends APIResource {
  */
 export type ProductDeleteResponse = boolean;
 
+export interface ProductListParams extends CursorPageParams {
+  /**
+   * The unique identifier of the company to list products for.
+   */
+  company_id: string;
+
+  /**
+   * Returns the elements in the list that come before the specified cursor.
+   */
+  before?: string | null;
+
+  /**
+   * Only return products created after this timestamp.
+   */
+  created_after?: string | null;
+
+  /**
+   * Only return products created before this timestamp.
+   */
+  created_before?: string | null;
+
+  /**
+   * The direction of the sort.
+   */
+  direction?: Shared.Direction | null;
+
+  /**
+   * Returns the first _n_ elements from the list.
+   */
+  first?: number | null;
+
+  /**
+   * Returns the last _n_ elements from the list.
+   */
+  last?: number | null;
+
+  /**
+   * The ways a relation of AccessPasses can be ordered
+   */
+  order?: 'active_memberships_count' | 'created_at' | 'usd_gmv' | 'usd_gmv_30_days' | null;
+
+  /**
+   * Filter to only products matching these type classifications.
+   */
+  product_types?: Array<Shared.AccessPassType> | null;
+
+  /**
+   * Filter to only products matching these visibility states.
+   */
+  visibilities?: Array<Shared.VisibilityFilter> | null;
+}
+
 export interface ProductCreateParams {
   /**
    * The unique identifier of the company to create this product for.
@@ -194,6 +246,13 @@ export interface ProductCreateParams {
    */
   member_affiliate_status?: Shared.GlobalAffiliateStatus | null;
 
+  /**
+   * Custom key-value pairs to store on the product. Included in webhook payloads for
+   * payment and membership events. Max 50 keys, 500 chars per key, 5000 chars per
+   * value.
+   */
+  metadata?: { [key: string]: unknown } | null;
+
   /**
    * Configuration for an automatically generated plan to attach to this product.
    */
@@ -370,6 +429,13 @@ export interface ProductUpdateParams {
    */
   member_affiliate_status?: Shared.GlobalAffiliateStatus | null;
 
+  /**
+   * Custom key-value pairs to store on the product. Included in webhook payloads for
+   * payment and membership events. Max 50 keys, 500 chars per key, 5000 chars per
+   * value.
+   */
+  metadata?: { [key: string]: unknown } | null;
+
   /**
    * The unique identifier of the tax classification code to apply to this product.
    */
@@ -434,64 +500,12 @@ export namespace ProductUpdateParams {
   }
 }
 
-export interface ProductListParams extends CursorPageParams {
-  /**
-   * The unique identifier of the company to list products for.
-   */
-  company_id: string;
-
-  /**
-   * Returns the elements in the list that come before the specified cursor.
-   */
-  before?: string | null;
-
-  /**
-   * Only return products created after this timestamp.
-   */
-  created_after?: string | null;
-
-  /**
-   * Only return products created before this timestamp.
-   */
-  created_before?: string | null;
-
-  /**
-   * The direction of the sort.
-   */
-  direction?: Shared.Direction | null;
-
-  /**
-   * Returns the first _n_ elements from the list.
-   */
-  first?: number | null;
-
-  /**
-   * Returns the last _n_ elements from the list.
-   */
-  last?: number | null;
-
-  /**
-   * The ways a relation of AccessPasses can be ordered
-   */
-  order?: 'active_memberships_count' | 'created_at' | 'usd_gmv' | 'usd_gmv_30_days' | null;
-
-  /**
-   * Filter to only products matching these type classifications.
-   */
-  product_types?: Array<Shared.AccessPassType> | null;
-
-  /**
-   * Filter to only products matching these visibility states.
-   */
-  visibilities?: Array<Shared.VisibilityFilter> | null;
-}
-
 export declare namespace Products {
   export {
     type ProductDeleteResponse as ProductDeleteResponse,
+    type ProductListParams as ProductListParams,
     type ProductCreateParams as ProductCreateParams,
     type ProductUpdateParams as ProductUpdateParams,
-    type ProductListParams as ProductListParams,
   };
 }