Programs

Retrieve a program

Scope: read

get/v1/programs/{id}

Request

  • Base URL: https://api.affiliaterail.com
  • URL: https://api.affiliaterail.com/v1/programs/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Prefixed id (prg_…)

Example:prg_7uSyy9FqVLCFWrdPeZaK

Query parameters

string
OR
string[]
string
OR
string[]

Response

The program

idstring required

Prefixed id (prg_…)

object'program' required
namestring required
product_namestring required
website_urlstring required
currencystring required

ISO-4217

status'active' | 'paused' required
subdomainstring required
custom_domainstring nullable required
terms_urlstring nullable required
terms_versionstring nullable required
cookie_daysinteger required
url_paramsstring[] required
commission_on_net_revenueboolean required
holding_period_daysinteger required
min_payout_minorinteger required

Integer minor units (cents, pence). Never a float, never a string.

payout_term'net_15' | 'net_30' | 'net_60' required
payout_methodsstring[] required
block_self_referralsboolean required
blocked_countriesstring[] required
require_tax_formsboolean required
auto_payouts_enabledboolean required
processor'stripe' | 'paddle' | 'chargebee' | 'manual' | 'api' | 'null' nullable required
created_atstring date-time required

ISO-8601, UTC

updated_atstring date-time required

ISO-8601, UTC

Example response

{
  "id": "prg_7uSyy9FqVLCFWrdPeZaK",
  "currency": "USD",
  "min_payout_minor": 2500,
  "stats": {
    "sales_minor": 2500,
    "commissions_minor": 2500
  },
  "created_at": "2026-08-21T10:15:30.000Z",
  "updated_at": "2026-08-21T10:15:30.000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.