Skip to main content
GET
Get referral code information

Authorizations

Authorization
string
header
required

Bearer token used for protected REST API requests.

Path Parameters

ref_code
string
required

Referral code to look up.

Response

Referral code details.

Referral code ownership and rebate-rate configuration.

refCode
string

Referral code.

ownerAccountId
string

Account that owns this referral code.

rebateRate
number

Rebate rate in decimal form, for example 0.1 means 10%.

Required range: 0 <= x <= 1
createdAt
string

Creation timestamp when available.

updatedAt
string

Last update timestamp when available.