@whop/sdk 0.0.25 → 0.0.27

package/resources/shared.d.ts

@@ -1,6 +1,7 @@
 import * as Shared from "./shared.js";
 import * as AppsAPI from "./apps.js";
 import * as CheckoutConfigurationsAPI from "./checkout-configurations.js";
+import * as MembershipsAPI from "./memberships.js";
 import * as PaymentsAPI from "./payments.js";
 import { CursorPage } from "../core/pagination.js";
 /**
@@ -13,11 +14,12 @@ export type AccessLevel = 'no_access' | 'admin' | 'customer';
  */
 export type AccessPassType = 'regular' | 'app' | 'experience_upsell' | 'api_only';
 /**
- * An object representing an app
+ * An app is an integration built on Whop. Apps can serve consumers as experiences
+ * within products, or serve companies as business tools.
  */
 export interface App {
     /**
-     * The ID of the app
+     * The unique identifier for the app.
      */
     id: string;
     /**
@@ -103,7 +105,7 @@ export declare namespace App {
      */
     interface APIKey {
         /**
-         * The ID of this API key
+         * The unique identifier for the private api key.
          */
         id: string;
         /**
@@ -111,7 +113,7 @@ export declare namespace App {
          */
         token: string;
         /**
-         * When this API key was created at
+         * The datetime the private api key was created.
          */
         created_at: string;
     }
@@ -120,7 +122,7 @@ export declare namespace App {
      */
     interface Company {
         /**
-         * The ID (tag) of the company.
+         * The unique identifier for the company.
          */
         id: string;
         /**
@@ -133,7 +135,7 @@ export declare namespace App {
      */
     interface Creator {
         /**
-         * The internal ID of the user.
+         * The unique identifier for the user.
          */
         id: string;
         /**
@@ -219,7 +221,7 @@ export declare namespace App {
  */
 export interface AppBuild {
     /**
-     * The ID of the app build. It will look like apbu_xxxxx.
+     * The unique identifier for the app build.
      */
     id: string;
     /**
@@ -228,7 +230,7 @@ export interface AppBuild {
      */
     checksum: string;
     /**
-     * When this app build was created.
+     * The datetime the app build was created.
      */
     created_at: string;
     /**
@@ -325,7 +327,7 @@ export declare namespace ChatChannel {
      */
     interface Experience {
         /**
-         * The unique ID representing this experience
+         * The unique identifier for the experience.
          */
         id: string;
         /**
@@ -335,14 +337,13 @@ export declare namespace ChatChannel {
     }
 }
 /**
- * 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 CheckoutConfiguration {
     /**
-     * The ID of the checkout configuration
+     * The unique identifier for the checkout session.
      */
     id: string;
     /**
@@ -418,11 +419,11 @@ export declare namespace CheckoutConfiguration {
      */
     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;
         /**
@@ -430,11 +431,14 @@ export declare namespace CheckoutConfiguration {
          */
         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;
         /**
@@ -446,7 +450,8 @@ export declare namespace CheckoutConfiguration {
          */
         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;
         /**
@@ -464,11 +469,12 @@ export declare namespace CheckoutConfiguration {
  */
 export type CollectionMethod = 'send_invoice' | 'charge_automatically';
 /**
- * An object representing a (sanitized) company.
+ * A company is a seller on Whop. Companies own products, manage members, and
+ * receive payouts.
  */
 export interface Company {
     /**
-     * The ID (tag) of the company.
+     * The unique identifier for the company.
      */
     id: string;
     /**
@@ -476,7 +482,7 @@ export interface Company {
      */
     business_type: BusinessTypes | null;
     /**
-     * When the company was created (signed up)
+     * The datetime the company was created.
      */
     created_at: string;
     /**
@@ -527,7 +533,7 @@ export interface Company {
      */
     title: string;
     /**
-     * The time the company was last updated.
+     * The datetime the company was last updated.
      */
     updated_at: string;
     /**
@@ -551,7 +557,7 @@ export declare namespace Company {
      */
     interface OwnerUser {
         /**
-         * The internal ID of the user.
+         * The unique identifier for the user.
          */
         id: string;
         /**
@@ -568,7 +574,7 @@ export declare namespace Company {
      */
     interface SocialLink {
         /**
-         * The ID
+         * The unique identifier for the social link.
          */
         id: string;
         /**
@@ -586,7 +592,7 @@ export declare namespace Company {
  */
 export interface CourseLessonInteraction {
     /**
-     * The ID of the lesson interaction
+     * The unique identifier for the lesson interaction.
      */
     id: string;
     /**
@@ -598,7 +604,7 @@ export interface CourseLessonInteraction {
      */
     course: CourseLessonInteraction.Course;
     /**
-     * When the interaction was created
+     * The datetime the lesson interaction was created.
      */
     created_at: string;
     /**
@@ -616,7 +622,7 @@ export declare namespace CourseLessonInteraction {
      */
     interface Course {
         /**
-         * The ID of the course. Looks like cors_XXX
+         * The unique identifier for the course.
          */
         id: string;
         /**
@@ -634,7 +640,7 @@ export declare namespace CourseLessonInteraction {
          */
         interface Experience {
             /**
-             * The unique ID representing this experience
+             * The unique identifier for the experience.
              */
             id: string;
         }
@@ -644,7 +650,7 @@ export declare namespace CourseLessonInteraction {
      */
     interface Lesson {
         /**
-         * The ID of the lesson
+         * The unique identifier for the lesson.
          */
         id: string;
         /**
@@ -662,7 +668,7 @@ export declare namespace CourseLessonInteraction {
          */
         interface Chapter {
             /**
-             * The ID of the chapter. Looks like chap_XXX
+             * The unique identifier for the chapter.
              */
             id: string;
         }
@@ -672,7 +678,7 @@ export declare namespace CourseLessonInteraction {
      */
     interface User {
         /**
-         * The internal ID of the user.
+         * The unique identifier for the user.
          */
         id: string;
         /**
@@ -690,7 +696,7 @@ export declare namespace CourseLessonInteraction {
  */
 export interface CourseLessonInteractionListItem {
     /**
-     * The ID of the lesson interaction
+     * The unique identifier for the lesson interaction.
      */
     id: string;
     /**
@@ -698,7 +704,7 @@ export interface CourseLessonInteractionListItem {
      */
     completed: boolean;
     /**
-     * When the interaction was created
+     * The datetime the lesson interaction was created.
      */
     created_at: string;
     /**
@@ -716,7 +722,7 @@ export declare namespace CourseLessonInteractionListItem {
      */
     interface Lesson {
         /**
-         * The ID of the lesson
+         * The unique identifier for the lesson.
          */
         id: string;
         /**
@@ -734,7 +740,7 @@ export declare namespace CourseLessonInteractionListItem {
          */
         interface Chapter {
             /**
-             * The ID of the chapter. Looks like chap_XXX
+             * The unique identifier for the chapter.
              */
             id: string;
         }
@@ -744,7 +750,7 @@ export declare namespace CourseLessonInteractionListItem {
      */
     interface User {
         /**
-         * The internal ID of the user.
+         * The unique identifier for the user.
          */
         id: string;
         /**
@@ -778,15 +784,15 @@ export type DmsPostTypes = 'regular' | 'system' | 'automated';
  */
 export type EmailNotificationPreferences = 'all_admin_posts' | 'only_weekly_summary' | 'none';
 /**
- * An object representing an entry in a waitlist.
+ * An entry represents a user's signup for a waitlisted plan.
  */
 export interface Entry {
     /**
-     * The internal ID of the entry.
+     * The unique identifier for the entry.
      */
     id: string;
     /**
-     * When the entry was created.
+     * The datetime the entry was created.
      */
     created_at: string | null;
     /**
@@ -816,7 +822,7 @@ export declare namespace Entry {
      */
     interface CustomFieldResponse {
         /**
-         * The ID of the custom field item
+         * The unique identifier for the custom field response.
          */
         id: string;
         /**
@@ -833,7 +839,7 @@ export declare namespace Entry {
      */
     interface Plan {
         /**
-         * The internal ID of the plan.
+         * The unique identifier for the plan.
          */
         id: string;
     }
@@ -842,7 +848,7 @@ export declare namespace Entry {
      */
     interface Product {
         /**
-         * The internal ID of the public product.
+         * The unique identifier for the product.
          */
         id: string;
         /**
@@ -855,7 +861,7 @@ export declare namespace Entry {
      */
     interface User {
         /**
-         * The internal ID of the user.
+         * The unique identifier for the user.
          */
         id: string;
         /**
@@ -877,11 +883,12 @@ export declare namespace Entry {
  */
 export type EntryStatus = 'drafted' | 'pending' | 'approved' | 'denied' | 'any';
 /**
- * An object representing an experience belonging to a company.
+ * An experience is a feature or content module within a product, such as a chat,
+ * course, or app.
  */
 export interface Experience {
     /**
-     * The unique ID representing this experience
+     * The unique identifier for the experience.
      */
     id: string;
     /**
@@ -893,7 +900,7 @@ export interface Experience {
      */
     company: Experience.Company;
     /**
-     * The timestamp of when this experience was created.
+     * The datetime the experience was created.
      */
     created_at: string;
     /**
@@ -925,7 +932,7 @@ export declare namespace Experience {
      */
     interface App {
         /**
-         * The ID of the app
+         * The unique identifier for the app.
          */
         id: string;
         /**
@@ -956,7 +963,7 @@ export declare namespace Experience {
      */
     interface Company {
         /**
-         * The ID (tag) of the company.
+         * The unique identifier for the company.
          */
         id: string;
         /**
@@ -979,11 +986,12 @@ export declare namespace Experience {
         url: string | null;
     }
     /**
-     * Represents a product on whop. Use products to sell anything on the platform.
+     * A product is a digital good or service sold on Whop. Products contain plans for
+     * pricing and experiences for content delivery.
      */
     interface Product {
         /**
-         * The internal ID of the public product.
+         * The unique identifier for the product.
          */
         id: string;
         /**
@@ -1027,7 +1035,7 @@ export declare namespace Forum {
      */
     interface Experience {
         /**
-         * The unique ID representing this experience
+         * The unique identifier for the experience.
          */
         id: string;
         /**
@@ -1041,7 +1049,11 @@ export declare namespace Forum {
  */
 export interface ForumPost {
     /**
-     * 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;
     /**
@@ -1099,7 +1111,7 @@ export declare namespace ForumPost {
      */
     interface User {
         /**
-         * The internal ID of the user.
+         * The unique identifier for the user.
          */
         id: string;
         /**
@@ -1113,7 +1125,9 @@ export declare namespace ForumPost {
     }
 }
 /**
- * The friendly status of a receipt
+ * The friendly status of a payment. This is a derived status that provides a
+ * human-readable summary of the payment state, combining the underlying status and
+ * substatus fields.
  */
 export type FriendlyReceiptStatus = 'succeeded' | 'pending' | 'failed' | 'past_due' | 'canceled' | 'price_too_low' | 'uncollectible' | 'refunded' | 'auto_refunded' | 'partially_refunded' | 'dispute_warning' | 'dispute_needs_response' | 'dispute_warning_needs_response' | 'resolution_needs_response' | 'dispute_under_review' | 'dispute_warning_under_review' | 'resolution_under_review' | 'dispute_won' | 'dispute_warning_closed' | 'resolution_won' | 'dispute_lost' | 'dispute_closed' | 'resolution_lost' | 'drafted' | 'incomplete' | 'unresolved' | 'open_dispute' | 'open_resolution';
 /**
@@ -1129,11 +1143,11 @@ export type IndustryTypes = 'trading' | 'sports_betting' | 'reselling' | 'fitnes
  */
 export interface Invoice {
     /**
-     * The ID of the invoice.
+     * The unique identifier for the invoice.
      */
     id: string;
     /**
-     * The date the invoice was created.
+     * The datetime the invoice was created.
      */
     created_at: string;
     /**
@@ -1172,7 +1186,7 @@ export declare namespace Invoice {
      */
     interface CurrentPlan {
         /**
-         * The internal ID of the plan.
+         * The unique identifier for the plan.
          */
         id: string;
         /**
@@ -1189,7 +1203,7 @@ export declare namespace Invoice {
      */
     interface User {
         /**
-         * The internal ID of the user.
+         * The unique identifier for the user.
          */
         id: string;
         /**
@@ -1207,11 +1221,11 @@ export declare namespace Invoice {
  */
 export interface InvoiceListItem {
     /**
-     * The ID of the invoice.
+     * The unique identifier for the invoice.
      */
     id: string;
     /**
-     * The date the invoice was created.
+     * The datetime the invoice was created.
      */
     created_at: string;
     /**
@@ -1250,7 +1264,7 @@ export declare namespace InvoiceListItem {
      */
     interface CurrentPlan {
         /**
-         * The internal ID of the plan.
+         * The unique identifier for the plan.
          */
         id: string;
         /**
@@ -1267,7 +1281,7 @@ export declare namespace InvoiceListItem {
      */
     interface User {
         /**
-         * The internal ID of the user.
+         * The unique identifier for the user.
          */
         id: string;
         /**
@@ -1293,12 +1307,12 @@ export type MemberMostRecentActions = 'canceling' | 'churned' | 'finished_split_
  */
 export type MemberStatuses = 'drafted' | 'joined' | 'left';
 /**
- * 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 Membership {
     /**
-     * The ID of the membership
+     * The unique identifier for the membership.
      */
     id: string;
     /**
@@ -1310,7 +1324,7 @@ export interface Membership {
      * 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: MembershipsAPI.CancelOptions | null;
     /**
      * The epoch timestamp of when the customer initiated a cancellation.
      */
@@ -1324,7 +1338,7 @@ export interface Membership {
      */
     company: Membership.Company;
     /**
-     * The timestamp, in seconds, that this Membership was created at.
+     * The datetime the membership was created.
      */
     created_at: string;
     /**
@@ -1335,6 +1349,10 @@ export interface Membership {
      * The responses to custom checkout questions for this membership.
      */
     custom_field_responses: Array<Membership.CustomFieldResponse>;
+    /**
+     * 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.
@@ -1349,7 +1367,8 @@ export interface Membership {
      */
     member: Membership.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;
@@ -1385,7 +1404,7 @@ export interface Membership {
      */
     status: MembershipStatus;
     /**
-     * A timestamp of when the membership was last updated
+     * The datetime the membership was last updated.
      */
     updated_at: string;
     /**
@@ -1399,7 +1418,7 @@ export declare namespace Membership {
      */
     interface Company {
         /**
-         * The ID (tag) of the company.
+         * The unique identifier for the company.
          */
         id: string;
         /**
@@ -1412,7 +1431,7 @@ export declare namespace Membership {
      */
     interface CustomFieldResponse {
         /**
-         * The ID of the custom field item
+         * The unique identifier for the custom field response.
          */
         id: string;
         /**
@@ -1429,7 +1448,7 @@ export declare namespace Membership {
      */
     interface Member {
         /**
-         * The ID of the member
+         * The unique identifier for the member.
          */
         id: string;
     }
@@ -1438,7 +1457,7 @@ export declare namespace Membership {
      */
     interface Plan {
         /**
-         * The internal ID of the plan.
+         * The unique identifier for the plan.
          */
         id: string;
     }
@@ -1447,7 +1466,7 @@ export declare namespace Membership {
      */
     interface Product {
         /**
-         * The internal ID of the public product.
+         * The unique identifier for the product.
          */
         id: string;
         /**
@@ -1460,7 +1479,7 @@ export declare namespace Membership {
      */
     interface PromoCode {
         /**
-         * The ID of the promo.
+         * The unique identifier for the promo code.
          */
         id: string;
     }
@@ -1469,7 +1488,7 @@ export declare namespace Membership {
      */
     interface User {
         /**
-         * The internal ID of the user.
+         * The unique identifier for the user.
          */
         id: string;
         /**
@@ -1495,7 +1514,11 @@ export type MembershipStatus = 'trialing' | 'active' | 'past_due' | 'completed'
  */
 export interface Message {
     /**
-     * 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;
     /**
@@ -1563,7 +1586,7 @@ export declare namespace Message {
          */
         interface Option {
             /**
-             * The ID of the poll option
+             * The unique identifier for the poll option.
              */
             id: string;
             /**
@@ -1603,7 +1626,7 @@ export declare namespace Message {
      */
     interface User {
         /**
-         * The internal ID of the user.
+         * The unique identifier for the user.
          */
         id: string;
         /**
@@ -1638,17 +1661,22 @@ export interface PageInfo {
     start_cursor: string | null;
 }
 /**
- * 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 Payment {
     /**
-     * The payment ID
+     * The unique identifier for the payment.
      */
     id: string;
     /**
      * How much the payment is for after fees
      */
     amount_after_fees: number;
+    /**
+     * The application fee charged on this payment.
+     */
+    application_fee: Payment.ApplicationFee | null;
     /**
      * Whether this payment was auto refunded or not
      */
@@ -1674,7 +1702,7 @@ export interface Payment {
      */
     company: Payment.Company | null;
     /**
-     * The datetime the payment was created
+     * The datetime the payment was created.
      */
     created_at: string;
     /**
@@ -1790,6 +1818,35 @@ export interface Payment {
     voidable: boolean;
 }
 export declare namespace Payment {
+    /**
+     * The application fee charged on this payment.
+     */
+    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.
      */
@@ -1828,7 +1885,7 @@ export declare namespace Payment {
      */
     interface Company {
         /**
-         * The ID of the company
+         * The unique identifier for the company.
          */
         id: string;
         /**
@@ -1845,7 +1902,7 @@ export declare namespace Payment {
      */
     interface Member {
         /**
-         * The ID of the member
+         * The unique identifier for the company member.
          */
         id: string;
         /**
@@ -1858,7 +1915,7 @@ export declare namespace Payment {
      */
     interface Membership {
         /**
-         * The internal ID of the membership.
+         * The unique identifier for the membership.
          */
         id: string;
         /**
@@ -1871,7 +1928,7 @@ export declare namespace Payment {
      */
     interface PaymentMethod {
         /**
-         * The ID of the payment method
+         * The unique identifier for the payment token.
          */
         id: string;
         /**
@@ -1879,7 +1936,7 @@ export declare namespace Payment {
          */
         card: PaymentMethod.Card | null;
         /**
-         * The date and time the payment method was created
+         * The datetime the payment token was created.
          */
         created_at: string;
         /**
@@ -1915,7 +1972,7 @@ export declare namespace Payment {
      */
     interface Plan {
         /**
-         * The internal ID of the plan.
+         * The unique identifier for the plan.
          */
         id: string;
     }
@@ -1924,7 +1981,7 @@ export declare namespace Payment {
      */
     interface Product {
         /**
-         * The internal ID of the public product.
+         * The unique identifier for the product.
          */
         id: string;
         /**
@@ -1941,11 +1998,13 @@ export declare namespace Payment {
      */
     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;
         /**
@@ -1970,7 +2029,7 @@ export declare namespace Payment {
      */
     interface User {
         /**
-         * The internal ID of the user.
+         * The unique identifier for the user.
          */
         id: string;
         /**
@@ -1988,17 +2047,17 @@ export declare namespace Payment {
     }
 }
 /**
- * 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 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;
     /**
@@ -2010,7 +2069,7 @@ export interface Plan {
      */
     company: Plan.Company | null;
     /**
-     * When the plan was created.
+     * The datetime the plan was created.
      */
     created_at: string;
     /**
@@ -2026,11 +2085,14 @@ export interface Plan {
      */
     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;
     /**
@@ -2066,7 +2128,8 @@ export interface Plan {
      */
     release_method: 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;
     /**
@@ -2090,11 +2153,12 @@ export interface Plan {
      */
     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;
     /**
@@ -2108,7 +2172,7 @@ export declare namespace Plan {
      */
     interface Company {
         /**
-         * The ID (tag) of the company.
+         * The unique identifier for the company.
          */
         id: string;
         /**
@@ -2121,7 +2185,7 @@ export declare namespace Plan {
      */
     interface CustomField {
         /**
-         * The internal ID of the given custom field
+         * The unique identifier for the custom field.
          */
         id: string;
         /**
@@ -2150,7 +2214,7 @@ export declare namespace Plan {
      */
     interface Invoice {
         /**
-         * The ID of the invoice.
+         * The unique identifier for the invoice.
          */
         id: string;
     }
@@ -2182,7 +2246,7 @@ export declare namespace Plan {
      */
     interface Product {
         /**
-         * The internal ID of the public product.
+         * The unique identifier for the product.
          */
         id: string;
         /**
@@ -2196,11 +2260,12 @@ export declare namespace Plan {
  */
 export type PlanType = 'renewal' | 'one_time';
 /**
- * Represents a product on whop. Use products to sell anything on the platform.
+ * A product is a digital good or service sold on Whop. Products contain plans for
+ * pricing and experiences for content delivery.
  */
 export interface Product {
     /**
-     * The internal ID of the public product.
+     * The unique identifier for the product.
      */
     id: string;
     /**
@@ -2212,7 +2277,7 @@ export interface Product {
      */
     company: Product.Company;
     /**
-     * When the product was created.
+     * The datetime the product was created.
      */
     created_at: string;
     /**
@@ -2288,7 +2353,7 @@ export interface Product {
      */
     title: string;
     /**
-     * When the product was updated.
+     * The datetime the product was last updated.
      */
     updated_at: string;
     /**
@@ -2306,7 +2371,7 @@ export declare namespace Product {
      */
     interface Company {
         /**
-         * The ID (tag) of the company.
+         * The unique identifier for the company.
          */
         id: string;
         /**
@@ -2323,7 +2388,7 @@ export declare namespace Product {
      */
     interface OwnerUser {
         /**
-         * The internal ID of the user.
+         * The unique identifier for the user.
          */
         id: string;
         /**
@@ -2340,7 +2405,7 @@ export declare namespace Product {
      */
     interface ProductTaxCode {
         /**
-         * The internal ID of the product tax code.
+         * The unique identifier for the product tax code.
          */
         id: string;
         /**
@@ -2354,11 +2419,12 @@ export declare namespace Product {
     }
 }
 /**
- * Represents a product on whop. Use products to sell anything on the platform.
+ * A product is a digital good or service sold on Whop. Products contain plans for
+ * pricing and experiences for content delivery.
  */
 export interface ProductListItem {
     /**
-     * The internal ID of the public product.
+     * The unique identifier for the product.
      */
     id: string;
     /**
@@ -2366,7 +2432,7 @@ export interface ProductListItem {
      */
     business_type: BusinessTypes | null;
     /**
-     * When the product was created.
+     * The datetime the product was created.
      */
     created_at: string;
     /**
@@ -2400,7 +2466,7 @@ export interface ProductListItem {
      */
     title: string;
     /**
-     * When the product was updated.
+     * The datetime the product was last updated.
      */
     updated_at: string;
     /**
@@ -2443,7 +2509,7 @@ export declare namespace Reaction {
      */
     interface User {
         /**
-         * The internal ID of the user.
+         * The unique identifier for the user.
          */
         id: string;
         /**
@@ -2469,7 +2535,7 @@ export type ReleaseMethod = 'buy_now' | 'waitlist';
  */
 export interface Shipment {
     /**
-     * The ID of the shipment
+     * The unique identifier for the shipment.
      */
     id: string;
     /**
@@ -2477,7 +2543,7 @@ export interface Shipment {
      */
     carrier: ShipmentCarrier;
     /**
-     * The date and time the shipment was created
+     * The datetime the shipment was created.
      */
     created_at: string;
     /**
@@ -2505,7 +2571,7 @@ export interface Shipment {
      */
     tracking_code: string;
     /**
-     * The date and time the shipment was last updated
+     * The datetime the shipment was last updated.
      */
     updated_at: string;
 }
@@ -2515,7 +2581,7 @@ export declare namespace Shipment {
      */
     interface Payment {
         /**
-         * The payment ID
+         * The unique identifier for the payment.
          */
         id: string;
     }
@@ -2567,7 +2633,7 @@ export declare namespace SupportChannel {
      */
     interface CustomerUser {
         /**
-         * The internal ID of the user.
+         * The unique identifier for the user.
          */
         id: string;
         /**
@@ -2590,15 +2656,16 @@ export type TaxType = 'inclusive' | 'exclusive' | 'unspecified';
  */
 export interface Transfer {
     /**
-     * The unique identifier of the credit transaction transfer
+     * The unique identifier for the credit transaction transfer.
      */
     id: string;
     /**
-     * The amount of the credit transaction transfer
+     * The amount of the transfer. Provided as a number in the specified currency. Eg:
+     * 10.43 for $10.43 USD.
      */
     amount: number;
     /**
-     * The timestamp when the credit transaction transfer was created
+     * The datetime the credit transaction transfer was created.
      */
     created_at: string;
     /**
@@ -2618,7 +2685,8 @@ export interface Transfer {
      */
     fee_amount: number | null;
     /**
-     * A hash of metadata attached to the transfer
+     * Custom key-value pairs attached to the transfer. Max 50 keys, 500 chars per key,
+     * 5000 chars per value.
      */
     metadata: {
         [key: string]: unknown;
@@ -2638,11 +2706,12 @@ export interface Transfer {
 }
 export declare namespace Transfer {
     /**
-     * An object representing a (sanitized) user of the site.
+     * A user account on Whop. Contains profile information, identity details, and
+     * social connections.
      */
     interface User {
         /**
-         * The internal ID of the user.
+         * The unique identifier for the user.
          */
         id: string;
         /**
@@ -2659,11 +2728,12 @@ export declare namespace Transfer {
         username: string;
     }
     /**
-     * An object representing a (sanitized) company.
+     * A company is a seller on Whop. Companies own products, manage members, and
+     * receive payouts.
      */
     interface Company {
         /**
-         * The ID (tag) of the company.
+         * The unique identifier for the company.
          */
         id: string;
         /**
@@ -2680,11 +2750,12 @@ export declare namespace Transfer {
         typename: 'Company';
     }
     /**
-     * An object representing a (sanitized) user of the site.
+     * A user account on Whop. Contains profile information, identity details, and
+     * social connections.
      */
     interface User {
         /**
-         * The internal ID of the user.
+         * The unique identifier for the user.
          */
         id: string;
         /**
@@ -2701,11 +2772,12 @@ export declare namespace Transfer {
         username: string;
     }
     /**
-     * An object representing a (sanitized) company.
+     * A company is a seller on Whop. Companies own products, manage members, and
+     * receive payouts.
      */
     interface Company {
         /**
-         * The ID (tag) of the company.
+         * The unique identifier for the company.
          */
         id: string;
         /**