Skip to main content
DELETE
Delete a split

Authorizations

x-api-key
string
header
required

API key for authentication. You can find your API key in the Creem dashboard under Settings > API Keys.

Path Parameters

id
string
required

The unique identifier of the split

Response

Successfully deleted the split

id
string
required

Unique identifier for the object.

mode
enum<string>
required

String representing the environment.

Available options:
test,
prod,
sandbox
object
string
required

String representing the object's type. Objects of the same type share the same value.

Example:

"split"

store_id
string
required

The id of the store that owns this split.

Example:

"store_1a2b3c4d"

type
enum<string>
required

What the split applies to: store (every payment to the store) or product (payments for a specific product).

Available options:
store,
product
Example:

"store"

type_reference
string
required

The id of the entity the split applies to: the store id when type is store, or the product id when type is product.

Example:

"prod_1a2b3c4d"

enabled
boolean
required

Whether the split is active. A split created with email invitees starts disabled and activates once the first invitee accepts.

Example:

true

recipients
object[]
required

The recipients of the split and their shares.

created_at
number
required

Creation date of the split as a timestamp.

Example:

1735689600000

description
string | null

A human-readable description of the split.

Example:

"Q3 revenue share"