Skip to main content
GET
/
v1
/
payout_groups
/
{id}
Retrieve
curl --request GET \
  --url https://{defaultHost}/v1/payout_groups/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "5581624c-b573-4bfb-bf11-1d5f5de4d5aa",
  "object": "payout_group",
  "currency": "usd",
  "end_date": 1767571200,
  "live_mode": true,
  "min_commission_amount": null,
  "created_at": 1767909730,
  "updated_at": 1767909730
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Response

200 - application/json

Success

​
id
string | null

The UUID of the specific object.

​
object
string

A string describing the object type returned.

​
end_date
integer

All approved referrals through this day will be included in the payout.

​
live_mode
boolean

Set to true if this payout group is in live mode, and set to false if it is in test mode.

​
min_commission_amount
integer | null

The minimum amount of commission that must be earned before a payout is generated for an affiliate.

​
currency
string

The currency of the payout group.

​
payouts

Expandable – Property not returned unless expanded.

​
created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

​
updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.