createpartnerresponsebody.md

CreatePartnerResponseBody

The created or updated partner

Fields

Field	Type	Required	Description
id	str	✔️	The partner's unique ID on Dub.
name	str	✔️	The partner's full legal name.
username	Nullable[str]	✔️	The partner's unique username on Dub.
email	Nullable[str]	✔️	The partner's email address. Should be a unique value across Dub.
image	Nullable[str]	✔️	The partner's avatar image.
description	OptionalNullable[str]	➖	A brief description of the partner and their background.
country	Nullable[str]	✔️	The partner's country (required for tax purposes).
company_name	Nullable[str]	✔️	If the partner profile type is a company, this is the partner's legal company name.
network_status	operations.CreatePartnerNetworkStatus	✔️	The partner's network status on Dub.
default_payout_method	Nullable[operations.CreatePartnerDefaultPayoutMethod]	✔️	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
paypal_email	Nullable[str]	✔️	The partner's PayPal email (for receiving payouts via PayPal).
stripe_connect_id	Nullable[str]	✔️	The partner's Stripe Connect ID (for receiving payouts via Stripe).
payouts_enabled_at	Nullable[str]	✔️	The date when the partner enabled payouts.
identity_verified_at	Nullable[str]	✔️	The date when the partner's identity was verified.
program_id	str	✔️	The program's unique ID on Dub.
group_id	OptionalNullable[str]	➖	The partner's group ID on Dub.
partner_id	str	✔️	The partner's unique ID on Dub.
tenant_id	Nullable[str]	✔️	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.
created_at	str	✔️	N/A
status	operations.CreatePartnerStatus	✔️	The status of the partner's enrollment in the program.
links	List[operations.CreatePartnerLinks]	✔️	The partner's referral links in this program.
total_commissions	Optional[float]	➖	The total commissions paid to the partner for their referrals
click_reward_id	OptionalNullable[str]	➖	N/A
lead_reward_id	OptionalNullable[str]	➖	N/A
sale_reward_id	OptionalNullable[str]	➖	N/A
referral_reward_id	OptionalNullable[str]	➖	N/A
discount_id	OptionalNullable[str]	➖	N/A
application_id	OptionalNullable[str]	➖	If the partner submitted an application to join the program, this is the ID of the application.
banned_at	OptionalNullable[str]	➖	If the partner was banned from the program, this is the date of the ban.
banned_reason	OptionalNullable[operations.CreatePartnerBannedReason]	➖	If the partner was banned from the program, this is the reason for the ban.
referral_form_data	OptionalNullable[operations.CreatePartnerReferralFormData]	➖	N/A
application	OptionalNullable[operations.CreatePartnerApplication]	➖	Linked program application, including review outcome when applicable.
tags	List[operations.CreatePartnerTags]	➖	The tags associated with the partner.
total_clicks	Optional[float]	➖	The total number of clicks on the partner's links
total_leads	Optional[float]	➖	The total number of leads generated by the partner's links
total_conversions	Optional[float]	➖	The total number of leads that converted to paying customers
total_sales	Optional[float]	➖	The total number of sales generated by the partner's links (includes recurring sales)
total_sale_amount	Optional[float]	➖	Total revenue generated by the partner's links
net_revenue	Optional[float]	➖	Net revenue after commissions (Total Revenue - Total Commissions)
earnings_per_click	OptionalNullable[float]	➖	Earnings Per Click (EPC) (Total Revenue ÷ Total Clicks)
average_lifetime_value	OptionalNullable[float]	➖	Average lifetime value for each paying customer (Total Revenue ÷ Total Conversions)
click_to_lead_rate	OptionalNullable[float]	➖	Percentage of clicks that become leads (Total Leads ÷ Total Clicks)
click_to_conversion_rate	OptionalNullable[float]	➖	Percentage of clicks that convert to paying customers (Total Conversions ÷ Total Clicks)
lead_to_conversion_rate	OptionalNullable[float]	➖	Percentage of leads that convert to paying customers (Total Conversions ÷ Total Leads)
return_on_ad_spend	OptionalNullable[float]	➖	Return On Ad Spend (ROAS) (Total Revenue ÷ Total Commissions)
website	OptionalNullable[str]	➖	The partner's website URL (including the https protocol).
youtube	OptionalNullable[str]	➖	The partner's YouTube channel username (e.g. johndoe).
twitter	OptionalNullable[str]	➖	The partner's Twitter username (e.g. johndoe).
linkedin	OptionalNullable[str]	➖	The partner's LinkedIn username (e.g. johndoe).
instagram	OptionalNullable[str]	➖	The partner's Instagram username (e.g. johndoe).
tiktok	OptionalNullable[str]	➖	The partner's TikTok username (e.g. johndoe).
trusted_at	OptionalNullable[str]	➖	: warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. DEPRECATED: Use networkStatus instead.