Skip to main content
POST
/
fee_markups
JavaScript
import Whop from '@whop/sdk';

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

const feeMarkup = await client.feeMarkups.create({
  company_id: 'biz_xxxxxxxxxxxxxx',
  fee_type: 'crypto_withdrawal_markup',
});

console.log(feeMarkup.id);
{
  "id": "<string>",
  "fee_type": "crypto_withdrawal_markup",
  "percentage_fee": 6.9,
  "fixed_fee_usd": 6.9,
  "notes": "<string>",
  "created_at": "2023-12-01T05:00:00.401Z",
  "updated_at": "2023-12-01T05:00:00.401Z"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Parameters for UpdateFeeMarkup

​
company_id
string
required

The ID (tag) of the company you want to update the fee markup for.

Example:

"biz_xxxxxxxxxxxxxx"

​
fee_type
enum<string>
required

The type of fee this markup applies to.

Available options:
crypto_withdrawal_markup,
rtp_withdrawal_markup,
next_day_bank_withdrawal_markup,
bank_wire_withdrawal_markup,
digital_wallet_withdrawal_markup
​
fixed_fee_usd
number | null

The fixed fee in USD to charge (0-50).

Example:

6.9

​
metadata
object

Custom metadata to attach to this fee markup.

​
notes
string | null

Internal notes about this fee markup.

​
percentage_fee
number | null

The percentage fee to charge (0-25).

Example:

6.9

Response

A successful response

Represents a fee markup configuration for a company

​
id
string
required

The unique identifier of the fee markup.

​
fee_type
enum<string>
required

The type of fee this markup applies to.

Available options:
crypto_withdrawal_markup,
rtp_withdrawal_markup,
next_day_bank_withdrawal_markup,
bank_wire_withdrawal_markup,
digital_wallet_withdrawal_markup
​
percentage_fee
number | null
required

The percentage fee to charge (0-25).

Example:

6.9

​
fixed_fee_usd
number | null
required

The fixed fee in USD to charge (0-50).

Example:

6.9

​
notes
string | null
required

Internal notes about this fee markup.

​
created_at
string<date-time>
required

When this fee markup was created.

Example:

"2023-12-01T05:00:00.401Z"

​
updated_at
string<date-time>
required

When this fee markup was last updated.

Example:

"2023-12-01T05:00:00.401Z"