@whop/sdk 0.0.25 → 0.0.27

package/src/resources/members.ts

@@ -31,7 +31,7 @@ export class Members extends APIResource {
    * - `member:phone:read`
    */
   list(
-    query: MemberListParams,
+    query: MemberListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<MemberListResponsesCursorPage, MemberListResponse> {
     return this._client.getAPIList('/members', CursorPage<MemberListResponse>, { query, ...options });
@@ -47,7 +47,7 @@ export type MemberListResponsesCursorPage = CursorPage<MemberListResponse>;
  */
 export interface MemberRetrieveResponse {
   /**
-   * The ID of the member
+   * The unique identifier for the company member.
    */
   id: string;
 
@@ -70,7 +70,7 @@ export interface MemberRetrieveResponse {
   company_token_balance: number;
 
   /**
-   * When the member was created
+   * The datetime the company member was created.
    */
   created_at: string;
 
@@ -100,7 +100,7 @@ export interface MemberRetrieveResponse {
   status: Shared.MemberStatuses;
 
   /**
-   * The timestamp of when this member was last updated
+   * The datetime the company member was last updated.
    */
   updated_at: string;
 
@@ -121,7 +121,7 @@ export namespace MemberRetrieveResponse {
    */
   export interface Company {
     /**
-     * The ID of the company
+     * The unique identifier for the company.
      */
     id: string;
 
@@ -141,7 +141,7 @@ export namespace MemberRetrieveResponse {
    */
   export interface User {
     /**
-     * The internal ID of the user account.
+     * The unique identifier for the company member user.
      */
     id: string;
 
@@ -169,7 +169,7 @@ export namespace MemberRetrieveResponse {
  */
 export interface MemberListResponse {
   /**
-   * The ID of the member
+   * The unique identifier for the company member.
    */
   id: string;
 
@@ -187,7 +187,7 @@ export interface MemberListResponse {
   company_token_balance: number;
 
   /**
-   * When the member was created
+   * The datetime the company member was created.
    */
   created_at: string;
 
@@ -217,7 +217,7 @@ export interface MemberListResponse {
   status: Shared.MemberStatuses;
 
   /**
-   * The timestamp of when this member was last updated
+   * The datetime the company member was last updated.
    */
   updated_at: string;
 
@@ -238,7 +238,7 @@ export namespace MemberListResponse {
    */
   export interface User {
     /**
-     * The internal ID of the user account.
+     * The unique identifier for the company member user.
      */
     id: string;
 
@@ -260,11 +260,6 @@ export namespace MemberListResponse {
 }
 
 export interface MemberListParams extends CursorPageParams {
-  /**
-   * The ID of the company to list members for
-   */
-  company_id: string;
-
   /**
    * The access level a given user (or company) has to a product or company.
    */
@@ -275,6 +270,11 @@ export interface MemberListParams extends CursorPageParams {
    */
   before?: string | null;
 
+  /**
+   * The ID of the company to list members for
+   */
+  company_id?: string | null;
+
   /**
    * The minimum creation date to filter by
    */

package/src/resources/memberships.ts

@@ -117,12 +117,25 @@ export class Memberships extends APIResource {
 export type MembershipListResponsesCursorPage = CursorPage<MembershipListResponse>;
 
 /**
- * A membership represents a purchase between a User and a Company for a specific
- * Product.
+ * The different reasons a user can choose for why they are canceling their
+ * membership.
+ */
+export type CancelOptions =
+  | 'too_expensive'
+  | 'switching'
+  | 'missing_features'
+  | 'technical_issues'
+  | 'bad_experience'
+  | 'other'
+  | 'testing';
+
+/**
+ * A membership represents an active relationship between a user and a product. It
+ * tracks the user's access, billing status, and renewal schedule.
  */
 export interface MembershipListResponse {
   /**
-   * The ID of the membership
+   * The unique identifier for the membership.
    */
   id: string;
 
@@ -136,15 +149,7 @@ export interface MembershipListResponse {
    * The different reasons a user can choose for why they are canceling their
    * membership.
    */
-  cancel_option:
-    | 'too_expensive'
-    | 'switching'
-    | 'missing_features'
-    | 'technical_issues'
-    | 'bad_experience'
-    | 'other'
-    | 'testing'
-    | null;
+  cancel_option: CancelOptions | null;
 
   /**
    * The epoch timestamp of when the customer initiated a cancellation.
@@ -162,7 +167,7 @@ export interface MembershipListResponse {
   company: MembershipListResponse.Company;
 
   /**
-   * The timestamp, in seconds, that this Membership was created at.
+   * The datetime the membership was created.
    */
   created_at: string;
 
@@ -171,6 +176,11 @@ export interface MembershipListResponse {
    */
   currency: Shared.Currency | null;
 
+  /**
+   * When the member joined the company.
+   */
+  joined_at: string | null;
+
   /**
    * The license key for this Membership. This is only present if the membership
    * grants access to an instance of the Whop Software app.
@@ -188,7 +198,8 @@ export interface MembershipListResponse {
   member: MembershipListResponse.Member | null;
 
   /**
-   * A JSON object used to store software licensing information. Ex. HWID
+   * Custom key-value pairs for the membership (commonly used for software licensing,
+   * e.g., HWID). Max 50 keys, 500 chars per key, 5000 chars per value.
    */
   metadata: { [key: string]: unknown };
 
@@ -230,7 +241,7 @@ export interface MembershipListResponse {
   status: Shared.MembershipStatus;
 
   /**
-   * A timestamp of when the membership was last updated
+   * The datetime the membership was last updated.
    */
   updated_at: string;
 
@@ -246,7 +257,7 @@ export namespace MembershipListResponse {
    */
   export interface Company {
     /**
-     * The ID (tag) of the company.
+     * The unique identifier for the company.
      */
     id: string;
 
@@ -261,7 +272,7 @@ export namespace MembershipListResponse {
    */
   export interface Member {
     /**
-     * The ID of the member
+     * The unique identifier for the member.
      */
     id: string;
   }
@@ -271,7 +282,7 @@ export namespace MembershipListResponse {
    */
   export interface Plan {
     /**
-     * The internal ID of the plan.
+     * The unique identifier for the plan.
      */
     id: string;
   }
@@ -281,7 +292,7 @@ export namespace MembershipListResponse {
    */
   export interface Product {
     /**
-     * The internal ID of the public product.
+     * The unique identifier for the product.
      */
     id: string;
 
@@ -296,7 +307,7 @@ export namespace MembershipListResponse {
    */
   export interface PromoCode {
     /**
-     * The ID of the promo.
+     * The unique identifier for the promo code.
      */
     id: string;
   }
@@ -306,7 +317,7 @@ export namespace MembershipListResponse {
    */
   export interface User {
     /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     id: string;
 
@@ -343,15 +354,7 @@ export interface MembershipListParams extends CursorPageParams {
   /**
    * The cancel options to filter the memberships by
    */
-  cancel_options?: Array<
-    | 'too_expensive'
-    | 'switching'
-    | 'missing_features'
-    | 'technical_issues'
-    | 'bad_experience'
-    | 'other'
-    | 'testing'
-  > | null;
+  cancel_options?: Array<CancelOptions> | null;
 
   /**
    * The ID of the company to list memberships for
@@ -431,6 +434,7 @@ export interface MembershipPauseParams {
 
 export declare namespace Memberships {
   export {
+    type CancelOptions as CancelOptions,
     type MembershipListResponse as MembershipListResponse,
     type MembershipListResponsesCursorPage as MembershipListResponsesCursorPage,
     type MembershipUpdateParams as MembershipUpdateParams,

package/src/resources/messages.ts

@@ -74,7 +74,11 @@ export type MessageListResponsesCursorPage = CursorPage<MessageListResponse>;
  */
 export interface MessageListResponse {
   /**
-   * The unique identifier of the resource.
+   * Represents a unique identifier that is Base64 obfuscated. It is often used to
+   * refetch an object or as key for a cache. The ID type appears in a JSON response
+   * as a String; however, it is not intended to be human-readable. When expected as
+   * an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
+   * input value will be accepted as an ID.
    */
   id: string;
 
@@ -156,7 +160,7 @@ export namespace MessageListResponse {
      */
     export interface Option {
       /**
-       * The ID of the poll option
+       * The unique identifier for the poll option.
        */
       id: string;
 
@@ -202,7 +206,7 @@ export namespace MessageListResponse {
    */
   export interface User {
     /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     id: string;
 

package/src/resources/payments.ts

@@ -253,6 +253,8 @@ export type CardBrands =
   | 'fuel_card'
   | 'dankort'
   | 'carnet'
+  | 'atm_card'
+  | 'china_union_payuzcard'
   | 'unknown';
 
 /**
@@ -277,6 +279,7 @@ export type PaymentMethodTypes =
   | 'capchase_pay'
   | 'card'
   | 'cashapp'
+  | 'claritypay'
   | 'coinbase'
   | 'crypto'
   | 'custom'
@@ -349,11 +352,12 @@ export type PaymentMethodTypes =
   | 'unknown';
 
 /**
- * An object representing a receipt for a membership.
+ * A payment represents a completed or attempted charge for a membership. Payments
+ * track the amount, status, currency, and payment method used.
  */
 export interface PaymentListResponse {
   /**
-   * The payment ID
+   * The unique identifier for the payment.
    */
   id: string;
 
@@ -362,6 +366,11 @@ export interface PaymentListResponse {
    */
   amount_after_fees: number;
 
+  /**
+   * The application fee charged on this payment.
+   */
+  application_fee: PaymentListResponse.ApplicationFee | null;
+
   /**
    * Whether this payment was auto refunded or not
    */
@@ -393,7 +402,7 @@ export interface PaymentListResponse {
   company: PaymentListResponse.Company | null;
 
   /**
-   * The datetime the payment was created
+   * The datetime the payment was created.
    */
   created_at: string;
 
@@ -534,6 +543,41 @@ export interface PaymentListResponse {
 }
 
 export namespace PaymentListResponse {
+  /**
+   * The application fee charged on this payment.
+   */
+  export interface ApplicationFee {
+    /**
+     * The unique identifier for the application fee.
+     */
+    id: string;
+
+    /**
+     * The application fee amount.
+     */
+    amount: number;
+
+    /**
+     * The amount of the application fee that has been captured.
+     */
+    amount_captured: number;
+
+    /**
+     * The amount of the application fee that has been refunded.
+     */
+    amount_refunded: number;
+
+    /**
+     * The datetime the application fee was created.
+     */
+    created_at: string;
+
+    /**
+     * The currency of the application fee.
+     */
+    currency: Shared.Currency;
+  }
+
   /**
    * The address of the user who made the payment.
    */
@@ -579,7 +623,7 @@ export namespace PaymentListResponse {
    */
   export interface Company {
     /**
-     * The ID of the company
+     * The unique identifier for the company.
      */
     id: string;
 
@@ -599,7 +643,7 @@ export namespace PaymentListResponse {
    */
   export interface Member {
     /**
-     * The ID of the member
+     * The unique identifier for the company member.
      */
     id: string;
 
@@ -614,7 +658,7 @@ export namespace PaymentListResponse {
    */
   export interface Membership {
     /**
-     * The internal ID of the membership.
+     * The unique identifier for the membership.
      */
     id: string;
 
@@ -629,7 +673,7 @@ export namespace PaymentListResponse {
    */
   export interface PaymentMethod {
     /**
-     * The ID of the payment method
+     * The unique identifier for the payment token.
      */
     id: string;
 
@@ -639,7 +683,7 @@ export namespace PaymentListResponse {
     card: PaymentMethod.Card | null;
 
     /**
-     * The date and time the payment method was created
+     * The datetime the payment token was created.
      */
     created_at: string;
 
@@ -681,7 +725,7 @@ export namespace PaymentListResponse {
    */
   export interface Plan {
     /**
-     * The internal ID of the plan.
+     * The unique identifier for the plan.
      */
     id: string;
   }
@@ -691,7 +735,7 @@ export namespace PaymentListResponse {
    */
   export interface Product {
     /**
-     * The internal ID of the public product.
+     * The unique identifier for the product.
      */
     id: string;
 
@@ -711,12 +755,14 @@ export namespace PaymentListResponse {
    */
   export interface PromoCode {
     /**
-     * The ID of the promo.
+     * The unique identifier for the promo code.
      */
     id: string;
 
     /**
-     * The amount off (% or flat amount) for the promo.
+     * The discount amount. Interpretation depends on promo_type: if 'percentage', this
+     * is the percentage (e.g., 20 means 20% off); if 'flat_amount', this is dollars
+     * off (e.g., 10.00 means $10.00 off).
      */
     amount_off: number;
 
@@ -746,7 +792,7 @@ export namespace PaymentListResponse {
    */
   export interface User {
     /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     id: string;
 
@@ -867,7 +913,8 @@ export declare namespace PaymentCreateParams {
       currency: Shared.Currency;
 
       /**
-       * 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;
 
@@ -877,7 +924,8 @@ export declare namespace PaymentCreateParams {
       description?: string | null;
 
       /**
-       * The interval at which the plan charges (expiration plans).
+       * The number of days until the membership expires and revokes access (expiration
+       * plans). For example, 365 for one year.
        */
       expiration_days?: number | null;
 
@@ -888,7 +936,8 @@ export declare namespace PaymentCreateParams {
       force_create_new_plan?: boolean | null;
 
       /**
-       * An additional amount charged upon first purchase.
+       * An additional amount charged upon first purchase. Provided as a number in the
+       * specified currency. Eg: 10.43 for $10.43 USD.
        */
       initial_price?: number | null;
 
@@ -914,7 +963,8 @@ export declare namespace PaymentCreateParams {
       product_id?: string | null;
 
       /**
-       * The amount the customer is charged every billing period.
+       * The amount the customer is charged every billing period. Provided as a number in
+       * the specified currency. Eg: 10.43 for $10.43 USD.
        */
       renewal_price?: number | null;
 

package/src/resources/payout-methods.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 PayoutMethodsAPI from './payout-methods';
 import { APIPromise } from '../core/api-promise';
 import { CursorPage, type CursorPageParams, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
@@ -38,12 +39,23 @@ export class PayoutMethods extends APIResource {
 
 export type PayoutMethodListResponsesCursorPage = CursorPage<PayoutMethodListResponse>;
 
+/**
+ * The category of a payout destination.
+ */
+export type PayoutDestinationCategory =
+  | 'crypto'
+  | 'rtp'
+  | 'next_day_bank'
+  | 'bank_wire'
+  | 'digital_wallet'
+  | 'unknown';
+
 /**
  * An object representing an user's setup payout destination.
  */
 export interface PayoutMethodRetrieveResponse {
   /**
-   * The ID of the payout token
+   * The unique identifier for the payout token.
    */
   id: string;
 
@@ -59,7 +71,7 @@ export interface PayoutMethodRetrieveResponse {
   company: PayoutMethodRetrieveResponse.Company | null;
 
   /**
-   * The date and time the payout token was created
+   * The datetime the payout token was created.
    */
   created_at: string;
 
@@ -97,7 +109,7 @@ export namespace PayoutMethodRetrieveResponse {
    */
   export interface Company {
     /**
-     * The ID (tag) of the company.
+     * The unique identifier for the company.
      */
     id: string;
   }
@@ -109,7 +121,7 @@ export namespace PayoutMethodRetrieveResponse {
     /**
      * The category of the payout destination
      */
-    category: 'crypto' | 'rtp' | 'next_day_bank' | 'bank_wire' | 'digital_wallet' | 'unknown';
+    category: PayoutMethodsAPI.PayoutDestinationCategory;
 
     /**
      * The country code of the payout destination
@@ -128,7 +140,7 @@ export namespace PayoutMethodRetrieveResponse {
  */
 export interface PayoutMethodListResponse {
   /**
-   * The ID of the payout token
+   * The unique identifier for the payout token.
    */
   id: string;
 
@@ -144,7 +156,7 @@ export interface PayoutMethodListResponse {
   company: PayoutMethodListResponse.Company | null;
 
   /**
-   * The date and time the payout token was created
+   * The datetime the payout token was created.
    */
   created_at: string;
 
@@ -182,7 +194,7 @@ export namespace PayoutMethodListResponse {
    */
   export interface Company {
     /**
-     * The ID (tag) of the company.
+     * The unique identifier for the company.
      */
     id: string;
   }
@@ -194,7 +206,7 @@ export namespace PayoutMethodListResponse {
     /**
      * The category of the payout destination
      */
-    category: 'crypto' | 'rtp' | 'next_day_bank' | 'bank_wire' | 'digital_wallet' | 'unknown';
+    category: PayoutMethodsAPI.PayoutDestinationCategory;
 
     /**
      * The country code of the payout destination
@@ -232,6 +244,7 @@ export interface PayoutMethodListParams extends CursorPageParams {
 
 export declare namespace PayoutMethods {
   export {
+    type PayoutDestinationCategory as PayoutDestinationCategory,
     type PayoutMethodRetrieveResponse as PayoutMethodRetrieveResponse,
     type PayoutMethodListResponse as PayoutMethodListResponse,
     type PayoutMethodListResponsesCursorPage as PayoutMethodListResponsesCursorPage,