@whop/sdk 0.0.30 → 0.0.32

package/src/resources/invoices.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 PaymentsAPI from './payments';
 import * as Shared from './shared';
 import { InvoiceListItemsCursorPage } from './shared';
 import { APIPromise } from '../core/api-promise';
@@ -8,6 +9,9 @@ import { CursorPage, type CursorPageParams, PagePromise } from '../core/paginati
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Invoices
+ */
 export class Invoices extends APIResource {
   /**
    * Create an invoice for a customer. The invoice can be charged automatically using
@@ -16,7 +20,6 @@ export class Invoices extends APIResource {
    * Required permissions:
    *
    * - `invoice:create`
-   * - `plan:basic:read`
    *
    * @example
    * ```ts
@@ -40,7 +43,6 @@ export class Invoices extends APIResource {
    * Required permissions:
    *
    * - `invoice:basic:read`
-   * - `plan:basic:read`
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<Shared.Invoice> {
     return this._client.get(path`/invoices/${id}`, options);
@@ -53,10 +55,9 @@ export class Invoices extends APIResource {
    * Required permissions:
    *
    * - `invoice:basic:read`
-   * - `plan:basic:read`
    */
   list(
-    query: InvoiceListParams,
+    query: InvoiceListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<InvoiceListItemsCursorPage, Shared.InvoiceListItem> {
     return this._client.getAPIList('/invoices', CursorPage<Shared.InvoiceListItem>, { query, ...options });
@@ -192,6 +193,17 @@ export declare namespace InvoiceCreateParams {
        */
       internal_notes?: string | null;
 
+      /**
+       * Whether this plan uses legacy payment method controls
+       */
+      legacy_payment_method_controls?: boolean | null;
+
+      /**
+       * The explicit payment method configuration for the plan. If not provided, the
+       * platform or company's defaults will apply.
+       */
+      payment_method_configuration?: Plan.PaymentMethodConfiguration | null;
+
       /**
        * The type of plan that can be attached to a product
        */
@@ -262,6 +274,33 @@ export declare namespace InvoiceCreateParams {
          */
         required?: boolean | null;
       }
+
+      /**
+       * The explicit payment method configuration for the plan. If not provided, the
+       * platform or company's defaults will apply.
+       */
+      export interface PaymentMethodConfiguration {
+        /**
+         * An array of payment method identifiers that are explicitly disabled. Only
+         * applies if the include_platform_defaults is true.
+         */
+        disabled: Array<PaymentsAPI.PaymentMethodTypes>;
+
+        /**
+         * An array of payment method identifiers that are explicitly enabled. This means
+         * these payment methods will be shown on checkout. Example use case is to only
+         * enable a specific payment method like cashapp, or extending the platform
+         * defaults with additional methods.
+         */
+        enabled: Array<PaymentsAPI.PaymentMethodTypes>;
+
+        /**
+         * Whether Whop's platform default payment method enablement settings are included
+         * 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;
+      }
     }
 
     /**
@@ -386,6 +425,17 @@ export declare namespace InvoiceCreateParams {
        */
       internal_notes?: string | null;
 
+      /**
+       * Whether this plan uses legacy payment method controls
+       */
+      legacy_payment_method_controls?: boolean | null;
+
+      /**
+       * The explicit payment method configuration for the plan. If not provided, the
+       * platform or company's defaults will apply.
+       */
+      payment_method_configuration?: Plan.PaymentMethodConfiguration | null;
+
       /**
        * The type of plan that can be attached to a product
        */
@@ -456,6 +506,33 @@ export declare namespace InvoiceCreateParams {
          */
         required?: boolean | null;
       }
+
+      /**
+       * The explicit payment method configuration for the plan. If not provided, the
+       * platform or company's defaults will apply.
+       */
+      export interface PaymentMethodConfiguration {
+        /**
+         * An array of payment method identifiers that are explicitly disabled. Only
+         * applies if the include_platform_defaults is true.
+         */
+        disabled: Array<PaymentsAPI.PaymentMethodTypes>;
+
+        /**
+         * An array of payment method identifiers that are explicitly enabled. This means
+         * these payment methods will be shown on checkout. Example use case is to only
+         * enable a specific payment method like cashapp, or extending the platform
+         * defaults with additional methods.
+         */
+        enabled: Array<PaymentsAPI.PaymentMethodTypes>;
+
+        /**
+         * Whether Whop's platform default payment method enablement settings are included
+         * 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;
+      }
     }
 
     /**
@@ -579,6 +656,17 @@ export declare namespace InvoiceCreateParams {
        */
       internal_notes?: string | null;
 
+      /**
+       * Whether this plan uses legacy payment method controls
+       */
+      legacy_payment_method_controls?: boolean | null;
+
+      /**
+       * The explicit payment method configuration for the plan. If not provided, the
+       * platform or company's defaults will apply.
+       */
+      payment_method_configuration?: Plan.PaymentMethodConfiguration | null;
+
       /**
        * The type of plan that can be attached to a product
        */
@@ -649,6 +737,33 @@ export declare namespace InvoiceCreateParams {
          */
         required?: boolean | null;
       }
+
+      /**
+       * The explicit payment method configuration for the plan. If not provided, the
+       * platform or company's defaults will apply.
+       */
+      export interface PaymentMethodConfiguration {
+        /**
+         * An array of payment method identifiers that are explicitly disabled. Only
+         * applies if the include_platform_defaults is true.
+         */
+        disabled: Array<PaymentsAPI.PaymentMethodTypes>;
+
+        /**
+         * An array of payment method identifiers that are explicitly enabled. This means
+         * these payment methods will be shown on checkout. Example use case is to only
+         * enable a specific payment method like cashapp, or extending the platform
+         * defaults with additional methods.
+         */
+        enabled: Array<PaymentsAPI.PaymentMethodTypes>;
+
+        /**
+         * Whether Whop's platform default payment method enablement settings are included
+         * 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;
+      }
     }
   }
 
@@ -756,6 +871,17 @@ export declare namespace InvoiceCreateParams {
        */
       internal_notes?: string | null;
 
+      /**
+       * Whether this plan uses legacy payment method controls
+       */
+      legacy_payment_method_controls?: boolean | null;
+
+      /**
+       * The explicit payment method configuration for the plan. If not provided, the
+       * platform or company's defaults will apply.
+       */
+      payment_method_configuration?: Plan.PaymentMethodConfiguration | null;
+
       /**
        * The type of plan that can be attached to a product
        */
@@ -826,16 +952,38 @@ export declare namespace InvoiceCreateParams {
          */
         required?: boolean | null;
       }
+
+      /**
+       * The explicit payment method configuration for the plan. If not provided, the
+       * platform or company's defaults will apply.
+       */
+      export interface PaymentMethodConfiguration {
+        /**
+         * An array of payment method identifiers that are explicitly disabled. Only
+         * applies if the include_platform_defaults is true.
+         */
+        disabled: Array<PaymentsAPI.PaymentMethodTypes>;
+
+        /**
+         * An array of payment method identifiers that are explicitly enabled. This means
+         * these payment methods will be shown on checkout. Example use case is to only
+         * enable a specific payment method like cashapp, or extending the platform
+         * defaults with additional methods.
+         */
+        enabled: Array<PaymentsAPI.PaymentMethodTypes>;
+
+        /**
+         * Whether Whop's platform default payment method enablement settings are included
+         * 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;
+      }
     }
   }
 }
 
 export interface InvoiceListParams extends CursorPageParams {
-  /**
-   * The unique identifier of the company to list invoices for.
-   */
-  company_id: string;
-
   /**
    * Returns the elements in the list that come before the specified cursor.
    */
@@ -846,6 +994,11 @@ export interface InvoiceListParams extends CursorPageParams {
    */
   collection_methods?: Array<Shared.CollectionMethod> | null;
 
+  /**
+   * The unique identifier of the company to list invoices for.
+   */
+  company_id?: string | null;
+
   /**
    * Only return invoices created after this timestamp.
    */

package/src/resources/leads.ts

@@ -6,6 +6,9 @@ import { CursorPage, type CursorPageParams, PagePromise } from '../core/paginati
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Leads
+ */
 export class Leads extends APIResource {
   /**
    * Record a new lead for a company, capturing a potential customer's interest in a

package/src/resources/ledger-accounts.ts

@@ -7,6 +7,9 @@ import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Ledger accounts
+ */
 export class LedgerAccounts extends APIResource {
   /**
    * Retrieves the details of an existing ledger account.

package/src/resources/members.ts

@@ -7,6 +7,9 @@ import { CursorPage, type CursorPageParams, PagePromise } from '../core/paginati
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Members
+ */
 export class Members extends APIResource {
   /**
    * Retrieves the details of an existing member.

package/src/resources/memberships.ts

@@ -7,6 +7,9 @@ import { CursorPage, type CursorPageParams, PagePromise } from '../core/paginati
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Memberships
+ */
 export class Memberships extends APIResource {
   /**
    * Retrieves the details of an existing membership.
@@ -15,6 +18,13 @@ export class Memberships extends APIResource {
    *
    * - `member:basic:read`
    * - `member:email:read`
+   *
+   * @example
+   * ```ts
+   * const membership = await client.memberships.retrieve(
+   *   'mem_xxxxxxxxxxxxxx',
+   * );
+   * ```
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<Shared.Membership> {
     return this._client.get(path`/memberships/${id}`, options);
@@ -28,6 +38,13 @@ export class Memberships extends APIResource {
    * - `member:manage`
    * - `member:email:read`
    * - `member:basic:read`
+   *
+   * @example
+   * ```ts
+   * const membership = await client.memberships.update(
+   *   'mem_xxxxxxxxxxxxxx',
+   * );
+   * ```
    */
   update(
     id: string,
@@ -45,6 +62,14 @@ export class Memberships extends APIResource {
    *
    * - `member:basic:read`
    * - `member:email:read`
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const membershipListResponse of client.memberships.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query: MembershipListParams | null | undefined = {},
@@ -53,15 +78,48 @@ export class Memberships extends APIResource {
     return this._client.getAPIList('/memberships', CursorPage<MembershipListResponse>, { query, ...options });
   }
 
+  /**
+   * Add free days to extend a membership's current billing period, expiration date,
+   * or Stripe trial.
+   *
+   * Required permissions:
+   *
+   * - `member:manage`
+   * - `member:email:read`
+   * - `member:basic:read`
+   *
+   * @example
+   * ```ts
+   * const membership = await client.memberships.addFreeDays(
+   *   'mem_xxxxxxxxxxxxxx',
+   *   { free_days: 42 },
+   * );
+   * ```
+   */
+  addFreeDays(
+    id: string,
+    body: MembershipAddFreeDaysParams,
+    options?: RequestOptions,
+  ): APIPromise<Shared.Membership> {
+    return this._client.post(path`/memberships/${id}/add_free_days`, { body, ...options });
+  }
+
   /**
    * Cancel a membership either immediately or at the end of the current billing
    * period. Immediate cancellation revokes access right away.
    *
    * Required permissions:
    *
-   * - `member:manage`
+   * - `membership:cancel`
    * - `member:email:read`
    * - `member:basic:read`
+   *
+   * @example
+   * ```ts
+   * const membership = await client.memberships.cancel(
+   *   'mem_xxxxxxxxxxxxxx',
+   * );
+   * ```
    */
   cancel(
     id: string,
@@ -80,6 +138,13 @@ export class Memberships extends APIResource {
    * - `member:manage`
    * - `member:email:read`
    * - `member:basic:read`
+   *
+   * @example
+   * ```ts
+   * const membership = await client.memberships.pause(
+   *   'mem_xxxxxxxxxxxxxx',
+   * );
+   * ```
    */
   pause(
     id: string,
@@ -98,6 +163,13 @@ export class Memberships extends APIResource {
    * - `member:manage`
    * - `member:email:read`
    * - `member:basic:read`
+   *
+   * @example
+   * ```ts
+   * const membership = await client.memberships.resume(
+   *   'mem_xxxxxxxxxxxxxx',
+   * );
+   * ```
    */
   resume(id: string, options?: RequestOptions): APIPromise<Shared.Membership> {
     return this._client.post(path`/memberships/${id}/resume`, options);
@@ -112,6 +184,13 @@ export class Memberships extends APIResource {
    * - `member:manage`
    * - `member:email:read`
    * - `member:basic:read`
+   *
+   * @example
+   * ```ts
+   * const membership = await client.memberships.uncancel(
+   *   'mem_xxxxxxxxxxxxxx',
+   * );
+   * ```
    */
   uncancel(id: string, options?: RequestOptions): APIPromise<Shared.Membership> {
     return this._client.post(path`/memberships/${id}/uncancel`, options);
@@ -435,6 +514,14 @@ export interface MembershipListParams extends CursorPageParams {
   user_ids?: Array<string> | null;
 }
 
+export interface MembershipAddFreeDaysParams {
+  /**
+   * The number of free days to add (1-1095). Extends the billing period, expiration
+   * date, or Stripe trial depending on plan type.
+   */
+  free_days: number;
+}
+
 export interface MembershipCancelParams {
   /**
    * The mode of cancellation for a membership
@@ -457,6 +544,7 @@ export declare namespace Memberships {
     type MembershipListResponsesCursorPage as MembershipListResponsesCursorPage,
     type MembershipUpdateParams as MembershipUpdateParams,
     type MembershipListParams as MembershipListParams,
+    type MembershipAddFreeDaysParams as MembershipAddFreeDaysParams,
     type MembershipCancelParams as MembershipCancelParams,
     type MembershipPauseParams as MembershipPauseParams,
   };

package/src/resources/messages.ts

@@ -7,6 +7,9 @@ import { CursorPage, type CursorPageParams, PagePromise } from '../core/paginati
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Messages
+ */
 export class Messages extends APIResource {
   /**
    * Send a new message in an experience chat, DM, or group chat channel. Supports
@@ -107,6 +110,17 @@ export interface MessageListResponse {
    */
   is_pinned: boolean;
 
+  /**
+   * A list of user IDs that are explicitly mentioned in this message.
+   */
+  mentions: Array<string>;
+
+  /**
+   * Whether the message includes an @everyone mention that notifies all channel
+   * members.
+   */
+  mentions_everyone: boolean;
+
   /**
    * The classification of this message: regular, system, or automated.
    */

package/src/resources/notifications.ts

@@ -4,6 +4,9 @@ import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Notifications
+ */
 export class Notifications extends APIResource {
   /**
    * Send a push notification to users in an experience or company team. The

package/src/resources/payment-methods.ts

@@ -8,6 +8,9 @@ import { CursorPage, type CursorPageParams, PagePromise } from '../core/paginati
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Payment methods
+ */
 export class PaymentMethods extends APIResource {
   /**
    * Retrieves the details of an existing payment method.

package/src/resources/payments.ts

@@ -8,6 +8,9 @@ import { CursorPage, type CursorPageParams, PagePromise } from '../core/paginati
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Payments
+ */
 export class Payments extends APIResource {
   /**
    * Charge an existing member off-session using one of their stored payment methods.
@@ -297,6 +300,7 @@ export type PaymentMethodTypes =
   | 'cashapp'
   | 'claritypay'
   | 'coinbase'
+  | 'coinflow'
   | 'crypto'
   | 'custom'
   | 'customer_balance'
@@ -368,6 +372,12 @@ export type PaymentMethodTypes =
   | 'zip'
   | 'unknown';
 
+/**
+ * The type of tax inclusivity applied to the receipt, for determining whether the
+ * tax is included in the final price, or paid on top.
+ */
+export type ReceiptTaxBehavior = 'exclusive' | 'inclusive' | 'unspecified' | 'unable_to_collect';
+
 /**
  * A payment represents a completed or attempted charge. Payments track the amount,
  * status, currency, and payment method used.
@@ -540,6 +550,17 @@ export interface PaymentListResponse {
    */
   subtotal: number | null;
 
+  /**
+   * The calculated amount of the sales/VAT tax (if applicable).
+   */
+  tax_amount: number | null;
+
+  /**
+   * The type of tax inclusivity applied to the receipt, for determining whether the
+   * tax is included in the final price, or paid on top.
+   */
+  tax_behavior: ReceiptTaxBehavior | null;
+
   /**
    * The total to show to the creator (excluding buyer fees).
    */
@@ -1225,6 +1246,7 @@ export declare namespace Payments {
     type BillingReasons as BillingReasons,
     type CardBrands as CardBrands,
     type PaymentMethodTypes as PaymentMethodTypes,
+    type ReceiptTaxBehavior as ReceiptTaxBehavior,
     type PaymentListResponse as PaymentListResponse,
     type PaymentListFeesResponse as PaymentListFeesResponse,
     type PaymentListResponsesCursorPage as PaymentListResponsesCursorPage,

package/src/resources/payout-methods.ts

@@ -7,6 +7,9 @@ import { CursorPage, type CursorPageParams, PagePromise } from '../core/paginati
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Payout methods
+ */
 export class PayoutMethods extends APIResource {
   /**
    * Retrieves the details of an existing payout method.

package/src/resources/plans.ts

@@ -8,6 +8,9 @@ import { CursorPage, type CursorPageParams, PagePromise } from '../core/paginati
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Plans
+ */
 export class Plans extends APIResource {
   /**
    * Create a new pricing plan for a product. The plan defines the billing interval,

package/src/resources/products.ts

@@ -8,6 +8,9 @@ import { CursorPage, type CursorPageParams, PagePromise } from '../core/paginati
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Products
+ */
 export class Products extends APIResource {
   /**
    * Create a new product for a company. The product serves as the top-level
@@ -211,6 +214,12 @@ export interface ProductCreateParams {
    */
   route?: string | null;
 
+  /**
+   * Whether to send an automated welcome message via support chat when a user joins
+   * this product. Defaults to true.
+   */
+  send_welcome_message?: boolean | null;
+
   /**
    * Visibility of a resource
    */
@@ -376,6 +385,12 @@ export interface ProductUpdateParams {
    */
   route?: string | null;
 
+  /**
+   * Whether to send an automated welcome message via support chat when a user joins
+   * this product.
+   */
+  send_welcome_message?: boolean | null;
+
   /**
    * Layout and display configuration for this product on the company's store page.
    */

package/src/resources/promo-codes.ts

@@ -7,6 +7,9 @@ import { CursorPage, type CursorPageParams, PagePromise } from '../core/paginati
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Promo codes
+ */
 export class PromoCodes extends APIResource {
   /**
    * Create a new promo code that applies a discount at checkout. Can be scoped to

package/src/resources/reactions.ts

@@ -7,6 +7,9 @@ import { CursorPage, type CursorPageParams, PagePromise } from '../core/paginati
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Reactions
+ */
 export class Reactions extends APIResource {
   /**
    * Add an emoji reaction or poll vote to a message or forum post. In forums, the