Endpoint

Retrieve a split rule

GET/v1/split_rules/{id}

Returns one split rule by its id, with its shares and its state.

Returns one split rule.

Scope a restricted key needs: payouts:read
Publishable key: Not allowed: secret or restricted key only
Idempotency-Key: Not used. A GET is already safe to repeat.

Parameters

Parameters of Retrieve a split rule
Parameter	Type and place	Meaning
`id`required	stringpath	The id of the split rule.
`Orrerie-Version`	stringheader	API version date. Default: the version the key was created with. Example `2026-10-11`.

Example request

curl

curl https://api.orrerie.com/v1/split_rules/srl_4n7q0t2w5z8c1f3h6k9m2p4r \
  -H "Authorization: Bearer $ORRERIE_SECRET_KEY"

JavaScript

const response = await fetch("https://api.orrerie.com/v1/split_rules/srl_4n7q0t2w5z8c1f3h6k9m2p4r", {
  headers: {
    Authorization: `Bearer ${process.env.ORRERIE_SECRET_KEY}`,
  },
});
const result = await response.json();
if (!response.ok) throw new Error(`${result.error.code}: ${result.error.message}`);
console.log(result);

Python

import os
import requests

response = requests.get(
    "https://api.orrerie.com/v1/split_rules/srl_4n7q0t2w5z8c1f3h6k9m2p4r",
    headers={"Authorization": f"Bearer {os.environ['ORRERIE_SECRET_KEY']}"},
    timeout=30,
)
result = response.json()
if not response.ok:
    raise RuntimeError(f"{result['error']['code']}: {result['error']['message']}")
print(result)

PHP

<?php
$request = curl_init('https://api.orrerie.com/v1/split_rules/srl_4n7q0t2w5z8c1f3h6k9m2p4r');
curl_setopt_array($request, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('ORRERIE_SECRET_KEY'),
    ],
]);
$body = curl_exec($request);
if ($body === false) {
    throw new RuntimeException(curl_error($request));
}
$result = json_decode($body, true);
if (curl_getinfo($request, CURLINFO_HTTP_CODE) >= 400) {
    throw new RuntimeException($result['error']['code'] . ': ' . $result['error']['message']);
}
print_r($result);

Responses

`200` OK

The answer is the split_rule object. Headers: Orrerie-Request-Id.

Example response, 200

{
  "id": "srl_4n7q0t2w5z8c1f3h6k9m2p4r",
  "object": "split_rule",
  "livemode": true,
  "created": "2026-10-11T14:20:00.000Z",
  "name": "Roaster share",
  "status": "active",
  "scope": {
    "kind": "product",
    "product": "prod_8m2k5q9x1w4e7r0t3y6u2i5o",
    "payment_link": null
  },
  "shares": [
    {
      "saved_address": "dst_3f7k0n2p5s8v1x4z7b0d3g6j",
      "percent": "30.00"
    },
    {
      "saved_address": "dst_9c2e5h8k1n4q7t0w3z6b9d2g",
      "percent": "10.00"
    }
  ],
  "kept_percent": "60.00",
  "remind_daily": false,
  "pending": {
    "legs": 0,
    "totals": []
  }
}

Any other status: an error

A status of 400 or above answers with the error object. Branch on its code, never on its message.

Errors

This call has no error of its own. It answers with the errors every call can answer with: a bad key, a missing scope, an object that does not exist, the rate limit. Every error code has its own entry.