Sign in
Splits

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.

get/v1/splits/{id}

Path parameters

idstring required

The unique identifier of the split

Response

Successfully retrieved the split

idstring required

Unique identifier for the object.

mode'test' | 'prod' | 'sandbox' required

String representing the environment.

objectstring required

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

store_idstring required

The id of the store that owns this split.

descriptionstring nullable

A human-readable description of the split.

type'store' | 'product' required

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

type_referencestring 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.

enabledboolean required

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

created_atnumber required

Creation date of the split as a timestamp.

Example response

{
  "object": "split",
  "store_id": "store_1a2b3c4d",
  "description": "Q3 revenue share",
  "type": "store",
  "type_reference": "prod_1a2b3c4d",
  "enabled": true,
  "recipients": [
    {
      "type": "percentage",
      "recipient_type": "store",
      "recipient_reference": "store_1a2b3c4d",
      "amount": 25,
      "enabled": true,
      "invite_status": "pending"
    }
  ],
  "created_at": 1735689600000
}

Changes

Changed in 1 of the 4 revisions of this API.1