Get your program

Returns the program the API key belongs to — the canonical "who am I keyed against" read. There is no program id in the URL: program-scoped API keys carry their program.

Response — 200 OK

{
  "id": "prog_abc123",
  "name": "Acme Inc",
  "icon": "https://example.com/acme.png",
  "status": "online",
  "isSuspended": false,
  "isPermanentlyTerminated": false,
  "createdAt": "2026-10-01T00:00:00.000Z",
  "updatedAt": "2026-10-31T00:00:00.000Z",
  "category": "saas",
  "companyDescription": "Acme builds developer tools.",
  "contact": {
    "method": "email",
    "email": "[email protected]",
    "formUrl": null
  },
  "programTermsUrl": null,
  "homeURL": "https://acme.com",
  "brandColor": "#10B981",
  "requireApplication": true,
  "serveEuUkCustomers": true,
  "listInMarketplace": true,
  "hostedAffiliatePortal": true,
  "affiliatePageDomain": "acme.rezfiliate.com",
  "trackingMethod": {
    "type": "referral_link_discount_code",
    "discount": 1000,
    "discountType": "percentage",
    "discountAppliesEveryMonth": true,
    "discountDuration": 3
  },
  "commissionStructure": {
    "type": "percentage",
    "amount": 2000,
    "isSubscription": false,
    "durationMonths": 0,
    "enabled": true
  },
  "platform": {
    "name": "shopify",
    "status": "connected",
    "domain": "acme.myshopify.com",
    "currency": "usd",
    "isSandbox": false,
    "lastEvent": "2026-10-31T12:00:00.000Z"
  }
}

Field notes

Field	Notes
`status`	`incomplete`, `online`, `paused` (`disturbed`), or a terminated state. Public affiliate actions (apply, discount codes, visits) require `online`.
`contact`	`method` is `email` or `form_link`; the matching field holds the value and the other is typically `null`.
`trackingMethod`	`null` when never configured. `discount` is basis points (1000 = 10%), `null` when the program has no code discount configured. `discountDuration` is the number of monthly renewals covered when `discountAppliesEveryMonth` is true (`null` = forever); always `null` when it is false (codes apply to the first payment only).
`commissionStructure`	`null` when never configured. `amount` is basis points for `percentage`, or the currency's smallest unit for `set_amount`. `durationMonths` limits subscription commissions to their first N months (`0` = unlimited). `enabled: false` means rewards flow exclusively through the custom webhook — no commissions are recorded.
`platform`	`null` when no store is connected. `isSandbox: true` means the integration runs against a sandbox/test store; `lastEvent` is the most recent webhook the platform delivered.
`affiliatePageDomain`	The affiliate portal's hostname, `null` before a domain is claimed.

Errors — all { "error": "<message>" }:

Status	`error` values
404	`Program not found.` (the key's program no longer exists)