Concepts
IDs
Opaque public IDs and their registered prefixes.
Public IDs consist of a resource prefix, an underscore, and a 26-character lower-case
Crockford Base32 representation of a UUID. The first encoded character is between 0
and 7. The alphabet is 0123456789abcdefghjkmnpqrstvwxyz.
Treat public IDs as opaque strings. Keep the prefix when storing or sending them; a resource accepts only its own registered prefix. Invalid or mismatched IDs fail validation.
This table is built from the generated OpenAPI schemas, which register every entry of the API's ID prefix catalogue. A prefix does not imply that its resource endpoint is available yet; use the API Reference for available routes.
| Prefix | Resource |
|---|---|
abp_ | account binding proof |
abr_ | account binding request |
acn_ | assistant connection |
acs_ | account session |
aff_ | affiliate |
apv_ | approval |
arq_ | affiliate request |
att_ | payment attempt |
bil_ | merchant billing account |
cab_ | customer account binding |
chd_ | checkout domain |
chk_ | checkout instance |
cks_ | checkout instance step |
clk_ | settlement clock |
cmp_ | company |
cpl_ | commission plan |
cpn_ | coupon |
cse_ | customer session |
cst_ | customer |
dmr_ | domain registration |
dsp_ | dispute |
egr_ | entitlement grant |
ems_ | embed session |
ent_ | entitlement |
erv_ | entitlement revocation |
evd_ | event delivery |
evn_ | event |
exj_ | export job |
fcn_ | feed connection |
fev_ | feed event |
hin_ | Hermos invoice |
hlt_ | health check |
htr_ | health transition |
inl_ | invoice line |
inv_ | invoice |
ipl_ | installment plan |
key_ | API key |
lk_ | licence key |
lkp_ | licence key pool |
mem_ | membership |
ofr_ | offer |
opr_ | operation |
ord_ | order |
pac_ | processor account |
pay_ | payment |
pcf_ | payment confirmation link |
pcl_ | purchase claim |
pfl_ | payment failure |
pln_ | plan |
pms_ | payment method setup |
pmt_ | payment method |
prc_ | price |
prd_ | product |
prg_ | affiliate program |
psc_ | payment setup change |
pst_ | payment setup |
pyd_ | payout destination |
pyo_ | payout |
rcd_ | reconciliation difference |
rcs_ | reconciliation summary |
rfd_ | refund |
rvi_ | review item |
sas_ | staff access session |
sbi_ | subscription item |
sbs_ | subscription |
scl_ | Stripe connect link |
seq_ | offer sequence |
sil_ | sign-in link |
ssc_ | subscription schedule |
syn_ | synthetic run |
txr_ | tax registration |
ubr_ | unpaid balance record |
usr_ | usage report record |
ust_ | usage settlement |
whk_ | webhook endpoint |