Retrieve a split
Retrieve a single split by ID, including its recipients and their shares. Email invitees who have not yet accepted are shown with a masked email address and their invite status. Splits belonging to another store are not visible.
Authorizations
API key for authentication. You can find your API key in the Creem dashboard under Settings > API Keys.
Path Parameters
The unique identifier of the split
Response
Successfully retrieved the split
Unique identifier for the object.
String representing the environment.
test, prod, sandbox String representing the object's type. Objects of the same type share the same value.
"split"
The id of the store that owns this split.
"store_1a2b3c4d"
What the split applies to: store (every payment to the store) or product (payments for a specific product).
store, product "store"
The id of the entity the split applies to: the store id when type is store, or the product id when type is product.
"prod_1a2b3c4d"
Whether the split is active. A split created with email invitees starts disabled and activates once the first invitee accepts.
true
The recipients of the split and their shares.
Creation date of the split as a timestamp.
1735689600000
A human-readable description of the split.
"Q3 revenue share"