diff --git a/content/docs/brand/quickstart/setup-program.mdx b/content/docs/brand/quickstart/setup-program.mdx index bdf59a96..a59ce4b3 100644 --- a/content/docs/brand/quickstart/setup-program.mdx +++ b/content/docs/brand/quickstart/setup-program.mdx @@ -1,90 +1,80 @@ --- title: Set Up Your Program -description: Configure your affiliate program and choose the right integration path. +description: Complete the five setup steps (Business, Commission, Tracking, Payments, Go live) and publish your program on the marketplace. kind: quickstart last_updated: 2026-10-15 --- -Complete these steps before you invite partners or install tracking. +Setup takes your program from created to live in five steps: **Business**, **Commission**, **Tracking**, **Payments** and **Go live**. It opens at the Business step as soon as you [create your program](/docs/brand/quickstart/create-account), at `affitor.com/brand/setup/business`. -## What you are setting up +## The flow at a glance -1. **Program details**: business info, approval settings, commission rules -2. **Tracking & integrations**: click, signup, and sale tracking -3. **Go live**: publish the program once payments are connected -4. **Share program**: your partner-facing program link + + **Business**: business name, website, program URL and an optional logo. + **Commission**: what partners earn, the attribution window, the hold period and how new partners join. + **Tracking**: install the click tracker on your site. Optional for Go live. + **Payments**: connect Stripe, or send one sale from your server. + **Go live**: publish the program once Business, Commission and Payments are done. + -![Program Settings — the checklist walks you through details, tracking, and sharing](/docs/brand/settings.png) +The top of each step shows **Step N of 5** and **Save and exit**. **Continue** saves the step and opens the next one. **Save and exit** saves Business or Commission first, then opens that page in Settings; the other steps have nothing to save and open their Settings page directly. On a wide screen the step list sits on the left, where a done step shows a check (Business also shows your website, Commission your rate), and **What partners see** previews your program card on the right. -## 1. Program details +The same five pages are also **Settings** → **Program settings**, so anything you set here stays editable there. Until the program is live, Program settings shows how many of the five steps are done. After launch the pages have no **Back** or **Continue**: **Business** and **Commission** have **Save**, **Payments** saves when you pick a method, and **Go live** is named **Status**. -### Business details +## Step 1: Describe your business + +The **Business** step (**Your business**) sets what partners see first. | Field | Required | Notes | |-------|----------|-------| -| Company name | Yes | pre-filled from your account | -| Website URL | Yes | main product/site URL | -| Tagline | No | shown to partners | -| Logo | No | PNG, JPG, or SVG; until you add one, the marketplace shows your program's initial | -| Terms of Service URL | No | affiliate terms / program terms | -| Resources URL | No | partner-facing marketing resources | - -### Approval mode - -| Mode | Description | Best for | -|------|-------------|----------| -| **Review each** | review each partner application | quality control, B2B motions | -| **Approve all** | approve applicants automatically | higher-volume programs | +| **Business name** | Yes | 1 to 80 characters | +| **Website** | Yes | Your product or site URL. `example.com` is saved as `https://example.com` | +| **Program URL** | Yes | Your public program page, `affitor.com/marketplace/`. Lowercase letters, numbers and dashes, up to 48 characters. You can change it later | +| **Logo** | No | PNG, JPG or SVG, square, under 5 MB | +| **Tagline** | No | In Settings only (**Program settings** → **Business**): one line on your marketplace card, up to 160 characters | -### Commission details +**Continue** saves only the fields you changed and moves on once every save succeeds; an error shows under its field. The step is done once the program has a business name and a website. -| Field | Description | -|-------|-------------| -| Commission rate (%) | default partner commission | -| Commission duration | how long a referred customer keeps earning for the partner | +## Step 2: Set your commission -Common options: one-time, fixed-month recurring, or lifetime. - ---- +The **Commission** step sets what partners earn and how they join. -## 2. Tracking & Integrations +![Setup step 2 of 5, Commission: type (one-time, recurring or lifetime), rate and months, attribution window, hold period, and whether new partners are approved automatically or reviewed one by one, with a preview of what partners see](/docs/brand/setup-commission.png) -Set up tracking in three steps: clicks, signups, then payments. +| Field | Required | Notes | +|-------|----------|-------| +| **Type** | Yes | **One-time** pays on the first payment, **Recurring** monthly for the months in **For**, **Lifetime** on every payment | +| **Rate** | Yes | Percent of the payment, 0 to 100 with up to 2 decimals | +| **For** | Yes, for **Recurring** | How many months the partner keeps earning: a whole number from 1 to 36. Shown only for **Recurring** | +| **Attribution window** | Yes | How long after a click a signup still counts: 1 to 365 days | +| **Hold period** | Yes | Days until a commission is payable, to cover refunds: 0 to 31 | +| **New partners** | Yes | **Approve all** approves every application; **Review each** lets you review each one | -### Step 1 — Pageview / click tracking +Once the rate is valid, a line shows what a $100 payment gives the partner, for example "$20 to the partner, monthly for 12 months". If your saved terms are ones this form cannot show exactly (for example a fixed amount), the step shows them as **Current terms** and keeps them unless you select **Set new terms**. -Install the tracker on pages where affiliate traffic lands. +The step is done once a sale commission is saved and a **New partners** choice is set. To pay some partners a different rate, use [groups](/docs/brand/groups). -**SDK:** +## Step 3: Install tracking -```bash -npm install @affitor/sdk -``` +The **Tracking** step (**Install tracking**) puts the click tracker on your site. Pick an **Install method**: -```tsx -// app/providers.tsx — client component -'use client'; -import { useEffect } from 'react'; -import { loadAffitor } from '@affitor/sdk'; -export function AffitorInit() { - useEffect(() => { loadAffitor('YOUR_PROGRAM_ID'); }, []); - return null; -} -// render once in app/layout.tsx -``` +- **Your agent**: select **Connect your AI** to connect Claude, Cursor or another AI app and let it add the tracker. Shown only when AI agents are available for your program. +- **Script tag**: paste the tag in `` on every page of your site. +- **npm**: install the SDK and wrap your root layout. -**Script tag:** +The snippets on the page already carry your Program ID: ```html +