Skip to main content
GET
/
v1
/
admin
/
partners
/
payouts
/
{partnerId}
Get partner payout details
curl --request GET \
  --url http://localhost:3000/v1/admin/partners/payouts/{partnerId}
{
  "partner_brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "company_name": "<string>",
  "contact_email": "<string>",
  "payout_method": "<string>",
  "periods": [
    {
      "period": "<string>",
      "sale_count": 123,
      "total_units": 123,
      "gross_sales": 123,
      "total_commission": 123,
      "net_to_partner": 123,
      "status": "pending"
    }
  ],
  "totals": {
    "pending_amount": 123,
    "included_amount": 123,
    "paid_amount": 123,
    "lifetime_sales": 123
  }
}

Path Parameters

partnerId
string<uuid>
required

Partner brand ID

Response

Partner payout details

partner_brand_id
string<uuid>
required
company_name
string
required
contact_email
string
required
payout_method
string | null
required
periods
object[]
required
totals
object
required