The commission object

A commission represents a reward issued to an affiliate for a payment from a referred customer.

Example

{
"id": "39e68c88-d84a-4510-b3b4-43c75016a080",
"created_at": "2020-08-19T16:28:31.164Z",
"updated_at": "2020-08-19T16:28:31.164Z",
"amount": 3000,
"currency": "USD",
"due_at": "2020-09-18T16:28:25.000Z",
"paid_at": null,
"campaign": {
"id": "c3482343-8680-40c5-af9a-9efa119713b5",
"created_at": "2020-05-22T02:55:19.802Z",
"updated_at": "2020-08-19T16:28:16.177Z",
"name": "Friends Of MI6"
},
"sale": {
"id": "74e37d3b-03c5-4bfc-841c-a79d5799551a",
"currency": "USD",
"charged_at": "2020-08-19T16:28:25.000Z",
"stripe_account_id": "acct_ABC123",
"stripe_charge_id": "ch_ABC123",
"invoiced_at": "2020-08-19T16:28:25.000Z",
"created_at": "2020-08-19T16:28:31.102Z",
"updated_at": "2020-08-19T16:28:31.102Z",
"charge_amount_cents": 10000,
"refund_amount_cents": 0,
"tax_amount_cents": 0,
"sale_amount_cents": 10000,
"referral": {
"id": "d154e622-278a-4103-b191-5cbebae4047a",
"stripe_account_id": "acct_ABC123",
"stripe_customer_id": "cus_ABC123",
"conversion_state": "conversion",
"deactivated_at": null,
"expires_at": "2020-10-18T16:13:12.109Z",
"created_at": "2020-08-19T16:13:12.109Z",
"updated_at": "2020-08-19T16:28:31.166Z",
"customer": {
"platform": "stripe",
"id": "cus_ABC123",
"name": "Freddie Mercury",
"email": "[email protected]"
},
"visits": 2,
"link": {
"id": "b759a9ed-ed63-499f-b621-0221f2712086",
"url": "http://www.demo.com:8080/?via=james",
"token": "james",
"visitors": 197,
"leads": 196,
"conversions": 156
}
},
"affiliate": {
"id": "07d8acc5-c689-4b4a-bbab-f88a71ffc012",
"created_at": "2020-05-22T02:55:19.934Z",
"updated_at": "2020-08-19T16:28:31.168Z",
"first_name": "James",
"last_name": "Bond",
"email": "[email protected]",
"paypal_email": "",
"confirmed_at": "2020-07-09T03:53:06.760Z",
"paypal_email_confirmed_at": "2020-07-03T17:49:23.489Z",
"receive_new_commission_notifications": true,
"sign_in_count": 1,
"unconfirmed_email": null,
"stripe_customer_id": null,
"stripe_account_id": null,
"visitors": 197,
"leads": 196,
"conversions": 156,
"campaign": {
"id": "c3482343-8680-40c5-af9a-9efa119713b5",
"created_at": "2020-05-22T02:55:19.802Z",
"updated_at": "2020-08-19T16:28:16.177Z",
"name": "Friends Of MI6"
}
}
}
}

Attributes

Name

Data type

Description

id

string

Unique identifier for the commission (UUID).

created_at

string

Time at which the commission was created.

updated_at

string

Time at which the commission was last updated.

amount

integer

The monetary value of the commission in cents.

currency

string

ISO currency code in which the amount is denominated.

due_at

string

Time at which the commission becomes due.

paid_at

sting

Time at which the commission was paid. null if this the commission is unpaid.

campaign

object

The campaign object used to calculate the commission.

sale

object

The sale object that triggered the creation of the commission.