@whop/sdk 0.0.25 → 0.0.27

package/src/resources/checkout-configurations.ts

@@ -73,14 +73,13 @@ export type CheckoutConfigurationListResponsesCursorPage = CursorPage<CheckoutCo
 export type CheckoutModes = 'payment' | 'setup';
 
 /**
- * A checkout configuration object.
- *         Can be used to create a reusable custom configuration for a checkout, including attaching plans, affiliates and custom metadata to the checkout.
- *         This configuration can be re-used by multiple users.
- *         All successful payments and memberships resulting from a checkout will contain the passed metadata.
+ * A checkout session is a reusable configuration for a checkout, including the
+ * plan, affiliate, and custom metadata. Payments and memberships created from a
+ * checkout session inherit its metadata.
  */
 export interface CheckoutConfigurationListResponse {
   /**
-   * The ID of the checkout configuration
+   * The unique identifier for the checkout session.
    */
   id: string;
 
@@ -167,12 +166,12 @@ export namespace CheckoutConfigurationListResponse {
    */
   export interface Plan {
     /**
-     * The internal ID of the plan.
+     * The unique identifier for the plan.
      */
     id: string;
 
     /**
-     * The interval at which the plan charges (renewal plans).
+     * The interval in days at which the plan charges (renewal plans).
      */
     billing_period: number | null;
 
@@ -182,12 +181,15 @@ export namespace CheckoutConfigurationListResponse {
     currency: Shared.Currency;
 
     /**
-     * The interval at which the plan charges (expiration plans).
+     * The number of days until the membership expires (for expiration-based plans).
+     * For example, 365 for a one-year access pass.
      */
     expiration_days: number | null;
 
     /**
-     * The price a person has to pay for a plan on the initial purchase.
+     * The initial purchase price in the plan's base_currency (e.g., 49.99 for $49.99).
+     * For one-time plans, this is the full price. For renewal plans, this is charged
+     * on top of the first renewal_price.
      */
     initial_price: number;
 
@@ -202,7 +204,8 @@ export namespace CheckoutConfigurationListResponse {
     release_method: Shared.ReleaseMethod;
 
     /**
-     * The price a person has to pay for a plan on the renewal purchase.
+     * The recurring price charged every billing_period in the plan's base_currency
+     * (e.g., 9.99 for $9.99/period). Zero for one-time plans.
      */
     renewal_price: number;
 
@@ -282,13 +285,15 @@ export declare namespace CheckoutConfigurationCreateParams {
 
       /**
        * The application fee amount collected by the platform from this connected
-       * account. Must be less than the total payment amount. Only valid for connected
-       * accounts with a parent company.
+       * account. Provided as a number in dollars (e.g., 5.00 for $5.00). Must be less
+       * than the total payment amount. Only valid for connected accounts with a parent
+       * company.
        */
       application_fee_amount?: number | null;
 
       /**
-       * The interval at which the plan charges (renewal plans).
+       * The interval in days at which the plan charges (renewal plans). For example, 30
+       * for monthly billing.
        */
       billing_period?: number | null;
 
@@ -303,7 +308,8 @@ export declare namespace CheckoutConfigurationCreateParams {
       description?: string | null;
 
       /**
-       * The interval at which the plan charges (expiration plans).
+       * The number of days until the membership expires (for expiration-based plans).
+       * For example, 365 for a one-year access pass.
        */
       expiration_days?: number | null;
 
@@ -319,7 +325,8 @@ export declare namespace CheckoutConfigurationCreateParams {
       image?: Plan.Image | null;
 
       /**
-       * An additional amount charged upon first purchase.
+       * An additional amount charged upon first purchase. Provided as a number in
+       * dollars (e.g., 10.00 for $10.00).
        */
       initial_price?: number | null;
 
@@ -362,7 +369,8 @@ export declare namespace CheckoutConfigurationCreateParams {
       release_method?: Shared.ReleaseMethod | null;
 
       /**
-       * The amount the customer is charged every billing period.
+       * The amount the customer is charged every billing period. Provided as a number in
+       * dollars (e.g., 9.99 for $9.99/period).
        */
       renewal_price?: number | null;
 

package/src/resources/companies.ts

@@ -9,11 +9,12 @@ import { path } from '../internal/utils/path';
 
 export class Companies extends APIResource {
   /**
-   * Create a new connected account for your platform
+   * Create a new company. Pass parent_company_id to create a sub-company under a
+   * platform, or omit it to create a company for the current user.
    *
    * Required permissions:
    *
-   * - `company:create_child`
+   * - `company:create`
    * - `company:basic:read`
    */
   create(body: CompanyCreateParams, options?: RequestOptions): APIPromise<Shared.Company> {
@@ -49,14 +50,16 @@ export class Companies extends APIResource {
   }
 
   /**
-   * Lists companies the current user has access to
+   * Lists companies. When parent_company_id is provided, lists connected accounts
+   * under that company. When omitted, lists companies the current user has access
+   * to.
    *
    * Required permissions:
    *
    * - `company:basic:read`
    */
   list(
-    query: CompanyListParams,
+    query: CompanyListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<CompanyListResponsesCursorPage, CompanyListResponse> {
     return this._client.getAPIList('/companies', CursorPage<CompanyListResponse>, { query, ...options });
@@ -66,11 +69,12 @@ export class Companies extends APIResource {
 export type CompanyListResponsesCursorPage = CursorPage<CompanyListResponse>;
 
 /**
- * An object representing a (sanitized) company.
+ * A company is a seller on Whop. Companies own products, manage members, and
+ * receive payouts.
  */
 export interface CompanyListResponse {
   /**
-   * The ID (tag) of the company.
+   * The unique identifier for the company.
    */
   id: string;
 
@@ -80,7 +84,7 @@ export interface CompanyListResponse {
   business_type: Shared.BusinessTypes | null;
 
   /**
-   * When the company was created (signed up)
+   * The datetime the company was created.
    */
   created_at: string;
 
@@ -136,7 +140,7 @@ export interface CompanyListResponse {
   title: string;
 
   /**
-   * The time the company was last updated.
+   * The datetime the company was last updated.
    */
   updated_at: string;
 
@@ -163,7 +167,7 @@ export namespace CompanyListResponse {
    */
   export interface OwnerUser {
     /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     id: string;
 
@@ -181,24 +185,25 @@ export namespace CompanyListResponse {
 
 export interface CompanyCreateParams {
   /**
-   * The email of the user who the company will belong to.
+   * The name of the company being created.
    */
-  email: string;
+  title: string;
 
   /**
-   * The company ID of the platform creating this company.
+   * The different business types a company can be.
    */
-  parent_company_id: string;
+  business_type?: Shared.BusinessTypes | null;
 
   /**
-   * The name of the company being created.
+   * A description of what the company offers or does.
    */
-  title: string;
+  description?: string | null;
 
   /**
-   * The different business types a company can be.
+   * The email of the user who the sub-company will belong to. Required when
+   * parent_company_id is provided.
    */
-  business_type?: Shared.BusinessTypes | null;
+  email?: string | null;
 
   /**
    * The different industry types a company can be in.
@@ -211,15 +216,19 @@ export interface CompanyCreateParams {
   logo?: CompanyCreateParams.Logo | null;
 
   /**
-   * Additional metadata for the account
+   * Additional metadata for the company
    */
   metadata?: { [key: string]: unknown } | null;
 
+  /**
+   * The company ID of the platform creating this sub-company. If omitted, the
+   * company is created for the current user.
+   */
+  parent_company_id?: string | null;
+
   /**
    * Whether Whop sends transactional emails to customers on behalf of this company.
-   * Includes: order confirmations, payment failures, refund notifications, upcoming
-   * renewals, and membership cancelations/expirations. When disabled, the platform
-   * is responsible for handling these communications. This is defaulted to true.
+   * Only used when parent_company_id is provided.
    */
   send_customer_emails?: boolean | null;
 }
@@ -247,6 +256,11 @@ export interface CompanyUpdateParams {
    */
   business_type?: Shared.BusinessTypes | null;
 
+  /**
+   * A description of what the company offers or does.
+   */
+  description?: string | null;
+
   /**
    * The different industry types a company can be in.
    */
@@ -294,11 +308,6 @@ export namespace CompanyUpdateParams {
 }
 
 export interface CompanyListParams extends CursorPageParams {
-  /**
-   * The ID of the parent company to list connected accounts for
-   */
-  parent_company_id: string;
-
   /**
    * Returns the elements in the list that come before the specified cursor.
    */
@@ -328,6 +337,12 @@ export interface CompanyListParams extends CursorPageParams {
    * Returns the last _n_ elements from the list.
    */
   last?: number | null;
+
+  /**
+   * The ID of the parent company to list connected accounts for. Omit to list the
+   * current user's own companies.
+   */
+  parent_company_id?: string | null;
 }
 
 export declare namespace Companies {

package/src/resources/company-token-transactions.ts

@@ -31,7 +31,7 @@ export class CompanyTokenTransactions extends APIResource {
   create(
     body: CompanyTokenTransactionCreateParams,
     options?: RequestOptions,
-  ): APIPromise<CompanyTokenTransactionCreateResponse> {
+  ): APIPromise<CompanyTokenTransaction> {
     return this._client.post('/company_token_transactions', { body, ...options });
   }
 
@@ -44,7 +44,7 @@ export class CompanyTokenTransactions extends APIResource {
    * - `member:basic:read`
    * - `company:basic:read`
    */
-  retrieve(id: string, options?: RequestOptions): APIPromise<CompanyTokenTransactionRetrieveResponse> {
+  retrieve(id: string, options?: RequestOptions): APIPromise<CompanyTokenTransaction> {
     return this._client.get(path`/company_token_transactions/${id}`, options);
   }
 
@@ -72,118 +72,16 @@ export class CompanyTokenTransactions extends APIResource {
 export type CompanyTokenTransactionListResponsesCursorPage = CursorPage<CompanyTokenTransactionListResponse>;
 
 /**
- * A token transaction within a company
+ * The type of token transaction
  */
-export interface CompanyTokenTransactionCreateResponse {
-  /**
-   * The ID of the transaction
-   */
-  id: string;
-
-  /**
-   * The transaction amount (always positive)
-   */
-  amount: number;
-
-  /**
-   * The company
-   */
-  company: CompanyTokenTransactionCreateResponse.Company;
-
-  /**
-   * When the transaction was created
-   */
-  created_at: string;
-
-  /**
-   * Optional description
-   */
-  description: string | null;
-
-  /**
-   * Optional idempotency key to prevent duplicate transactions
-   */
-  idempotency_key: string | null;
-
-  /**
-   * For transfers, the ID of the linked transaction
-   */
-  linked_transaction_id: string | null;
-
-  /**
-   * The member
-   */
-  member: CompanyTokenTransactionCreateResponse.Member;
-
-  /**
-   * The type of transaction
-   */
-  transaction_type: 'add' | 'subtract' | 'transfer';
-
-  /**
-   * The user whose balance changed
-   */
-  user: CompanyTokenTransactionCreateResponse.User;
-}
-
-export namespace CompanyTokenTransactionCreateResponse {
-  /**
-   * The company
-   */
-  export interface Company {
-    /**
-     * The ID of the company
-     */
-    id: string;
-
-    /**
-     * The slug/route of the company on the Whop site.
-     */
-    route: string;
-
-    /**
-     * The written name of the company.
-     */
-    title: string;
-  }
-
-  /**
-   * The member
-   */
-  export interface Member {
-    /**
-     * The ID of the member
-     */
-    id: string;
-  }
-
-  /**
-   * The user whose balance changed
-   */
-  export interface User {
-    /**
-     * The internal ID of the user.
-     */
-    id: string;
-
-    /**
-     * The name of the user from their Whop account.
-     */
-    name: string | null;
-
-    /**
-     * The username of the user from their Whop account.
-     */
-    username: string;
-  }
-}
+export type BotTokenTransactionTypes = 'add' | 'subtract' | 'transfer';
 
 /**
  * A token transaction within a company
  */
-export interface CompanyTokenTransactionRetrieveResponse {
+export interface CompanyTokenTransaction {
   /**
-   * The ID of the transaction
+   * The unique identifier for the company token transaction.
    */
   id: string;
 
@@ -195,10 +93,10 @@ export interface CompanyTokenTransactionRetrieveResponse {
   /**
    * The company
    */
-  company: CompanyTokenTransactionRetrieveResponse.Company;
+  company: CompanyTokenTransaction.Company;
 
   /**
-   * When the transaction was created
+   * The datetime the company token transaction was created.
    */
   created_at: string;
 
@@ -220,26 +118,26 @@ export interface CompanyTokenTransactionRetrieveResponse {
   /**
    * The member
    */
-  member: CompanyTokenTransactionRetrieveResponse.Member;
+  member: CompanyTokenTransaction.Member;
 
   /**
    * The type of transaction
    */
-  transaction_type: 'add' | 'subtract' | 'transfer';
+  transaction_type: BotTokenTransactionTypes;
 
   /**
    * The user whose balance changed
    */
-  user: CompanyTokenTransactionRetrieveResponse.User;
+  user: CompanyTokenTransaction.User;
 }
 
-export namespace CompanyTokenTransactionRetrieveResponse {
+export namespace CompanyTokenTransaction {
   /**
    * The company
    */
   export interface Company {
     /**
-     * The ID of the company
+     * The unique identifier for the company.
      */
     id: string;
 
@@ -259,7 +157,7 @@ export namespace CompanyTokenTransactionRetrieveResponse {
    */
   export interface Member {
     /**
-     * The ID of the member
+     * The unique identifier for the company member.
      */
     id: string;
   }
@@ -269,7 +167,7 @@ export namespace CompanyTokenTransactionRetrieveResponse {
    */
   export interface User {
     /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     id: string;
 
@@ -290,7 +188,7 @@ export namespace CompanyTokenTransactionRetrieveResponse {
  */
 export interface CompanyTokenTransactionListResponse {
   /**
-   * The ID of the transaction
+   * The unique identifier for the company token transaction.
    */
   id: string;
 
@@ -305,7 +203,7 @@ export interface CompanyTokenTransactionListResponse {
   company: CompanyTokenTransactionListResponse.Company;
 
   /**
-   * When the transaction was created
+   * The datetime the company token transaction was created.
    */
   created_at: string;
 
@@ -332,7 +230,7 @@ export interface CompanyTokenTransactionListResponse {
   /**
    * The type of transaction
    */
-  transaction_type: 'add' | 'subtract' | 'transfer';
+  transaction_type: BotTokenTransactionTypes;
 
   /**
    * The user whose balance changed
@@ -346,7 +244,7 @@ export namespace CompanyTokenTransactionListResponse {
    */
   export interface Company {
     /**
-     * The ID of the company
+     * The unique identifier for the company.
      */
     id: string;
 
@@ -366,7 +264,7 @@ export namespace CompanyTokenTransactionListResponse {
    */
   export interface Member {
     /**
-     * The ID of the member
+     * The unique identifier for the company member.
      */
     id: string;
   }
@@ -376,7 +274,7 @@ export namespace CompanyTokenTransactionListResponse {
    */
   export interface User {
     /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     id: string;
 
@@ -515,7 +413,7 @@ export interface CompanyTokenTransactionListParams extends CursorPageParams {
   /**
    * The type of token transaction
    */
-  transaction_type?: 'add' | 'subtract' | 'transfer' | null;
+  transaction_type?: BotTokenTransactionTypes | null;
 
   /**
    * Filter by user ID
@@ -525,8 +423,8 @@ export interface CompanyTokenTransactionListParams extends CursorPageParams {
 
 export declare namespace CompanyTokenTransactions {
   export {
-    type CompanyTokenTransactionCreateResponse as CompanyTokenTransactionCreateResponse,
-    type CompanyTokenTransactionRetrieveResponse as CompanyTokenTransactionRetrieveResponse,
+    type BotTokenTransactionTypes as BotTokenTransactionTypes,
+    type CompanyTokenTransaction as CompanyTokenTransaction,
     type CompanyTokenTransactionListResponse as CompanyTokenTransactionListResponse,
     type CompanyTokenTransactionListResponsesCursorPage as CompanyTokenTransactionListResponsesCursorPage,
     type CompanyTokenTransactionCreateParams as CompanyTokenTransactionCreateParams,

package/src/resources/course-chapters.ts

@@ -115,7 +115,7 @@ export type CourseChapterListResponsesCursorPage = CursorPage<CourseChapterListR
  */
 export interface CourseChapter {
   /**
-   * The ID of the chapter. Looks like chap_XXX
+   * The unique identifier for the chapter.
    */
   id: string;
 
@@ -141,7 +141,7 @@ export namespace CourseChapter {
    */
   export interface Lesson {
     /**
-     * The ID of the lesson
+     * The unique identifier for the lesson.
      */
     id: string;
 
@@ -162,7 +162,7 @@ export namespace CourseChapter {
  */
 export interface CourseChapterListResponse {
   /**
-   * The ID of the chapter. Looks like chap_XXX
+   * The unique identifier for the chapter.
    */
   id: string;