Partner Portal and Onboarding | blade47/dub Wiki | doc0

Public

Partner Portal and Onboarding | blade47/dub Wiki | doc0

Path Prefix / Route	Purpose / Description
`/programs`	Affiliate programs listing and management
`/marketplace`	Partner marketplace discovery
`/onboarding`	Partner registration and profile setup
`/settings`	Partner account and notification settings
`/profile`	User and partner profile management
`/messages`	Communications and partner updates
`/payouts`	Earnings, banking, and payout configuration
`/account`	Account details and security
`/invite`	Partner profile invitation acceptance
`/rewind`	Historical earnings and year-in-review summaries

export function PartnerProfileAuth({ children }: { children: ReactNode }) {
  const searchParams = useSearchParams();
  const { loading: sessionLoading } = useRefreshSession("defaultPartnerId");
  const { partner, error } = usePartnerProfile();
 
  useEffect(() => {
    const error = searchParams?.get("error");
    if (error) {
      toast.error(ERROR_CODES[error] || error);
    }
  }, [searchParams]);
 
  const loading = sessionLoading || (!partner && !error);
 
  if (loading) {
    return <LayoutLoader />;
  }
 
  if (!loading && error && error.status === 404) {
    redirect("/onboarding");
  }
 
  return children;
}

Error Code Key	Error Message Displayed
`unauthorized`	Unauthorized. You must be logged in https://partners.dub.co to continue.
`partner_not_found`	Partner profile not found.
`invalid_state`	Invalid or expired state. Please try again from the beginning.
`paypal_email_not_verified`	PayPal email address is not verified. Please verify your email address in PayPal and try again.
`paypal_account_already_in_use`	The PayPal account you're trying to connect is already in use by another partner. Please use a different PayPal account.

export async function generateMetadata(props: {
  params: Promise<{ programSlug: string; groupSlug?: string }>;
}) {
  const { programSlug, groupSlug } = await props.params;
  const partnerGroupSlug = groupSlug ?? DEFAULT_PARTNER_GROUP.slug;
 
  const program = await getProgram({
    slug: programSlug,
    groupSlug: partnerGroupSlug,
  });
 
  if (!program) {
    notFound();
  }
 
  return constructMetadata({
    title: `${program.name} Affiliate Program`,
    description: `Join the ${program.name} affiliate program and ${
      program.rewards && program.rewards.length > 0
        ? formatRewardDescription(program.rewards[0]).toLowerCase()
        : "earn commissions"
    } by referring ${program.name} to your friends and followers.`,
    image: `${APP_DOMAIN}/api/og/program?slug=${program.slug}${groupSlug ? `&groupSlug=${groupSlug}` : ""}`,
    canonicalUrl: `${PARTNERS_DOMAIN}/${program.slug}`,
  });
}

export async function generateStaticParams() {
  const programs = await getProgramSlugs();
 
  return programs.map((program) => ({
    programSlug: program.slug,
    groupSlug: DEFAULT_PARTNER_GROUP.slug,
  }));
}

export default function PartnerOnboardingLayout({
  children,
}: {
  children: React.ReactNode;
}) {
  return (
    <>
      <div className="absolute inset-0 isolate overflow-hidden bg-white">
        <div
          className={cn(
            "absolute inset-y-0 left-1/2 w-[1200px] -translate-x-1/2",
            "[mask-composite:intersect] [mask-image:linear-gradient(black,transparent_320px),linear-gradient(90deg,transparent,black_5%,black_95%,transparent)]",
          )}
        >
          <Grid
            cellSize={60}
            patternOffset={[0.75, 0]}
            className="text-neutral-200"
          />
        </div>
        <AuroraGradient />
      </div>
 
      <div className="relative flex min-h-[100dvh] min-h-screen w-full flex-col items-center overflow-hidden md:justify-between">
        <div className="w-full px-4 md:grow md:basis-0 md:px-0">
          <div className="flex justify-center pt-4">
            <Link
              href="https://dub.co/home"
              target="_blank"
              className="block w-fit"
            >
              <Wordmark className="h-8" />
              <div className="text-center text-sm font-semibold text-black/80">
                Partners
              </div>
            </Link>
          </div>
        </div>
 
        <div className="w-full flex-1 overflow-y-auto md:flex-none md:overflow-visible">
          <div className="w-full px-5 pb-8 pt-8 sm:pb-4 md:px-0 md:py-16">
            {children}
          </div>
        </div>
 
        <div className="w-full md:hidden">
          <SignedInHint />
        </div>
 
        <div className="hidden md:block md:grow md:basis-0" />
      </div>
 
      <div className="hidden md:block">
        <SignedInHint />
      </div>
 
      <Toolbar show={["help"]} />
    </>
  );
}

