@whop/sdk 0.0.25 → 0.0.27

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;
 

package/src/resources/reactions.ts

@@ -94,7 +94,7 @@ export namespace ReactionListResponse {
    */
   export interface User {
     /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     id: string;
 

package/src/resources/refunds.ts

@@ -52,7 +52,8 @@ export type PaymentProvider =
   | 'splitit'
   | 'platform_balance'
   | 'multi_psp'
-  | 'adyen';
+  | 'adyen'
+  | 'claritypay';
 
 /**
  * The status of the refund reference.
@@ -73,21 +74,23 @@ export type RefundReferenceType =
 export type RefundStatus = 'pending' | 'requires_action' | 'succeeded' | 'failed' | 'canceled';
 
 /**
- * An object representing a refund made on a payment.
+ * A refund represents a full or partial reversal of a payment, including the
+ * amount, status, and payment provider.
  */
 export interface RefundRetrieveResponse {
   /**
-   * The ID of the refund.
+   * The unique identifier for the refund.
    */
   id: string;
 
   /**
-   * The amount of the refund.
+   * The amount of the refund. Provided as a number in the specified currency. Eg:
+   * 10.43 for $10.43 USD.
    */
   amount: number;
 
   /**
-   * The time the refund was created.
+   * The datetime the refund was created.
    */
   created_at: string;
 
@@ -138,7 +141,7 @@ export namespace RefundRetrieveResponse {
    */
   export interface Payment {
     /**
-     * The payment ID
+     * The unique identifier for the payment.
      */
     id: string;
 
@@ -158,7 +161,7 @@ export namespace RefundRetrieveResponse {
     card_last4: string | null;
 
     /**
-     * The datetime the payment was created
+     * The datetime the payment was created.
      */
     created_at: string;
 
@@ -219,7 +222,7 @@ export namespace RefundRetrieveResponse {
      */
     export interface Member {
       /**
-       * The ID of the member
+       * The unique identifier for the company member.
        */
       id: string;
 
@@ -234,7 +237,7 @@ export namespace RefundRetrieveResponse {
      */
     export interface Membership {
       /**
-       * The internal ID of the membership.
+       * The unique identifier for the membership.
        */
       id: string;
 
@@ -249,7 +252,7 @@ export namespace RefundRetrieveResponse {
      */
     export interface User {
       /**
-       * The internal ID of the user.
+       * The unique identifier for the user.
        */
       id: string;
 
@@ -272,21 +275,23 @@ export namespace RefundRetrieveResponse {
 }
 
 /**
- * An object representing a refund made on a payment.
+ * A refund represents a full or partial reversal of a payment, including the
+ * amount, status, and payment provider.
  */
 export interface RefundListResponse {
   /**
-   * The ID of the refund.
+   * The unique identifier for the refund.
    */
   id: string;
 
   /**
-   * The amount of the refund.
+   * The amount of the refund. Provided as a number in the specified currency. Eg:
+   * 10.43 for $10.43 USD.
    */
   amount: number;
 
   /**
-   * The time the refund was created.
+   * The datetime the refund was created.
    */
   created_at: string;
 
@@ -337,7 +342,7 @@ export namespace RefundListResponse {
    */
   export interface Payment {
     /**
-     * The payment ID
+     * The unique identifier for the payment.
      */
     id: string;
   }

package/src/resources/reviews.ts

@@ -37,7 +37,7 @@ export type ReviewStatus = 'pending' | 'published' | 'removed';
  */
 export interface ReviewRetrieveResponse {
   /**
-   * The internal ID of the review.
+   * The unique identifier for the review.
    */
   id: string;
 
@@ -52,7 +52,7 @@ export interface ReviewRetrieveResponse {
   company: ReviewRetrieveResponse.Company;
 
   /**
-   * The timestamp of when the review was created.
+   * The datetime the review was created.
    */
   created_at: string;
 
@@ -98,7 +98,7 @@ export interface ReviewRetrieveResponse {
   title: string | null;
 
   /**
-   * The timestamp of when the review was last updated.
+   * The datetime the review was last updated.
    */
   updated_at: string;
 
@@ -140,7 +140,7 @@ export namespace ReviewRetrieveResponse {
    */
   export interface Company {
     /**
-     * The ID (tag) of the company.
+     * The unique identifier for the company.
      */
     id: string;
 
@@ -160,7 +160,7 @@ export namespace ReviewRetrieveResponse {
    */
   export interface Product {
     /**
-     * The internal ID of the public product.
+     * The unique identifier for the product.
      */
     id: string;
 
@@ -175,7 +175,7 @@ export namespace ReviewRetrieveResponse {
    */
   export interface User {
     /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     id: string;
 
@@ -196,7 +196,7 @@ export namespace ReviewRetrieveResponse {
  */
 export interface ReviewListResponse {
   /**
-   * The internal ID of the review.
+   * The unique identifier for the review.
    */
   id: string;
 
@@ -206,7 +206,7 @@ export interface ReviewListResponse {
   attachments: Array<ReviewListResponse.Attachment>;
 
   /**
-   * The timestamp of when the review was created.
+   * The datetime the review was created.
    */
   created_at: string;
 
@@ -247,7 +247,7 @@ export interface ReviewListResponse {
   title: string | null;
 
   /**
-   * The timestamp of when the review was last updated.
+   * The datetime the review was last updated.
    */
   updated_at: string;
 
@@ -289,7 +289,7 @@ export namespace ReviewListResponse {
    */
   export interface User {
     /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     id: string;
 

package/src/resources/setup-intents.ts

@@ -53,12 +53,11 @@ export class SetupIntents extends APIResource {
 export type SetupIntentListResponsesCursorPage = CursorPage<SetupIntentListResponse>;
 
 /**
- * An object representing a setup intent, which is a flow for allowing a customer
- * to add a payment method to their account without making a purchase.
+ * A setup intent allows a user to save a payment method without making a purchase.
  */
 export interface SetupIntent {
   /**
-   * The setup intent ID
+   * The unique identifier for the setup intent.
    */
   id: string;
 
@@ -73,7 +72,7 @@ export interface SetupIntent {
   company: SetupIntent.Company | null;
 
   /**
-   * The datetime the payment was created
+   * The datetime the setup intent was created.
    */
   created_at: string;
 
@@ -109,7 +108,7 @@ export namespace SetupIntent {
    */
   export interface CheckoutConfiguration {
     /**
-     * The ID of the checkout configuration
+     * The unique identifier for the checkout session.
      */
     id: string;
   }
@@ -119,7 +118,7 @@ export namespace SetupIntent {
    */
   export interface Company {
     /**
-     * The ID (tag) of the company.
+     * The unique identifier for the company.
      */
     id: string;
   }
@@ -129,7 +128,7 @@ export namespace SetupIntent {
    */
   export interface Member {
     /**
-     * The ID of the member
+     * The unique identifier for the company member.
      */
     id: string;
 
@@ -145,7 +144,7 @@ export namespace SetupIntent {
      */
     export interface User {
       /**
-       * The internal ID of the user account.
+       * The unique identifier for the company member user.
        */
       id: string;
 
@@ -171,7 +170,7 @@ export namespace SetupIntent {
    */
   export interface PaymentMethod {
     /**
-     * The ID of the payment method
+     * The unique identifier for the payment token.
      */
     id: string;
 
@@ -181,7 +180,7 @@ export namespace SetupIntent {
     card: PaymentMethod.Card | null;
 
     /**
-     * The date and time the payment method was created
+     * The datetime the payment token was created.
      */
     created_at: string;
 
@@ -225,12 +224,11 @@ export namespace SetupIntent {
 export type SetupIntentStatus = 'processing' | 'succeeded' | 'canceled' | 'requires_action';
 
 /**
- * An object representing a setup intent, which is a flow for allowing a customer
- * to add a payment method to their account without making a purchase.
+ * A setup intent allows a user to save a payment method without making a purchase.
  */
 export interface SetupIntentListResponse {
   /**
-   * The setup intent ID
+   * The unique identifier for the setup intent.
    */
   id: string;
 
@@ -245,7 +243,7 @@ export interface SetupIntentListResponse {
   company: SetupIntentListResponse.Company | null;
 
   /**
-   * The datetime the payment was created
+   * The datetime the setup intent was created.
    */
   created_at: string;
 
@@ -281,7 +279,7 @@ export namespace SetupIntentListResponse {
    */
   export interface CheckoutConfiguration {
     /**
-     * The ID of the checkout configuration
+     * The unique identifier for the checkout session.
      */
     id: string;
   }
@@ -291,7 +289,7 @@ export namespace SetupIntentListResponse {
    */
   export interface Company {
     /**
-     * The ID (tag) of the company.
+     * The unique identifier for the company.
      */
     id: string;
   }
@@ -301,7 +299,7 @@ export namespace SetupIntentListResponse {
    */
   export interface Member {
     /**
-     * The ID of the member
+     * The unique identifier for the company member.
      */
     id: string;
 
@@ -317,7 +315,7 @@ export namespace SetupIntentListResponse {
      */
     export interface User {
       /**
-       * The internal ID of the user account.
+       * The unique identifier for the company member user.
        */
       id: string;
 
@@ -343,7 +341,7 @@ export namespace SetupIntentListResponse {
    */
   export interface PaymentMethod {
     /**
-     * The ID of the payment method
+     * The unique identifier for the payment token.
      */
     id: string;
 
@@ -353,7 +351,7 @@ export namespace SetupIntentListResponse {
     card: PaymentMethod.Card | null;
 
     /**
-     * The date and time the payment method was created
+     * The datetime the payment token was created.
      */
     created_at: string;