Partners

Retrieve the fee terms a partner can offer

Lists, per income stream, the fee a business the caller refers would be charged, how low the caller may price it, and the commission the caller earns on that stream. Answers for a referral that does not exist yet, so a referral flow can price the deal before the business is created. Requires partner:fees:update, since the floors a partner may price down to are only for a credential that can set them.

get/partners/fee_options

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/partners/fee_options
  • Auth: HTTP bearer

Response

fee terms retrieved

object'partner_fee_options' required

Example response

{
  "object": "partner_fee_options",
  "streams": [
    {
      "adjustable": true,
      "commission_percentage": 30,
      "fee": {
        "minimum_percentage": 2.4,
        "percentage": 2.7,
        "reference_region": "usa",
        "regions": [
          {
            "minimum_percentage": 2.4,
            "percentage": 2.7,
            "region": "usa"
          }
        ]
      },
      "income_stream": "sales",
      "unadjustable_reason": "no_merchant_fee"
    }
  ]
}

Changes

No operation changes recorded.