@whop/sdk 0.0.26 → 0.0.28

package/resources/promo-codes.d.mts

@@ -5,7 +5,8 @@ import { CursorPage, type CursorPageParams, PagePromise } from "../core/paginati
 import { RequestOptions } from "../internal/request-options.mjs";
 export declare class PromoCodes extends APIResource {
     /**
-     * Create a new promo code for a product or plan
+     * Create a new promo code that applies a discount at checkout. Can be scoped to
+     * specific products or plans.
      *
      * Required permissions:
      *
@@ -27,7 +28,7 @@ export declare class PromoCodes extends APIResource {
      */
     create(body: PromoCodeCreateParams, options?: RequestOptions): APIPromise<PromoCode>;
     /**
-     * Retrieves a promo code by ID
+     * Retrieves the details of an existing promo code.
      *
      * Required permissions:
      *
@@ -43,7 +44,8 @@ export declare class PromoCodes extends APIResource {
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<PromoCode>;
     /**
-     * Lists promo codes for a company
+     * Returns a paginated list of promo codes belonging to a company, with optional
+     * filtering by product, plan, and status.
      *
      * Required permissions:
      *
@@ -62,7 +64,8 @@ export declare class PromoCodes extends APIResource {
      */
     list(query: PromoCodeListParams, options?: RequestOptions): PagePromise<PromoCodeListResponsesCursorPage, PromoCodeListResponse>;
     /**
-     * Archive a promo code, preventing further use
+     * Archive a promo code, preventing it from being used in future checkouts.
+     * Existing memberships are not affected.
      *
      * Required permissions:
      *
@@ -79,15 +82,19 @@ export declare 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;
     /**
@@ -103,7 +110,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;
     /**
@@ -166,7 +173,7 @@ export declare namespace PromoCode {
      */
     interface Company {
         /**
-         * The ID of the company
+         * The unique identifier for the company.
          */
         id: string;
         /**
@@ -179,11 +186,12 @@ export declare namespace PromoCode {
      */
     interface Product {
         /**
-         * The internal ID of the public product.
+         * The unique identifier for the product.
          */
         id: string;
         /**
-         * The title of the product. Use for Whop 4.0.
+         * The display name of the product shown to customers on the product page and in
+         * search results.
          */
         title: string;
     }
@@ -197,15 +205,19 @@ 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;
     /**
@@ -217,7 +229,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;
     /**
@@ -280,11 +292,12 @@ export declare namespace PromoCodeListResponse {
      */
     interface Product {
         /**
-         * The internal ID of the public product.
+         * The unique identifier for the product.
          */
         id: string;
         /**
-         * The title of the product. Use for Whop 4.0.
+         * The display name of the product shown to customers on the product page and in
+         * search results.
          */
         title: string;
     }
@@ -295,72 +308,79 @@ export declare namespace PromoCodeListResponse {
 export type PromoCodeDeleteResponse = boolean;
 export interface PromoCodeCreateParams {
     /**
-     * The amount off (% or flat amount) for the promo.
+     * The discount amount. When promo_type is percentage, this is the percent off
+     * (e.g., 20 for 20% off). When promo_type is flat_amount, this is the currency
+     * amount off (e.g., 10.00 for $10.00 off).
      */
     amount_off: number;
     /**
-     * The monetary currency of the promo code.
+     * The three-letter ISO currency code for the promo code discount.
      */
     base_currency: Shared.Currency;
     /**
-     * The specific code used to apply the promo at checkout.
+     * The alphanumeric code customers enter at checkout to apply the discount.
      */
     code: string;
     /**
-     * The id of the company to create the promo code for.
+     * The unique identifier of the company to create this promo code for.
      */
     company_id: string;
     /**
-     * Restricts promo use to only users who have never purchased from the company
-     * before.
+     * Whether to restrict this promo code to only users who have never purchased from
+     * the company before.
      */
     new_users_only: boolean;
     /**
-     * The number of months this promo code is applied and valid for.
+     * The number of billing months the discount remains active. For example, 3 means
+     * the discount applies to the first 3 billing cycles.
      */
     promo_duration_months: number;
     /**
-     * The type (% or flat amount) of the promo.
+     * The discount type, either percentage or flat_amount.
      */
     promo_type: Shared.PromoType;
     /**
-     * Restricts promo use to only users who have churned from the company before.
+     * Whether to restrict this promo code to only users who have previously churned
+     * from the company.
      */
     churned_users_only?: boolean | null;
     /**
-     * Whether this promo code is for existing memberships only (cancelations)
+     * Whether this promo code can only be applied to existing memberships, such as for
+     * cancellation retention offers.
      */
     existing_memberships_only?: boolean | null;
     /**
-     * The date/time of when the promo expires.
+     * The datetime when the promo code expires and can no longer be used. Null means
+     * it never expires.
      */
     expires_at?: string | null;
     /**
-     * Restricts promo use to only be applied once per customer.
+     * Whether each customer can only use this promo code once.
      */
     one_per_customer?: boolean | null;
     /**
-     * The IDs of the plans that the promo code applies to. If product_id is provided,
-     * it will only apply to plans attached to that product
+     * The identifiers of plans this promo code applies to. When product_id is also
+     * provided, only plans attached to that product are included.
      */
     plan_ids?: Array<string> | null;
     /**
-     * The product to lock the promo code to, if any. If provided will filter out any
-     * plan ids not attached to this product
+     * The identifier of the product to scope this promo code to. When provided, the
+     * promo code only applies to plans attached to this product.
      */
     product_id?: string | null;
     /**
-     * The quantity limit on the number of uses.
+     * The maximum number of times this promo code can be used. Ignored when
+     * unlimited_stock is true.
      */
     stock?: number | null;
     /**
-     * Whether or not the promo code should have unlimited stock.
+     * Whether the promo code can be used an unlimited number of times.
      */
     unlimited_stock?: boolean | null;
 }
 export interface PromoCodeListParams extends CursorPageParams {
     /**
-     * The ID of the company to list promo codes for
+     * The unique identifier of the company to list promo codes for.
      */
     company_id: string;
     /**
@@ -368,11 +388,11 @@ export interface PromoCodeListParams extends CursorPageParams {
      */
     before?: string | null;
     /**
-     * The minimum creation date to filter by
+     * Only return promo codes created after this timestamp.
      */
     created_after?: string | null;
     /**
-     * The maximum creation date to filter by
+     * Only return promo codes created before this timestamp.
      */
     created_before?: string | null;
     /**
@@ -384,11 +404,11 @@ export interface PromoCodeListParams extends CursorPageParams {
      */
     last?: number | null;
     /**
-     * Filter promo codes by plan ID(s)
+     * Filter to only promo codes scoped to these plan identifiers.
      */
     plan_ids?: Array<string> | null;
     /**
-     * Filter promo codes by product ID(s)
+     * Filter to only promo codes scoped to these product identifiers.
      */
     product_ids?: Array<string> | null;
     /**

package/resources/promo-codes.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"promo-codes.d.mts","sourceRoot":"","sources":["../src/resources/promo-codes.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC;IAIpF;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC;IAIrE;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CACF,KAAK,EAAE,mBAAmB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,gCAAgC,EAAE,qBAAqB,CAAC;IAIvE;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;CAGlF;AAED,MAAM,MAAM,gCAAgC,GAAG,UAAU,CAAC,qBAAqB,CAAC,CAAC;AAEjF;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,kBAAkB,EAAE,OAAO,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,OAAO,EAAE,SAAS,CAAC,OAAO,CAAC;IAE3B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;IAE1B;;OAEG;IACH,QAAQ,EAAE,aAAa,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,yBAAyB,EAAE,OAAO,CAAC;IAEnC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,cAAc,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,OAAO,EAAE,SAAS,CAAC,OAAO,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC;IAE7B;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC;IAExB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,yBAAiB,SAAS,CAAC;IACzB;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,QAAQ,GAAG,UAAU,GAAG,UAAU,CAAC;AAEjE;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG,MAAM,GAAG,WAAW,CAAC;AAE7D;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,kBAAkB,EAAE,OAAO,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;IAE1B;;OAEG;IACH,QAAQ,EAAE,aAAa,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,yBAAyB,EAAE,OAAO,CAAC;IAEnC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,cAAc,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,OAAO,EAAE,qBAAqB,CAAC,OAAO,GAAG,IAAI,CAAC;IAE9C;;OAEG;IACH,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC;IAE7B;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC;IAExB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,OAAO,CAAC;AAE9C,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC,QAAQ,CAAC;IAE/B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,cAAc,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC;IAE7B;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,yBAAyB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEhC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAClC;AAED,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC3D;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,MAAM,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
+{"version":3,"file":"promo-codes.d.mts","sourceRoot":"","sources":["../src/resources/promo-codes.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC;IAIpF;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC;IAIrE;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,CACF,KAAK,EAAE,mBAAmB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,gCAAgC,EAAE,qBAAqB,CAAC;IAIvE;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;CAGlF;AAED,MAAM,MAAM,gCAAgC,GAAG,UAAU,CAAC,qBAAqB,CAAC,CAAC;AAEjF;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,kBAAkB,EAAE,OAAO,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,OAAO,EAAE,SAAS,CAAC,OAAO,CAAC;IAE3B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;IAE1B;;OAEG;IACH,QAAQ,EAAE,aAAa,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,yBAAyB,EAAE,OAAO,CAAC;IAEnC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,cAAc,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,OAAO,EAAE,SAAS,CAAC,OAAO,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC;IAE7B;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC;IAExB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,yBAAiB,SAAS,CAAC;IACzB;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,QAAQ,GAAG,UAAU,GAAG,UAAU,CAAC;AAEjE;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG,MAAM,GAAG,WAAW,CAAC;AAE7D;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,kBAAkB,EAAE,OAAO,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;IAE1B;;OAEG;IACH,QAAQ,EAAE,aAAa,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,yBAAyB,EAAE,OAAO,CAAC;IAEnC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,cAAc,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,OAAO,EAAE,qBAAqB,CAAC,OAAO,GAAG,IAAI,CAAC;IAE9C;;OAEG;IACH,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC;IAE7B;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC;IAExB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,OAAO,CAAC;AAE9C,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC,QAAQ,CAAC;IAE/B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,cAAc,EAAE,OAAO,CAAC;IAExB;;;OAGG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC;IAE7B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEpC;;;OAGG;IACH,yBAAyB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE3C;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEhC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAClC;AAED,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC3D;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,MAAM,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}

package/resources/promo-codes.d.ts

@@ -5,7 +5,8 @@ import { CursorPage, type CursorPageParams, PagePromise } from "../core/paginati
 import { RequestOptions } from "../internal/request-options.js";
 export declare class PromoCodes extends APIResource {
     /**
-     * Create a new promo code for a product or plan
+     * Create a new promo code that applies a discount at checkout. Can be scoped to
+     * specific products or plans.
      *
      * Required permissions:
      *
@@ -27,7 +28,7 @@ export declare class PromoCodes extends APIResource {
      */
     create(body: PromoCodeCreateParams, options?: RequestOptions): APIPromise<PromoCode>;
     /**
-     * Retrieves a promo code by ID
+     * Retrieves the details of an existing promo code.
      *
      * Required permissions:
      *
@@ -43,7 +44,8 @@ export declare class PromoCodes extends APIResource {
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<PromoCode>;
     /**
-     * Lists promo codes for a company
+     * Returns a paginated list of promo codes belonging to a company, with optional
+     * filtering by product, plan, and status.
      *
      * Required permissions:
      *
@@ -62,7 +64,8 @@ export declare class PromoCodes extends APIResource {
      */
     list(query: PromoCodeListParams, options?: RequestOptions): PagePromise<PromoCodeListResponsesCursorPage, PromoCodeListResponse>;
     /**
-     * Archive a promo code, preventing further use
+     * Archive a promo code, preventing it from being used in future checkouts.
+     * Existing memberships are not affected.
      *
      * Required permissions:
      *
@@ -79,15 +82,19 @@ export declare 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;
     /**
@@ -103,7 +110,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;
     /**
@@ -166,7 +173,7 @@ export declare namespace PromoCode {
      */
     interface Company {
         /**
-         * The ID of the company
+         * The unique identifier for the company.
          */
         id: string;
         /**
@@ -179,11 +186,12 @@ export declare namespace PromoCode {
      */
     interface Product {
         /**
-         * The internal ID of the public product.
+         * The unique identifier for the product.
          */
         id: string;
         /**
-         * The title of the product. Use for Whop 4.0.
+         * The display name of the product shown to customers on the product page and in
+         * search results.
          */
         title: string;
     }
@@ -197,15 +205,19 @@ 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;
     /**
@@ -217,7 +229,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;
     /**
@@ -280,11 +292,12 @@ export declare namespace PromoCodeListResponse {
      */
     interface Product {
         /**
-         * The internal ID of the public product.
+         * The unique identifier for the product.
          */
         id: string;
         /**
-         * The title of the product. Use for Whop 4.0.
+         * The display name of the product shown to customers on the product page and in
+         * search results.
          */
         title: string;
     }
@@ -295,72 +308,79 @@ export declare namespace PromoCodeListResponse {
 export type PromoCodeDeleteResponse = boolean;
 export interface PromoCodeCreateParams {
     /**
-     * The amount off (% or flat amount) for the promo.
+     * The discount amount. When promo_type is percentage, this is the percent off
+     * (e.g., 20 for 20% off). When promo_type is flat_amount, this is the currency
+     * amount off (e.g., 10.00 for $10.00 off).
      */
     amount_off: number;
     /**
-     * The monetary currency of the promo code.
+     * The three-letter ISO currency code for the promo code discount.
      */
     base_currency: Shared.Currency;
     /**
-     * The specific code used to apply the promo at checkout.
+     * The alphanumeric code customers enter at checkout to apply the discount.
      */
     code: string;
     /**
-     * The id of the company to create the promo code for.
+     * The unique identifier of the company to create this promo code for.
      */
     company_id: string;
     /**
-     * Restricts promo use to only users who have never purchased from the company
-     * before.
+     * Whether to restrict this promo code to only users who have never purchased from
+     * the company before.
      */
     new_users_only: boolean;
     /**
-     * The number of months this promo code is applied and valid for.
+     * The number of billing months the discount remains active. For example, 3 means
+     * the discount applies to the first 3 billing cycles.
      */
     promo_duration_months: number;
     /**
-     * The type (% or flat amount) of the promo.
+     * The discount type, either percentage or flat_amount.
      */
     promo_type: Shared.PromoType;
     /**
-     * Restricts promo use to only users who have churned from the company before.
+     * Whether to restrict this promo code to only users who have previously churned
+     * from the company.
      */
     churned_users_only?: boolean | null;
     /**
-     * Whether this promo code is for existing memberships only (cancelations)
+     * Whether this promo code can only be applied to existing memberships, such as for
+     * cancellation retention offers.
      */
     existing_memberships_only?: boolean | null;
     /**
-     * The date/time of when the promo expires.
+     * The datetime when the promo code expires and can no longer be used. Null means
+     * it never expires.
      */
     expires_at?: string | null;
     /**
-     * Restricts promo use to only be applied once per customer.
+     * Whether each customer can only use this promo code once.
      */
     one_per_customer?: boolean | null;
     /**
-     * The IDs of the plans that the promo code applies to. If product_id is provided,
-     * it will only apply to plans attached to that product
+     * The identifiers of plans this promo code applies to. When product_id is also
+     * provided, only plans attached to that product are included.
      */
     plan_ids?: Array<string> | null;
     /**
-     * The product to lock the promo code to, if any. If provided will filter out any
-     * plan ids not attached to this product
+     * The identifier of the product to scope this promo code to. When provided, the
+     * promo code only applies to plans attached to this product.
      */
     product_id?: string | null;
     /**
-     * The quantity limit on the number of uses.
+     * The maximum number of times this promo code can be used. Ignored when
+     * unlimited_stock is true.
      */
     stock?: number | null;
     /**
-     * Whether or not the promo code should have unlimited stock.
+     * Whether the promo code can be used an unlimited number of times.
      */
     unlimited_stock?: boolean | null;
 }
 export interface PromoCodeListParams extends CursorPageParams {
     /**
-     * The ID of the company to list promo codes for
+     * The unique identifier of the company to list promo codes for.
      */
     company_id: string;
     /**
@@ -368,11 +388,11 @@ export interface PromoCodeListParams extends CursorPageParams {
      */
     before?: string | null;
     /**
-     * The minimum creation date to filter by
+     * Only return promo codes created after this timestamp.
      */
     created_after?: string | null;
     /**
-     * The maximum creation date to filter by
+     * Only return promo codes created before this timestamp.
      */
     created_before?: string | null;
     /**
@@ -384,11 +404,11 @@ export interface PromoCodeListParams extends CursorPageParams {
      */
     last?: number | null;
     /**
-     * Filter promo codes by plan ID(s)
+     * Filter to only promo codes scoped to these plan identifiers.
      */
     plan_ids?: Array<string> | null;
     /**
-     * Filter promo codes by product ID(s)
+     * Filter to only promo codes scoped to these product identifiers.
      */
     product_ids?: Array<string> | null;
     /**

package/resources/promo-codes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"promo-codes.d.ts","sourceRoot":"","sources":["../src/resources/promo-codes.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC;IAIpF;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC;IAIrE;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CACF,KAAK,EAAE,mBAAmB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,gCAAgC,EAAE,qBAAqB,CAAC;IAIvE;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;CAGlF;AAED,MAAM,MAAM,gCAAgC,GAAG,UAAU,CAAC,qBAAqB,CAAC,CAAC;AAEjF;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,kBAAkB,EAAE,OAAO,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,OAAO,EAAE,SAAS,CAAC,OAAO,CAAC;IAE3B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;IAE1B;;OAEG;IACH,QAAQ,EAAE,aAAa,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,yBAAyB,EAAE,OAAO,CAAC;IAEnC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,cAAc,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,OAAO,EAAE,SAAS,CAAC,OAAO,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC;IAE7B;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC;IAExB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,yBAAiB,SAAS,CAAC;IACzB;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,QAAQ,GAAG,UAAU,GAAG,UAAU,CAAC;AAEjE;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG,MAAM,GAAG,WAAW,CAAC;AAE7D;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,kBAAkB,EAAE,OAAO,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;IAE1B;;OAEG;IACH,QAAQ,EAAE,aAAa,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,yBAAyB,EAAE,OAAO,CAAC;IAEnC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,cAAc,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,OAAO,EAAE,qBAAqB,CAAC,OAAO,GAAG,IAAI,CAAC;IAE9C;;OAEG;IACH,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC;IAE7B;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC;IAExB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,OAAO,CAAC;AAE9C,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC,QAAQ,CAAC;IAE/B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,cAAc,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC;IAE7B;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,yBAAyB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEhC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAClC;AAED,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC3D;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,MAAM,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
+{"version":3,"file":"promo-codes.d.ts","sourceRoot":"","sources":["../src/resources/promo-codes.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC;IAIpF;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC;IAIrE;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,CACF,KAAK,EAAE,mBAAmB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,gCAAgC,EAAE,qBAAqB,CAAC;IAIvE;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;CAGlF;AAED,MAAM,MAAM,gCAAgC,GAAG,UAAU,CAAC,qBAAqB,CAAC,CAAC;AAEjF;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,kBAAkB,EAAE,OAAO,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,OAAO,EAAE,SAAS,CAAC,OAAO,CAAC;IAE3B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;IAE1B;;OAEG;IACH,QAAQ,EAAE,aAAa,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,yBAAyB,EAAE,OAAO,CAAC;IAEnC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,cAAc,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,OAAO,EAAE,SAAS,CAAC,OAAO,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC;IAE7B;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC;IAExB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,yBAAiB,SAAS,CAAC;IACzB;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,QAAQ,GAAG,UAAU,GAAG,UAAU,CAAC;AAEjE;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG,MAAM,GAAG,WAAW,CAAC;AAE7D;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,kBAAkB,EAAE,OAAO,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;IAE1B;;OAEG;IACH,QAAQ,EAAE,aAAa,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,yBAAyB,EAAE,OAAO,CAAC;IAEnC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,cAAc,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,OAAO,EAAE,qBAAqB,CAAC,OAAO,GAAG,IAAI,CAAC;IAE9C;;OAEG;IACH,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC;IAE7B;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC;IAExB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,OAAO,CAAC;AAE9C,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC,QAAQ,CAAC;IAE/B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,cAAc,EAAE,OAAO,CAAC;IAExB;;;OAGG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC;IAE7B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEpC;;;OAGG;IACH,yBAAyB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE3C;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEhC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAClC;AAED,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC3D;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,MAAM,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}

package/resources/promo-codes.js

@@ -7,7 +7,8 @@ const pagination_1 = require("../core/pagination.js");
 const path_1 = require("../internal/utils/path.js");
 class PromoCodes extends resource_1.APIResource {
     /**
-     * Create a new promo code for a product or plan
+     * Create a new promo code that applies a discount at checkout. Can be scoped to
+     * specific products or plans.
      *
      * Required permissions:
      *
@@ -31,7 +32,7 @@ class PromoCodes extends resource_1.APIResource {
         return this._client.post('/promo_codes', { body, ...options });
     }
     /**
-     * Retrieves a promo code by ID
+     * Retrieves the details of an existing promo code.
      *
      * Required permissions:
      *
@@ -49,7 +50,8 @@ class PromoCodes extends resource_1.APIResource {
         return this._client.get((0, path_1.path) `/promo_codes/${id}`, options);
     }
     /**
-     * Lists promo codes for a company
+     * Returns a paginated list of promo codes belonging to a company, with optional
+     * filtering by product, plan, and status.
      *
      * Required permissions:
      *
@@ -70,7 +72,8 @@ class PromoCodes extends resource_1.APIResource {
         return this._client.getAPIList('/promo_codes', (pagination_1.CursorPage), { query, ...options });
     }
     /**
-     * Archive a promo code, preventing further use
+     * Archive a promo code, preventing it from being used in future checkouts.
+     * Existing memberships are not affected.
      *
      * Required permissions:
      *

package/resources/promo-codes.js.map

@@ -1 +1 @@
-{"version":3,"file":"promo-codes.js","sourceRoot":"","sources":["../src/resources/promo-codes.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,UAAW,SAAQ,sBAAW;IACzC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,IAA2B,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CACF,KAA0B,EAC1B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,EAAE,CAAA,uBAAiC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3G,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;CACF;AAvFD,gCAuFC"}
+{"version":3,"file":"promo-codes.js","sourceRoot":"","sources":["../src/resources/promo-codes.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,UAAW,SAAQ,sBAAW;IACzC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CAAC,IAA2B,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,CACF,KAA0B,EAC1B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,EAAE,CAAA,uBAAiC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3G,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;CACF;AA1FD,gCA0FC"}