Partner Referral Request

Partner Referral Requests let partners create referral links and request attribution for an existing business or enrolled partner, with manual requests requiring recipient approval.

Endpoints

Endpoint	Request
List partner referral requests	GET `/partner_referral_requests`
Retrieve a partner referral request	GET `/partner_referral_requests/{id}`
Create a partner referral request	POST `/partner_referral_requests`
Accept a partner referral request	POST `/partner_referral_requests/{id}/accept`
Cancel a partner referral request	POST `/partner_referral_requests/{id}/cancel`
Decline a partner referral request	POST `/partner_referral_requests/{id}/decline`

Attributes

string

required

Partner referral request ID, prefixed prfr_.

object | null

required

Business receiving the request, when one is assigned.

Properties

string

required

Account ID, prefixed biz_.

string

required

Account display name.

string | null

required

The partner’s team membership this referral was created for, prefixed ausr_. null when the referral is personal.

string | null

required

Unique referral code, when assigned.

string

required

When the request was created, as an ISO 8601 timestamp.

integer | null

required

Maximum permitted redemptions, when limited.

object

required

Public profile of the requesting partner.

Properties

string

required

User ID, prefixed user_.

string | null

required

Display name.

object

required

Avatar wrapper; its url is always present, using a generated placeholder when the user set no picture.

Properties

string

required

Avatar image URL. Always present — a generated placeholder when the user set no picture.

string

required

Public username.

string

required

How the referral request was initiated.Available options: manual, ownership_transfer, link

object[]

required

Rewards offered by this request.

Properties

string

required

Partner reward ID, prefixed prwd_.

string | null

required

Activity that qualifies for this reward, when specified.Available options: sales, ad_spend

object

required

USD amount of qualifying activity required to earn the reward.

Properties

string

required

The amount in major units, as an exact decimal string — "10.00" is ten dollars. A string so no float rounds it in transit.

string

required

Three-letter ISO 4217 currency code, lowercase.

integer

required

How many decimal places the amount CARRIES — the precision the charge itself runs at.

integer

required

How many decimal places to SHOW. Usually equal to decimals, and deliberately not always: COP is charged in centavos but written in whole pesos, so it is 2 and 0. Format the number in your own locale using this.

string | null

required

Reward recipient’s role, or null for a fixed user who is not the requesting partner.Available options: business, partner

string | null

required

Concrete recipient’s user or business ID, or null until a business redeems the offer.

object

required

USD amount granted after qualification.

Properties

string

required

The amount in major units, as an exact decimal string — "10.00" is ten dollars. A string so no float rounds it in transit.

string

required

Three-letter ISO 4217 currency code, lowercase.

integer

required

How many decimal places the amount CARRIES — the precision the charge itself runs at.

integer

required

string | null

required

The approval state, or null for requests without an approval process.Available options: pending, accepted, denied, cancelled

string

required

When the request last changed, as an ISO 8601 timestamp.

object | null

required

User receiving the attribution request, or null for a business request or referral link.

Properties

string

required

User ID, prefixed user_.

string | null

required

Display name.

object

required

Avatar wrapper; its url is always present, using a generated placeholder when the user set no picture.

Properties

string

required

Avatar image URL. Always present — a generated placeholder when the user set no picture.

string

required

Public username.

PartnerReferralRequest

{
	"id": "prfr_xxxxxxxxxxxxxx",
	"request_type": "manual",
	"status": "accepted",
	"code": null,
	"max_redemptions": null,
	"account": {
		"id": "biz_xxxxxxxxxxxxxx",
		"title": "Shine Time Auto Detailing"
	},
	"partner": {
		"id": "user_xxxxxxxxxxxxxx",
		"name": "Dana Whitfield",
		"username": "danawhitfield",
		"profile_picture": {
			"url": "https://ui-avatars.com/api/?name=Dana+Whitfield"
		}
	},
	"user": null,
	"rewards": [
		{
			"id": "prwd_xxxxxxxxxxxxxx",
			"recipient": "partner",
			"recipient_id": "user_xxxxxxxxxxxxxx",
			"bot_qualification_type": "sales",
			"qualification_amount": {
				"amount": "1000.00",
				"currency": "usd",
				"decimals": 2,
				"display_decimals": 2
			},
			"reward_amount": {
				"amount": "100.00",
				"currency": "usd",
				"decimals": 2,
				"display_decimals": 2
			}
		}
	],
	"created_at": "2026-09-10T09:00:00.000Z",
	"updated_at": "2026-09-11T17:20:00.000Z",
	"authorized_user_id": null
}

​Endpoints

​Attributes

Endpoints

Attributes