Step Number	Action Title	Target URL	Purpose
1	Complete your partner profile	`https://ship.dub.co/partner-profile`	Fill out partner profile and verify social platforms
2	Apply to our partner network	`https://ship.dub.co/join-network`	Unlock access to the program marketplace
3	Join a program	`https://ship.dub.co/marketplace`	Apply to specific brand programs and earn commissions
4	Set up payouts	`https://ship.dub.co/connect-payouts`	Connect a payout method to receive referral earnings

Route Path	HTTP Method	Handler / Auth Wrapper	Core Action
`/api/partners/links`	GET	`withWorkspace`	Retrieves partner links within a workspace program, optionally including reward fields based on search parameters.
`/api/partners/links`	POST	`withWorkspace`	Creates a partner link with optional link-level reward overrides and workspace plan capability checks.
`/api/embed/referrals/links`	GET	`withReferralsEmbedToken`	Fetches embedded partner links authenticated via referral embed tokens.
`/api/embed/referrals/links`	POST	`withReferralsEmbedToken`	Creates a partner link via the embed widget, respecting group link limits and emitting workspace webhooks.
`/api/partner-profile/programs/[programId]/links`	GET	`withPartnerProfile`	Returns partner links in a specific program enriched with resolved reward rules and discount codes.
`/api/partner-profile/programs/[programId]/links`	POST	`withPartnerProfile`	Generates a new partner link directly from the partner profile portal interface.

Quickstart Item	Target Tab / Action	Condition / Behavior
Share your link	Copies `links[0]` or navigates to `"Links"` tab	Uses `constructPartnerLink()` with the default group and link.
Program resources	`"Resources"` tab	Disabled if `hasResources` is false.
Browse the FAQ	`"FAQ"` tab	Rendered when `programEmbedData.hideEarnings` is true.
Receive earnings	`"Settings"` tab or external URL	Evaluates Tremendous country support and payout history.

Integration Parameter / Constant	Target Function / SDK	Value / Structure	Purpose
`payout_settings.update`	`throwIfNoPermission`	Role permission string	Guards payout modification endpoints against unauthorized users.
`PartnerPayoutMethod.connect`	`getPayoutMethodsForCountry`	Enum value	Validates country eligibility for standard Stripe Connect payouts.
`PartnerPayoutMethod.stablecoin`	`getPayoutMethodsForCountry`	Enum value	Validates country eligibility for stablecoin recipient payouts.
`account_onboarding`	`createStripeRecipientAccountLink` / `stripe.accountLinks.create`	Action use case / link type string	Triggers onboarding flow for newly created accounts.
`account_update`	`createStripeRecipientAccountLink`	Action use case string	Triggers update flow for already provisioned accounts.
`eventually_due`	`stripe.accountLinks.create`	`collect` option	Specifies requirement collection behavior during onboarding.

UI Component / Field	SDK Method / Source Variable	Value / Configuration	Purpose
`partner` card key	Response JSON card definition	`{ key: "partner", components: [...] }`	Root container grouping partner telemetry elements for Plain support views.
`partners.dub.co`	`plain.addCustomerToCustomerGroups`	Customer group identifier string	Automatically assigns verified partners to the designated customer group in Plain.
`Dub Admin View`	`uiComponent.linkButton`	`https://admin.dub.co/partners/network?search={id}&partnerId={id}`	Deep-links support agents directly to the internal Dub admin view for the partner.
`Payouts Enabled (UTC)`	`uiComponent.badge`	Green badge if `payoutsEnabledAt` is set, Red ("No") otherwise	Displays timestamp-aware payout activation status in UTC format.
`Stripe Recipient Account`	`uiComponent.linkButton`	`https://dashboard.stripe.com/global-payouts/recipients/{id}`	Direct link to Stripe global payouts recipient dashboard.
`Stripe Express Account`	`uiComponent.linkButton`	`https://dashboard.stripe.com/connect/accounts/{id}`	Direct link to Stripe Connect express account management.