id |
string |
✔️ |
The partner's unique ID on Dub. |
name |
string |
✔️ |
The partner's full legal name. |
companyName |
string |
✔️ |
If the partner profile type is a company, this is the partner's legal company name. |
email |
string |
✔️ |
The partner's email address. Should be a unique value across Dub. |
image |
string |
✔️ |
The partner's avatar image. |
description |
?string |
➖ |
A brief description of the partner and their background. |
country |
string |
✔️ |
The partner's country (required for tax purposes). |
defaultPayoutMethod |
Components\DefaultPayoutMethod |
✔️ |
The partner's default payout method. Connect: Bank account payouts via Stripe Connect; Stablecoin: USDC payouts directly to a crypto wallet; PayPal: Payouts via PayPal |
paypalEmail |
string |
✔️ |
The partner's PayPal email (for receiving payouts via PayPal). |
stripeConnectId |
string |
✔️ |
The partner's Stripe Connect ID (for receiving payouts via Stripe). |
payoutsEnabledAt |
string |
✔️ |
The date when the partner enabled payouts. |
trustedAt |
string |
✔️ |
The date when the partner received the trusted badge in the partner network. |
identityVerifiedAt |
string |
✔️ |
The date when the partner's identity was verified. |
programId |
string |
✔️ |
The program's unique ID on Dub. |
groupId |
?string |
➖ |
The partner's group ID on Dub. |
partnerId |
string |
✔️ |
The partner's unique ID on Dub. |
tenantId |
string |
✔️ |
The partner's unique ID within your database. Can be useful for associating the partner with a user in your database and retrieving/update their data in the future. |
createdAt |
string |
✔️ |
N/A |
status |
Components\Status |
✔️ |
The status of the partner's enrollment in the program. |
links |
array<Components\Links> |
✔️ |
The partner's referral links in this program. |
totalCommissions |
?float |
➖ |
The total commissions paid to the partner for their referrals |
clickRewardId |
?string |
➖ |
N/A |
leadRewardId |
?string |
➖ |
N/A |
saleRewardId |
?string |
➖ |
N/A |
discountId |
?string |
➖ |
N/A |
applicationId |
?string |
➖ |
If the partner submitted an application to join the program, this is the ID of the application. |
bannedAt |
?string |
➖ |
If the partner was banned from the program, this is the date of the ban. |
bannedReason |
?Components\BannedReason |
➖ |
If the partner was banned from the program, this is the reason for the ban. |
referralFormData |
?Components\ReferralFormData |
➖ |
N/A |
application |
?Components\Application |
➖ |
Linked program application, including review outcome when applicable. |
totalClicks |
?float |
➖ |
The total number of clicks on the partner's links |
totalLeads |
?float |
➖ |
The total number of leads generated by the partner's links |
totalConversions |
?float |
➖ |
The total number of leads that converted to paying customers |
totalSales |
?float |
➖ |
The total number of sales generated by the partner's links (includes recurring sales) |
totalSaleAmount |
?float |
➖ |
Total revenue generated by the partner's links |
netRevenue |
?float |
➖ |
Net revenue after commissions (Total Revenue - Total Commissions) |
earningsPerClick |
?float |
➖ |
Earnings Per Click (EPC) (Total Revenue ÷ Total Clicks) |
averageLifetimeValue |
?float |
➖ |
Average lifetime value for each paying customer (Total Revenue ÷ Total Conversions) |
clickToLeadRate |
?float |
➖ |
Percentage of clicks that become leads (Total Leads ÷ Total Clicks) |
clickToConversionRate |
?float |
➖ |
Percentage of clicks that convert to paying customers (Total Conversions ÷ Total Clicks) |
leadToConversionRate |
?float |
➖ |
Percentage of leads that convert to paying customers (Total Conversions ÷ Total Leads) |
returnOnAdSpend |
?float |
➖ |
Return On Ad Spend (ROAS) (Total Revenue ÷ Total Commissions) |
website |
?string |
➖ |
The partner's website URL (including the https protocol). |
youtube |
?string |
➖ |
The partner's YouTube channel username (e.g. johndoe). |
twitter |
?string |
➖ |
The partner's Twitter username (e.g. johndoe). |
linkedin |
?string |
➖ |
The partner's LinkedIn username (e.g. johndoe). |
instagram |
?string |
➖ |
The partner's Instagram username (e.g. johndoe). |
tiktok |
?string |
➖ |
The partner's TikTok username (e.g. johndoe). |