Get a settlement rule
Retrieve a settlement rule and its shares. A deleted rule is returned with status DELETED.
Authorizations
API token authentication using format <api token id>:<api client secret>
Path Parameters
System-generated unique settlement rule identifier
Response
Successful operation
System-generated unique settlement rule identifier
"SettlementRule:019542f5-b3e7-1d02-0000-000000000001"
"Customer:019542f5-b3e7-1d02-0000-000000000001"
"Glossier deal"
Status of a settlement rule.
PENDING_APPROVAL, ACTIVE, PAUSED, DELETED 1
"USD"
0
86400
Caps on what the rule pays, in the smallest unit of its currency. An execution that would go over a cap is skipped with LIMIT_EXCEEDED, and the customer keeps the payment.
"2026-11-06T18:00:00Z"
"2026-11-06T18:00:00Z"