---
title: "Retrieve a commission rule"
method: GET
path: "/v1/rules/{id}"
tags: ["Commission rules"]
---

# Retrieve a commission rule

`GET /v1/rules/{id}`

## Request

- Base URL: `https://api.affiliaterail.com`
- URL: `https://api.affiliaterail.com/v1/rules/{id}`
- Auth: HTTP bearer

**Scope:** `read`

## Path parameters

- `id` string, required: Prefixed id (`flw_…`)

## Query parameters

- `expand[]` union: Relations to embed: group, partner
  - string
  - string[]
- `include[]` union: Nothing to include on this resource
  - string
  - string[]

## Response `200`

The rule

- Rule
  - `id` string, required: Prefixed id (`flw_…`)
  - `object` 'rule', required
  - `program_id` string, required: Prefixed id (`prg_…`)
  - `group_id` string, nullable, required: Prefixed id (`grp_…`)
  - `partner_id` string, nullable, required: Prefixed id (`part_…`)
  - `name` string, required
  - `description` string, nullable, required
  - `trigger` 'new_payment' | 'new_signup', required
  - `action` 'generate_commission' | 'switch_group', required
  - `rate_type` 'percent' | 'fixed', required
  - `rate_value` integer, required: Basis points for percent, minor units for fixed. The fallback when no branch matches.
  - `approval_mode` 'immediate' | 'after_days' | 'manual', required
  - `approval_delay_days` integer, nullable, required
  - `priority` integer, required: Lower runs first
  - `status` 'active' | 'inactive', required
  - `switch_to_group_id` string, nullable, required: Prefixed id (`grp_…`)
  - `metadata` object, nullable, required: Your own key/value data, stored as given
  - `branches` RuleBranch[], required
    - `id` string, required: Prefixed id (`flb_…`)
    - `object` 'rule_branch', required
    - `rule_id` string, required: Prefixed id (`flw_…`)
    - `position` integer, required
    - `label` string, nullable, required
    - `conditions` union, required: A comparison `{ field, op, value }` or a group `{ all: [...] }`, `{ any: [...] }`, `{ not: ... }`. Numeric ranges are inclusive.
      - object
        - `field` string, required
        - `op` 'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte' | 'between' | 'in' | 'not_in' | 'contains' | 'starts_with' | 'is_true' | 'is_false', required
        - `value` unknown
      - object
        - `all` Condition[], required
      - object
        - `any` Condition[], required
      - object
        - `not` Condition, required (recursive)
    - `rate_type` 'percent' | 'fixed', required
    - `rate_value` integer, required
    - `created_at` string, date-time, required: ISO-8601, UTC
    - `updated_at` string, date-time, required: ISO-8601, UTC
  - `created_at` string, date-time, required: ISO-8601, UTC
  - `updated_at` string, date-time, required: ISO-8601, UTC

## Other responses

- `400`: Invalid request
- `401`: Missing or unknown API key
- `403`: Key lacks the required scope
- `404`: No such object in your organization
- `422`: The request was understood and refused
- `429`: Rate limited: see Retry-After

---

[API](https://skmtc.dev/affiliaterail/apis/affiliaterail-api.md) · [All operations](https://skmtc.dev/affiliaterail/apis/affiliaterail-api/llms.txt) · [OpenAPI document](https://skmtc.dev/affiliaterail/apis/affiliaterail-api/revisions/ea41f345c092?raw)