Endpoint

List split rules

GET/v1/split_rules

Returns your split rules. A split rule shares each paid order it applies to among saved addresses; each share is a payout that waits for approval.

Lists the merchant's split rules.

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 List split rules
Parameter	Type and place	Meaning
`status`	stringquery	Only rules in this state. One of `awaiting_approval`, `active`, `inactive`.
`scope_kind`	stringquery	Only rules whose scope is of this kind. One of `product`, `payment_link`, `merchant`.
`limit`	integerquery	Items per page, 1 to 100. Default 20.
`starting_after`	stringquery	An object id: return the items after it.
`ending_before`	stringquery	An object id: return the items before it.
`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 \
  -H "Authorization: Bearer $ORRERIE_SECRET_KEY"

JavaScript

const response = await fetch("https://api.orrerie.com/v1/split_rules", {
  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",
    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');
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

Headers: Orrerie-Request-Id.

Example response, 200

{
  "object": "list",
  "url": "/v1/split_rules",
  "has_more": false,
  "data": []
}

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.