Docs API ReferenceCommissions

Commissions API

Track earnings, view commission history, and request payouts

Endpoints

Available commission management endpoints

GET/commissionsList all commissions

GET/commissions/{id}Get commission details

GET/commissions/summaryGet commission summary

GET/commissions/payoutsList payout history

POST/commissions/request-payoutRequest a payout

The Commission Object

Field	Type	Description
id	string	Unique commission identifier
orderId	string	Associated order ID
orderNumber	string	Human-readable order number
orderValue	number	Total order value in USD
commissionRate	number	Commission rate (0.15 = 15%)
commissionAmount	number	Calculated commission amount
status	string	PENDING, APPROVED, PAID, CANCELLED
createdAt	string	When commission was created
approvedAt	string	When commission was approved
paidAt	string	When commission was paid out
payoutId	string	Associated payout ID if paid

Commission Status Lifecycle

Understanding commission statuses

PENDINGOrder placed, awaiting fulfillment

APPROVEDOrder fulfilled, commission approved for payout

PAIDCommission included in a completed payout

CANCELLEDOrder cancelled or returned, commission voided

List Commissions

GET/commissions

Retrieve a paginated list of all commissions. Supports filtering by status, date range, and order.

Query Parameters

status	string	Filter by status (PENDING, APPROVED, PAID)
start_date	string	Filter from date (ISO 8601)
end_date	string	Filter to date (ISO 8601)
page	integer	Page number (default: 1)

curl -X GET "https://gateway.regentherapy.com/api/v1/commissions" \
  -H "X-API-Key: rg_your_api_key" \
  -H "Content-Type: application/json"

Get Commission Summary

GET/commissions/summary

Get an overview of your commission earnings, including lifetime totals, pending amounts, and tier progress.

curl -X GET "https://gateway.regentherapy.com/api/v1/commissions/summary" \
  -H "X-API-Key: rg_your_api_key" \
  -H "Content-Type: application/json"

Request Payout

POST/commissions/request-payout

Request a payout of your approved commissions. Minimum payout amount is $50.

Request Body

amount	number	Payout amount (min: 50.00)
paymentMethod	string	bank_transfer, paypal, check
notes	string	Optional notes for your records

curl -X POST "https://gateway.regentherapy.com/api/v1/commissions/request-payout" \
  -H "X-API-Key: rg_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 1000.00,
    "paymentMethod": "bank_transfer",
    "notes": "Monthly commission payout"
  }'

Commission Tiers

Your commission rate increases as your lifetime sales grow:

Tier	Lifetime Sales	Commission Rate
Bronze	$0 - $24,999	15%
Silver	$25,000 - $49,999	18%
Gold	$50,000 - $99,999	20%
Platinum	$100,000+	22%

Inventory API Webhooks API