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": "3a966480-40f8-4132-af6a-f5ea5cf964c2",
  "object": "referral_item",
  "commission_amount": 580,
  "line_item": "9df5707f-ca7c-48a4-8f3b-f59490ef695a",
  "referral": "d16f6b99-3089-4c15-a90d-dc9381b5ceea",
  "created_at": 1771429897,
  "updated_at": 1771429897
}

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.