Sign in

v1

latestOpenAPI 3.0.12026-07-243686491.1 MB
Split Billing

Retrieve a single split billing settlement

Required scope: split-billing:read

get/api/v1/split-billing/settlements/{settlementId}

Path parameters

settlementIdinteger required

Response

Split billing settlement with provided id

idinteger

Id of this settlement.

teamIdinteger

Id of the team this settlement belongs to.

userIdinteger

Id of the user that owns this settlement.

status'pending' | 'completed' | 'failed' required
attemptsinteger

Number of times the settlement has been attempted.

lastAttemptAtstring date-time nullable

When the settlement was last attempted.

periodstring nullable

Server-rendered (English) label for the billing period the settlement covers, e.g. April 2026. Prefer firstItemAt/lastItemAt for locale-aware rendering.

firstItemAtstring date-time nullable

Timestamp of the earliest split-billing item in the settlement. Use together with lastItemAt to render a localised period. Null for historical settlements created before the field existed.

lastItemAtstring date-time nullable

Timestamp of the latest split-billing item in the settlement. See firstItemAt.

sessionCountinteger nullable

Number of split-billing charges included in this settlement.

createdAtstring date-time nullable

When this settlement was created.

Example response

{
  "id": 42,
  "teamId": 1024,
  "userId": 5050,
  "amount": {
    "amount": 12312,
    "currency": {
      "id": 1,
      "master": true,
      "identifier": "DKK",
      "name": "Danish krone",
      "decimals": 2
    },
    "locale": "en"
  },
  "total": {
    "amount": 12312,
    "currency": {
      "id": 1,
      "master": true,
      "identifier": "DKK",
      "name": "Danish krone",
      "decimals": 2
    },
    "locale": "en"
  },
  "attempts": 1,
  "lastAttemptAt": "2026-05-10T08:30:00Z",
  "period": "April 2026",
  "firstItemAt": "2026-04-02T08:00:00Z",
  "lastItemAt": "2026-04-29T19:30:00Z",
  "sessionCount": 7,
  "createdAt": "2026-05-01T00:00:00Z"
}