@whop/sdk 0.0.38 → 0.0.40

package/src/resources/payments.ts

@@ -13,39 +13,32 @@ import { path } from '../internal/utils/path';
  */
 export class Payments extends APIResource {
   /**
-   * Charge an existing member off-session using one of their stored payment methods.
-   * You can provide an existing plan, or create a new one in-line. This endpoint
-   * will respond with a payment object immediately, but the payment is processed
-   * asynchronously in the background. Use webhooks to be notified when the payment
-   * succeeds or fails.
+   * Returns a paginated list of payments for the actor in context, with optional
+   * filtering by product, plan, status, billing reason, currency, and creation date.
    *
    * Required permissions:
    *
-   * - `payment:charge`
-   * - `plan:create`
-   * - `access_pass:create`
-   * - `access_pass:update`
+   * - `payment:basic:read`
    * - `plan:basic:read`
    * - `access_pass:basic:read`
    * - `member:email:read`
    * - `member:basic:read`
    * - `member:phone:read`
    * - `promo_code:basic:read`
-   * - `payment:dispute:read`
-   * - `payment:resolution_center_case:read`
    *
    * @example
    * ```ts
-   * const payment = await client.payments.create({
-   *   company_id: 'biz_xxxxxxxxxxxxxx',
-   *   member_id: 'mber_xxxxxxxxxxxxx',
-   *   payment_method_id: 'pmt_xxxxxxxxxxxxxx',
-   *   plan: { currency: 'usd' },
-   * });
+   * // Automatically fetches more pages as needed.
+   * for await (const paymentListResponse of client.payments.list()) {
+   *   // ...
+   * }
    * ```
    */
-  create(body: PaymentCreateParams, options?: RequestOptions): APIPromise<Shared.Payment> {
-    return this._client.post('/payments', { body, ...options });
+  list(
+    query: PaymentListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<PaymentListResponsesCursorPage, PaymentListResponse> {
+    return this._client.getAPIList('/payments', CursorPage<PaymentListResponse>, { query, ...options });
   }
 
   /**
@@ -74,64 +67,6 @@ export class Payments extends APIResource {
     return this._client.get(path`/payments/${id}`, options);
   }
 
-  /**
-   * Returns a paginated list of payments for the actor in context, with optional
-   * filtering by product, plan, status, billing reason, currency, and creation date.
-   *
-   * Required permissions:
-   *
-   * - `payment:basic:read`
-   * - `plan:basic:read`
-   * - `access_pass:basic:read`
-   * - `member:email:read`
-   * - `member:basic:read`
-   * - `member:phone:read`
-   * - `promo_code:basic:read`
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const paymentListResponse of client.payments.list()) {
-   *   // ...
-   * }
-   * ```
-   */
-  list(
-    query: PaymentListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<PaymentListResponsesCursorPage, PaymentListResponse> {
-    return this._client.getAPIList('/payments', CursorPage<PaymentListResponse>, { query, ...options });
-  }
-
-  /**
-   * Returns the list of fees associated with a specific payment, including platform
-   * fees and processing fees.
-   *
-   * Required permissions:
-   *
-   * - `payment:basic:read`
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const paymentListFeesResponse of client.payments.listFees(
-   *   'pay_xxxxxxxxxxxxxx',
-   * )) {
-   *   // ...
-   * }
-   * ```
-   */
-  listFees(
-    id: string,
-    query: PaymentListFeesParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<PaymentListFeesResponsesCursorPage, PaymentListFeesResponse> {
-    return this._client.getAPIList(path`/payments/${id}/fees`, CursorPage<PaymentListFeesResponse>, {
-      query,
-      ...options,
-    });
-  }
-
   /**
    * Issue a full or partial refund for a payment. The refund is processed through
    * the original payment processor and the membership status is updated accordingly.
@@ -216,6 +151,71 @@ export class Payments extends APIResource {
   void(id: string, options?: RequestOptions): APIPromise<Shared.Payment> {
     return this._client.post(path`/payments/${id}/void`, options);
   }
+
+  /**
+   * Charge an existing member off-session using one of their stored payment methods.
+   * You can provide an existing plan, or create a new one in-line. This endpoint
+   * will respond with a payment object immediately, but the payment is processed
+   * asynchronously in the background. Use webhooks to be notified when the payment
+   * succeeds or fails.
+   *
+   * Required permissions:
+   *
+   * - `payment:charge`
+   * - `plan:create`
+   * - `access_pass:create`
+   * - `access_pass:update`
+   * - `plan:basic:read`
+   * - `access_pass:basic:read`
+   * - `member:email:read`
+   * - `member:basic:read`
+   * - `member:phone:read`
+   * - `promo_code:basic:read`
+   * - `payment:dispute:read`
+   * - `payment:resolution_center_case:read`
+   *
+   * @example
+   * ```ts
+   * const payment = await client.payments.create({
+   *   company_id: 'biz_xxxxxxxxxxxxxx',
+   *   member_id: 'mber_xxxxxxxxxxxxx',
+   *   payment_method_id: 'pmt_xxxxxxxxxxxxxx',
+   *   plan: { currency: 'usd' },
+   * });
+   * ```
+   */
+  create(body: PaymentCreateParams, options?: RequestOptions): APIPromise<Shared.Payment> {
+    return this._client.post('/payments', { body, ...options });
+  }
+
+  /**
+   * Returns the list of fees associated with a specific payment, including platform
+   * fees and processing fees.
+   *
+   * Required permissions:
+   *
+   * - `payment:basic:read`
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const paymentListFeesResponse of client.payments.listFees(
+   *   'pay_xxxxxxxxxxxxxx',
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  listFees(
+    id: string,
+    query: PaymentListFeesParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<PaymentListFeesResponsesCursorPage, PaymentListFeesResponse> {
+    return this._client.getAPIList(path`/payments/${id}/fees`, CursorPage<PaymentListFeesResponse>, {
+      query,
+      ...options,
+    });
+  }
 }
 
 export type PaymentListResponsesCursorPage = CursorPage<PaymentListResponse>;
@@ -299,8 +299,13 @@ export type PaymentMethodTypes =
   | 'bizum'
   | 'blik'
   | 'boleto'
+  | 'bre_b'
+  | 'ca_bank_transfer'
   | 'capchase_pay'
   | 'card'
+  | 'card_installments_three'
+  | 'card_installments_six'
+  | 'card_installments_twelve'
   | 'cashapp'
   | 'claritypay'
   | 'coinbase'
@@ -322,10 +327,12 @@ export type PaymentMethodTypes =
   | 'interac'
   | 'kakao_pay'
   | 'klarna'
+  | 'klarna_pay_now'
   | 'konbini'
   | 'kr_card'
   | 'kr_market'
   | 'kriya'
+  | 'kueski'
   | 'link'
   | 'mb_way'
   | 'm_pesa'
@@ -345,6 +352,7 @@ export type PaymentMethodTypes =
   | 'nz_bank_account'
   | 'oxxo'
   | 'p24'
+  | 'pago_efectivo'
   | 'pse'
   | 'pay_by_bank'
   | 'payco'
@@ -361,8 +369,10 @@ export type PaymentMethodTypes =
   | 'samsung_pay'
   | 'satispay'
   | 'scalapay'
+  | 'sencillito'
   | 'sepa_debit'
   | 'sequra'
+  | 'servipag'
   | 'sezzle'
   | 'shop_pay'
   | 'shopeepay'
@@ -379,7 +389,9 @@ export type PaymentMethodTypes =
   | 'us_bank_transfer'
   | 'venmo'
   | 'vipps'
+  | 'webpay'
   | 'wechat_pay'
+  | 'yape'
   | 'zip'
   | 'coinflow'
   | 'unknown';
@@ -436,6 +448,12 @@ export interface PaymentListResponse {
    */
   card_last4: string | null;
 
+  /**
+   * The ID of the checkout session/configuration that produced this payment, if any.
+   * Use this to map payments back to the checkout configuration that created them.
+   */
+  checkout_configuration_id: string | null;
+
   /**
    * The company for the payment.
    */
@@ -447,9 +465,9 @@ export interface PaymentListResponse {
   created_at: string;
 
   /**
-   * The available currencies on the platform
+   * The three-letter ISO currency code for this payment (e.g., 'usd', 'eur').
    */
-  currency: Shared.Currency | null;
+  currency: Shared.Currency;
 
   /**
    * When an alert came in that this transaction will be disputed
@@ -547,6 +565,11 @@ export interface PaymentListResponse {
    */
   retryable: boolean;
 
+  /**
+   * The three-letter ISO currency code for this payment (e.g., 'usd', 'eur').
+   */
+  settlement_currency: Shared.Currency;
+
   /**
    * The status of a receipt
    */
@@ -720,6 +743,11 @@ export namespace PaymentListResponse {
      */
     id: string;
 
+    /**
+     * The phone number associated with this membership.
+     */
+    phone_number: string | null;
+
     /**
      * The state of the membership.
      */
@@ -793,6 +821,12 @@ export namespace PaymentListResponse {
      * A personal description or notes section for the business.
      */
     internal_notes: string | null;
+
+    /**
+     * Custom key-value pairs stored on the plan. Included in webhook payloads for
+     * payment and membership events.
+     */
+    metadata: { [key: string]: unknown } | null;
   }
 
   /**
@@ -804,6 +838,12 @@ export namespace PaymentListResponse {
      */
     id: string;
 
+    /**
+     * Custom key-value pairs stored on the product. Included in webhook payloads for
+     * payment and membership events.
+     */
+    metadata: { [key: string]: unknown } | null;
+
     /**
      * The URL slug used in the product's public link (e.g., 'my-product' in
      * whop.com/company/my-product).
@@ -937,6 +977,114 @@ export interface PaymentListFeesResponse {
     | 'application_fee';
 }
 
+export interface PaymentListParams extends CursorPageParams {
+  /**
+   * Returns the elements in the list that come before the specified cursor.
+   */
+  before?: string | null;
+
+  /**
+   * Filter payments by their billing reason.
+   */
+  billing_reasons?: Array<BillingReasons> | null;
+
+  /**
+   * Only return payments from these checkout configurations.
+   */
+  checkout_configuration_ids?: Array<string> | null;
+
+  /**
+   * The unique identifier of the company to list payments for.
+   */
+  company_id?: string | null;
+
+  /**
+   * Only return payments created after this timestamp.
+   */
+  created_after?: string | null;
+
+  /**
+   * Only return payments created before this timestamp.
+   */
+  created_before?: string | null;
+
+  /**
+   * Filter payments by their currency code.
+   */
+  currencies?: Array<Shared.Currency> | null;
+
+  /**
+   * The direction of the sort.
+   */
+  direction?: Shared.Direction | null;
+
+  /**
+   * Returns the first _n_ elements from the list.
+   */
+  first?: number | null;
+
+  /**
+   * Whether to include payments with a zero amount.
+   */
+  include_free?: boolean | null;
+
+  /**
+   * Returns the last _n_ elements from the list.
+   */
+  last?: number | null;
+
+  /**
+   * The order to sort the results by.
+   */
+  order?: 'final_amount' | 'created_at' | 'paid_at' | null;
+
+  /**
+   * Filter payments to only those associated with these specific plan identifiers.
+   */
+  plan_ids?: Array<string> | null;
+
+  /**
+   * Filter payments to only those associated with these specific product
+   * identifiers.
+   */
+  product_ids?: Array<string> | null;
+
+  /**
+   * Search payments by user ID, membership ID, user email, name, or username. Email
+   * filtering requires the member:email:read permission.
+   */
+  query?: string | null;
+
+  /**
+   * Filter payments by their current status.
+   */
+  statuses?: Array<Shared.ReceiptStatus> | null;
+
+  /**
+   * Filter payments by their current substatus for more granular filtering.
+   */
+  substatuses?: Array<Shared.FriendlyReceiptStatus> | null;
+
+  /**
+   * Only return payments last updated after this timestamp.
+   */
+  updated_after?: string | null;
+
+  /**
+   * Only return payments last updated before this timestamp.
+   */
+  updated_before?: string | null;
+}
+
+export interface PaymentRefundParams {
+  /**
+   * The amount to refund. For multi-currency payments, this is in the charge
+   * currency (what the buyer paid). For single-currency, this is in the payment
+   * currency. If omitted, the full payment amount is refunded.
+   */
+  partial_amount?: number | null;
+}
+
 export type PaymentCreateParams =
   | PaymentCreateParams.CreatePaymentInputWithPlan
   | PaymentCreateParams.CreatePaymentInputWithPlanID;
@@ -1162,100 +1310,6 @@ export declare namespace PaymentCreateParams {
   }
 }
 
-export interface PaymentListParams extends CursorPageParams {
-  /**
-   * Returns the elements in the list that come before the specified cursor.
-   */
-  before?: string | null;
-
-  /**
-   * Filter payments by their billing reason.
-   */
-  billing_reasons?: Array<BillingReasons> | null;
-
-  /**
-   * The unique identifier of the company to list payments for.
-   */
-  company_id?: string | null;
-
-  /**
-   * Only return payments created after this timestamp.
-   */
-  created_after?: string | null;
-
-  /**
-   * Only return payments created before this timestamp.
-   */
-  created_before?: string | null;
-
-  /**
-   * Filter payments by their currency code.
-   */
-  currencies?: Array<Shared.Currency> | null;
-
-  /**
-   * The direction of the sort.
-   */
-  direction?: Shared.Direction | null;
-
-  /**
-   * Returns the first _n_ elements from the list.
-   */
-  first?: number | null;
-
-  /**
-   * Whether to include payments with a zero amount.
-   */
-  include_free?: boolean | null;
-
-  /**
-   * Returns the last _n_ elements from the list.
-   */
-  last?: number | null;
-
-  /**
-   * The order to sort the results by.
-   */
-  order?: 'final_amount' | 'created_at' | 'paid_at' | null;
-
-  /**
-   * Filter payments to only those associated with these specific plan identifiers.
-   */
-  plan_ids?: Array<string> | null;
-
-  /**
-   * Filter payments to only those associated with these specific product
-   * identifiers.
-   */
-  product_ids?: Array<string> | null;
-
-  /**
-   * Search payments by user ID, membership ID, user email, name, or username. Email
-   * filtering requires the member:email:read permission.
-   */
-  query?: string | null;
-
-  /**
-   * Filter payments by their current status.
-   */
-  statuses?: Array<Shared.ReceiptStatus> | null;
-
-  /**
-   * Filter payments by their current substatus for more granular filtering.
-   */
-  substatuses?: Array<Shared.FriendlyReceiptStatus> | null;
-
-  /**
-   * Only return payments last updated after this timestamp.
-   */
-  updated_after?: string | null;
-
-  /**
-   * Only return payments last updated before this timestamp.
-   */
-  updated_before?: string | null;
-}
-
 export interface PaymentListFeesParams extends CursorPageParams {
   /**
    * Returns the elements in the list that come before the specified cursor.
@@ -1273,14 +1327,6 @@ export interface PaymentListFeesParams extends CursorPageParams {
   last?: number | null;
 }
 
-export interface PaymentRefundParams {
-  /**
-   * The amount to refund in the payment currency. If omitted, the full payment
-   * amount is refunded.
-   */
-  partial_amount?: number | null;
-}
-
 export declare namespace Payments {
   export {
     type BillingReasons as BillingReasons,
@@ -1291,9 +1337,9 @@ export declare namespace Payments {
     type PaymentListFeesResponse as PaymentListFeesResponse,
     type PaymentListResponsesCursorPage as PaymentListResponsesCursorPage,
     type PaymentListFeesResponsesCursorPage as PaymentListFeesResponsesCursorPage,
-    type PaymentCreateParams as PaymentCreateParams,
     type PaymentListParams as PaymentListParams,
-    type PaymentListFeesParams as PaymentListFeesParams,
     type PaymentRefundParams as PaymentRefundParams,
+    type PaymentCreateParams as PaymentCreateParams,
+    type PaymentListFeesParams as PaymentListFeesParams,
   };
 }

package/src/resources/payout-accounts.ts

@@ -147,7 +147,7 @@ export namespace PayoutAccountRetrieveResponse {
    */
   export interface LatestVerification {
     /**
-     * The unique identifier for the verification.
+     * The numeric id of the verification record.
      */
     id: string;
 

package/src/resources/payout-methods.ts

@@ -11,17 +11,6 @@ import { path } from '../internal/utils/path';
  * Payout methods
  */
 export class PayoutMethods extends APIResource {
-  /**
-   * Retrieves the details of an existing payout method.
-   *
-   * Required permissions:
-   *
-   * - `payout:destination:read`
-   */
-  retrieve(id: string, options?: RequestOptions): APIPromise<PayoutMethodRetrieveResponse> {
-    return this._client.get(path`/payout_methods/${id}`, options);
-  }
-
   /**
    * Returns a list of active payout methods configured for a company, ordered by
    * most recently created.
@@ -39,6 +28,17 @@ export class PayoutMethods extends APIResource {
       ...options,
     });
   }
+
+  /**
+   * Retrieves the details of an existing payout method.
+   *
+   * Required permissions:
+   *
+   * - `payout:destination:read`
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<PayoutMethodRetrieveResponse> {
+    return this._client.get(path`/payout_methods/${id}`, options);
+  }
 }
 
 export type PayoutMethodListResponsesCursorPage = CursorPage<PayoutMethodListResponse>;