@whop/sdk 0.0.26 → 0.0.27

package/src/resources/memberships.ts

@@ -130,12 +130,12 @@ export type CancelOptions =
   | 'testing';
 
 /**
- * A membership represents a purchase between a User and a Company for a specific
- * Product.
+ * 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;
 
@@ -167,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;
 
@@ -176,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.
@@ -193,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 };
 
@@ -235,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;
 
@@ -251,7 +257,7 @@ export namespace MembershipListResponse {
    */
   export interface Company {
     /**
-     * The ID (tag) of the company.
+     * The unique identifier for the company.
      */
     id: string;
 
@@ -266,7 +272,7 @@ export namespace MembershipListResponse {
    */
   export interface Member {
     /**
-     * The ID of the member
+     * The unique identifier for the member.
      */
     id: string;
   }
@@ -276,7 +282,7 @@ export namespace MembershipListResponse {
    */
   export interface Plan {
     /**
-     * The internal ID of the plan.
+     * The unique identifier for the plan.
      */
     id: string;
   }
@@ -286,7 +292,7 @@ export namespace MembershipListResponse {
    */
   export interface Product {
     /**
-     * The internal ID of the public product.
+     * The unique identifier for the product.
      */
     id: string;
 
@@ -301,7 +307,7 @@ export namespace MembershipListResponse {
    */
   export interface PromoCode {
     /**
-     * The ID of the promo.
+     * The unique identifier for the promo code.
      */
     id: string;
   }
@@ -311,7 +317,7 @@ export namespace MembershipListResponse {
    */
   export interface User {
     /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     id: string;
 

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;
 
@@ -398,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;
 
@@ -564,7 +568,7 @@ export namespace PaymentListResponse {
     amount_refunded: number;
 
     /**
-     * When the application fee was created.
+     * The datetime the application fee was created.
      */
     created_at: string;
 
@@ -619,7 +623,7 @@ export namespace PaymentListResponse {
    */
   export interface Company {
     /**
-     * The ID of the company
+     * The unique identifier for the company.
      */
     id: string;
 
@@ -639,7 +643,7 @@ export namespace PaymentListResponse {
    */
   export interface Member {
     /**
-     * The ID of the member
+     * The unique identifier for the company member.
      */
     id: string;
 
@@ -654,7 +658,7 @@ export namespace PaymentListResponse {
    */
   export interface Membership {
     /**
-     * The internal ID of the membership.
+     * The unique identifier for the membership.
      */
     id: string;
 
@@ -669,7 +673,7 @@ export namespace PaymentListResponse {
    */
   export interface PaymentMethod {
     /**
-     * The ID of the payment method
+     * The unique identifier for the payment token.
      */
     id: string;
 
@@ -679,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;
 
@@ -721,7 +725,7 @@ export namespace PaymentListResponse {
    */
   export interface Plan {
     /**
-     * The internal ID of the plan.
+     * The unique identifier for the plan.
      */
     id: string;
   }
@@ -731,7 +735,7 @@ export namespace PaymentListResponse {
    */
   export interface Product {
     /**
-     * The internal ID of the public product.
+     * The unique identifier for the product.
      */
     id: string;
 
@@ -751,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;
 
@@ -786,7 +792,7 @@ export namespace PaymentListResponse {
    */
   export interface User {
     /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     id: string;
 
@@ -907,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;
 
@@ -917,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;
 
@@ -928,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;
 
@@ -954,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

@@ -55,7 +55,7 @@ export type PayoutDestinationCategory =
  */
 export interface PayoutMethodRetrieveResponse {
   /**
-   * The ID of the payout token
+   * The unique identifier for the payout token.
    */
   id: string;
 
@@ -71,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;
 
@@ -109,7 +109,7 @@ export namespace PayoutMethodRetrieveResponse {
    */
   export interface Company {
     /**
-     * The ID (tag) of the company.
+     * The unique identifier for the company.
      */
     id: string;
   }
@@ -140,7 +140,7 @@ export namespace PayoutMethodRetrieveResponse {
  */
 export interface PayoutMethodListResponse {
   /**
-   * The ID of the payout token
+   * The unique identifier for the payout token.
    */
   id: string;
 
@@ -156,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;
 
@@ -194,7 +194,7 @@ export namespace PayoutMethodListResponse {
    */
   export interface Company {
     /**
-     * The ID (tag) of the company.
+     * The unique identifier for the company.
      */
     id: string;
   }

package/src/resources/plans.ts

@@ -118,18 +118,18 @@ export class Plans extends APIResource {
 export type PlanListResponsesCursorPage = CursorPage<PlanListResponse>;
 
 /**
- * A plan for an product. Plans define the core parameters that define a checkout
- * and payment on whop. Use plans to create different ways to price your products
- * (Eg renewal / one_time)
+ * A plan defines pricing and billing terms for a product. Each product can have
+ * multiple plans representing different pricing options, such as one-time
+ * payments, recurring subscriptions, or free trials.
  */
 export interface PlanListResponse {
   /**
-   * 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;
 
@@ -139,7 +139,7 @@ export interface PlanListResponse {
   company: PlanListResponse.Company | null;
 
   /**
-   * When the plan was created.
+   * The datetime the plan was created.
    */
   created_at: string;
 
@@ -154,12 +154,15 @@ export interface PlanListResponse {
   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;
 
   /**
-   * 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;
 
@@ -204,7 +207,8 @@ export interface PlanListResponse {
   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;
 
@@ -229,12 +233,13 @@ export interface PlanListResponse {
   trial_period_days: number | null;
 
   /**
-   * Limits/doesn't limit the number of units available for purchase.
+   * When true, the plan has unlimited stock (stock field is ignored). When false,
+   * purchases are limited by the stock field.
    */
   unlimited_stock: boolean;
 
   /**
-   * When the plan was last updated.
+   * The datetime the plan was last updated.
    */
   updated_at: string;
 
@@ -250,7 +255,7 @@ export namespace PlanListResponse {
    */
   export interface Company {
     /**
-     * The ID (tag) of the company.
+     * The unique identifier for the company.
      */
     id: string;
 
@@ -265,7 +270,7 @@ export namespace PlanListResponse {
    */
   export interface Invoice {
     /**
-     * The ID of the invoice.
+     * The unique identifier for the invoice.
      */
     id: string;
   }
@@ -301,7 +306,7 @@ export namespace PlanListResponse {
    */
   export interface Product {
     /**
-     * The internal ID of the public product.
+     * The unique identifier for the product.
      */
     id: string;
 
@@ -361,7 +366,7 @@ export interface PlanCreateParams {
   /**
    * An additional amount charged upon first purchase. Use only if a one time payment
    * OR you want to charge an additional amount on top of the renewal price. Provided
-   * as a number in dollars. Eg: 10.43 for $10.43
+   * as a number in the specified currency. Eg: 10.43 for $10.43
    */
   initial_price?: number | null;
 
@@ -399,7 +404,7 @@ export interface PlanCreateParams {
 
   /**
    * The amount the customer is charged every billing period. Use only if a recurring
-   * payment. Provided as a number in dollars. Eg: 10.43 for $10.43
+   * payment. Provided as a number in the specified currency. Eg: 10.43 for $10.43
    */
   renewal_price?: number | null;
 
@@ -424,7 +429,8 @@ export interface PlanCreateParams {
   trial_period_days?: number | null;
 
   /**
-   * Limits/doesn't limit the number of units available for purchase.
+   * When true, the plan has unlimited stock (stock field is ignored). When false,
+   * purchases are limited by the stock field.
    */
   unlimited_stock?: boolean | null;
 
@@ -507,7 +513,7 @@ export namespace PlanCreateParams {
 
 export interface PlanUpdateParams {
   /**
-   * The interval at which the plan charges (renewal plans).
+   * The interval in days at which the plan charges (renewal plans).
    */
   billing_period?: number | null;
 
@@ -527,7 +533,8 @@ export interface PlanUpdateParams {
   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;
 
@@ -537,7 +544,8 @@ export interface PlanUpdateParams {
   image?: PlanUpdateParams.Image | 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;
 
@@ -569,7 +577,8 @@ export interface PlanUpdateParams {
   payment_method_configuration?: PlanUpdateParams.PaymentMethodConfiguration | 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;
 
@@ -580,13 +589,13 @@ export interface PlanUpdateParams {
 
   /**
    * The price to display with a strikethrough for the initial price. Provided as a
-   * number in dollars. Eg: 19.99 for $19.99
+   * number in the specified currency. Eg: 19.99 for $19.99
    */
   strike_through_initial_price?: number | null;
 
   /**
    * The price to display with a strikethrough for the renewal price. Provided as a
-   * number in dollars. Eg: 19.99 for $19.99
+   * number in the specified currency. Eg: 19.99 for $19.99
    */
   strike_through_renewal_price?: number | null;
 
@@ -601,7 +610,8 @@ export interface PlanUpdateParams {
   trial_period_days?: number | null;
 
   /**
-   * Limits/doesn't limit the number of units available for purchase.
+   * When true, the plan has unlimited stock (stock field is ignored). When false,
+   * purchases are limited by the stock field.
    */
   unlimited_stock?: boolean | null;
 

package/src/resources/products.ts

@@ -248,7 +248,8 @@ export namespace ProductCreateParams {
     custom_fields?: Array<PlanOptions.CustomField> | 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;
 
@@ -263,7 +264,8 @@ export namespace ProductCreateParams {
     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
+     * the specified currency. Eg: 10.43 for $10.43 USD.
      */
     renewal_price?: number | null;
 

package/src/resources/promo-codes.ts

@@ -99,16 +99,20 @@ export class PromoCodes extends APIResource {
 export type PromoCodeListResponsesCursorPage = CursorPage<PromoCodeListResponse>;
 
 /**
- * An object representing a promo code for a plan.
+ * A promo code applies a discount to a plan during checkout. Promo codes can be
+ * percentage-based or fixed-amount, and can have usage limits and expiration
+ * dates.
  */
 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;
 
@@ -128,7 +132,7 @@ export interface PromoCode {
   company: PromoCode.Company;
 
   /**
-   * The timestamp of when the promo was created.
+   * The datetime the promo code was created.
    */
   created_at: string;
 
@@ -205,7 +209,7 @@ export namespace PromoCode {
    */
   export interface Company {
     /**
-     * The ID of the company
+     * The unique identifier for the company.
      */
     id: string;
 
@@ -220,7 +224,7 @@ export namespace PromoCode {
    */
   export interface Product {
     /**
-     * The internal ID of the public product.
+     * The unique identifier for the product.
      */
     id: string;
 
@@ -242,16 +246,20 @@ export type PromoCodeStatus = 'active' | 'inactive' | 'archived';
 export type PromoDuration = 'forever' | 'once' | 'repeating';
 
 /**
- * An object representing a promo code for a plan.
+ * A promo code applies a discount to a plan during checkout. Promo codes can be
+ * percentage-based or fixed-amount, and can have usage limits and expiration
+ * dates.
  */
 export interface PromoCodeListResponse {
   /**
-   * 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;
 
@@ -266,7 +274,7 @@ export interface PromoCodeListResponse {
   code: string | null;
 
   /**
-   * The timestamp of when the promo was created.
+   * The datetime the promo code was created.
    */
   created_at: string;
 
@@ -343,7 +351,7 @@ export namespace PromoCodeListResponse {
    */
   export interface Product {
     /**
-     * The internal ID of the public product.
+     * The unique identifier for the product.
      */
     id: string;
 
@@ -361,7 +369,9 @@ export type PromoCodeDeleteResponse = boolean;
 
 export interface PromoCodeCreateParams {
   /**
-   * 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;