Skip to main content
GET
/
v1
/
referral_items
/
{id}
Retrieve
curl --request GET \
  --url https://{defaultHost}/v1/referral_items/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "235294e8-3be2-4a81-ad9a-1a3984b42452",
  "object": "referral_item",
  "commission_amount": 580,
  "line_item": "3e32cc3d-1202-4c9f-8fca-cbbe91052924",
  "referral": "920f3f9e-0f9e-4c71-bd2a-9033287460b1",
  "created_at": 1772113025,
  "updated_at": 1772113025
}

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.

​
commission_amount
integer

The amount in cents that will be paid out to the affiliate for this referral item.

​
line_item

Expandable – The associated line item ID.

​
referral

Expandable – The associated referral ID.

​
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.