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": "Approved by finance team on 2024-01-15",
  "created_at": "2023-12-01T05:00:00.401Z",
  "updated_at": "2023-12-01T05:00:00.401Z"
}

Authorizations

​
Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Body

application/json

Parameters for UpdateFeeMarkup

​
company_id
string
required

The unique identifier of the company to create or update the fee markup for.

Example:

"biz_xxxxxxxxxxxxxx"

​
fee_type
enum<string>
required

The type of fee this markup applies to, such as processing or platform fees.

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 amount in USD to charge per transaction. Must be between 0 and 50.

Example:

6.9

​
metadata
object

Custom key-value metadata to attach to this fee markup.

​
notes
string | null

Internal notes about this fee markup for record-keeping purposes.

​
percentage_fee
number | null

The percentage fee to charge per transaction. Must be between 0 and 25.

Example:

6.9

Response

A successful response

A fee markup configuration that defines additional charges applied to transactions for a platform's connected accounts.

​
id
string
required

The unique identifier for the fee markup.

​
fee_type
enum<string>
required

The category 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

A percentage-based fee charged per transaction. Ranges from 0 to 25. Null if no percentage fee is configured.

Example:

6.9

​
fixed_fee_usd
number | null
required

A flat fee charged per transaction, in USD. Ranges from 0 to 50. Null if no fixed fee is configured.

Example:

6.9

​
notes
string | null
required

Internal notes about this fee markup, visible only to administrators. Null if no notes have been added.

Example:

"Approved by finance team on 2024-01-15"

​
created_at
string<date-time>
required

The datetime the fee markup was created.

Example:

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

​
updated_at
string<date-time>
required

The datetime the fee markup was last updated.

Example:

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