List fees

JavaScript

import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const paymentListFeesResponse of client.payments.listFees('pay_xxxxxxxxxxxxxx')) {
  console.log(paymentListFeesResponse.amount);
}

{
  "data": [
    {
      "name": "<string>",
      "amount": 6.9,
      "currency": "usd",
      "type": "stripe_domestic_processing_fee"
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "start_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true
  }
}

GET

payments

{id}

fees

JavaScript

import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const paymentListFeesResponse of client.payments.listFees('pay_xxxxxxxxxxxxxx')) {
  console.log(paymentListFeesResponse.amount);
}

{
  "data": [
    {
      "name": "<string>",
      "amount": 6.9,
      "currency": "usd",
      "type": "stripe_domestic_processing_fee"
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "start_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true
  }
}

Authorizations

Authorization

string

header

required

The app API key from an app from the /dashboard/developer page

Path Parameters

string

required

The ID of the payment to list fees for

Example:

"pay_xxxxxxxxxxxxxx"

Query Parameters

after

string | null

Returns the elements in the list that come after the specified cursor.

before

string | null

Returns the elements in the list that come before the specified cursor.

first

integer | null

Returns the first n elements from the list.

Example:

42

last

integer | null

Returns the last n elements from the list.

Example:

42

Response

A successful response

The connection type for Fee.

data

object[]

required

A list of nodes.

Show child attributes

data.name

string

required

The label to display for the fee.

data.amount

number

required

The value or amount to display for the fee.

Example:

6.9

data.currency

enum<string>

required

The currency of the fee.

Available options:

usd,

sgd,

inr,

aud,

brl,

cad,

dkk,

eur,

nok,

gbp,

sek,

chf,

hkd,

huf,

jpy,

mxn,

myr,

pln,

czk,

nzd,

aed,

eth,

ape,

cop,

ron,

thb,

bgn,

idr,

dop,

php,

try,

krw,

twd,

vnd,

pkr,

clp,

uyu,

ars,

zar,

dzd,

tnd,

mad,

kes,

kwd,

jod,

all,

xcd,

amd,

bsd,

bhd,

bob,

bam,

khr,

crc,

xof,

egp,

etb,

gmd,

ghs,

gtq,

gyd,

ils,

jmd,

mop,

mga,

mur,

mdl,

mnt,

nad,

ngn,

mkd,

omr,

pyg,

pen,

qar,

rwf,

sar,

rsd,

lkr,

tzs,

ttd,

uzs,

rub,

btc,

cny

data.type

enum<string>

required

The specific origin of the fee, if applicable.

Available options:

stripe_domestic_processing_fee,

stripe_international_processing_fee,

stripe_fixed_processing_fee,

stripe_billing_fee,

stripe_radar_fee,

sales_tax_remittance,

sales_tax_remittance_reversal,

stripe_sales_tax_fee,

whop_processing_fee,

marketplace_affiliate_fee,

affiliate_fee,

crypto_fee,

stripe_standard_processing_fee,

paypal_fee,

stripe_payout_fee,

dispute_fee,

dispute_alert_fee,

apple_processing_fee,

buyer_fee,

sezzle_processing_fee,

splitit_processing_fee,

platform_balance_processing_fee,

payment_processing_percentage_fee,

payment_processing_fixed_fee,

cross_border_percentage_fee,

fx_percentage_fee,

orchestration_percentage_fee,

three_ds_fixed_fee,

billing_percentage_fee,

revshare_percentage_fee

page_info

object

required

Information to aid in pagination.

Show child attributes

page_info.end_cursor

string | null

required

When paginating forwards, the cursor to continue.

page_info.start_cursor

string | null

required

When paginating backwards, the cursor to continue.

page_info.has_next_page

boolean

required

When paginating forwards, are there more items?

page_info.has_previous_page

boolean

required

When paginating backwards, are there more items?

Retrieve payment Refund payment

⌘I

Introduction

Payins

Payouts

Identity

CRM

Engagement

Courses

Developer

Authorizations

Path Parameters

Query Parameters

Response