Links

The payout object

A payout collects a number of payable commissions for a single affiliate in one bundle.

Example

{
"id": "3b03791a-3fb5-4bd6-8ec3-614c9fd978ca",
"currency": "USD",
"paid_at": "2022-10-12T14:55:11.242Z",
"state": "paid",
"paid_by_id": "3e5c04ae-af80-4964-b280-23df034690d4",
"created_at": "2022-10-12T14:54:52.148Z",
"updated_at": "2022-10-12T14:55:11.276Z",
"amount": 1470,
"affiliate": {
"id": "5768bd90-7953-493f-ae6c-6562eb4d7e72",
"created_at": "2022-10-12T14:25:09.323Z",
"updated_at": "2022-11-08T09:13:05.954Z",
"state": "active",
"first_name": "Joe",
"last_name": "Example",
"email": "[email protected]",
"confirmed_at": "2022-10-12T14:25:09.323Z",
"paypal_email": null,
"paypal_email_confirmed_at": null,
"wise_email": null,
"wise_email_confirmed_at": null,
"receive_new_commission_notifications": false,
"sign_in_count": 0,
"unconfirmed_email": null,
"stripe_customer_id": null,
"stripe_account_id": null,
"visitors": 376,
"leads": 142,
"conversions": 56
},
"commissions": [
{
"id": "3a4a775c-b660-4d7f-a733-6f259a2646a7",
"currency": "USD",
"stripe_account_id": "acct_1GWIyRDLlKlZvFB2",
"due_at": "2022-07-31T15:55:19.000Z",
"paid_at": "2022-08-08T09:07:11.242Z",
"created_at": "2022-07-01T15:57:18.742Z",
"updated_at": "2022-07-01T15:57:18.742Z",
"amount": 1470
}
]
}

Attributes

Name
Data type
Description
id
string
Unique identifier for the payout (UUID).
currency
string
ISO currency code in which the amount is denominated.
paid_at
string
Time at which the payout was marked as paid.
state
string
Represents the current state of the payout. This could be one of four possible values: pending, due, processing or paid.
paid_by_id
string
The unique identifier for the user who paid this payout.
created_at
string
Time at which the payout was created.
updated_at
string
Time at which the payout was last updated.
amount
integer
The monetary value of the commission in cents.
affiliate
object
Represents the affiliate to whom the payout should be made.
commissions
array
The list of commissions that comprise the payout.