---
title: "Get settlement applications"
method: GET
path: "/settlements"
tags: ["Billing"]
---

# Get settlement applications

`GET /settlements`

## Request

- Base URL: `https://api.app.subskribe.com`
- URL: `https://api.app.subskribe.com/settlements`
- Auth: API key in header `X-API-Key`

Returns the settlement applications for the specified invoice number or payment object.

## Query parameters

- `invoiceNumber` string
- `paymentId` string

## Response `200`

successful operation

- SettlementApplication[]
  - `id` string, uuid
  - `entityId` string
  - `customerAccountId` string
  - `invoiceNumber` string
  - `paymentId` string
  - `creditMemoNumber` string
  - `applicationType` 'PAYMENT' | 'VOID_PAYMENT' | 'CREDIT' | 'UNAPPLY_CREDIT'
  - `amount` number
  - `note` string
  - `appliedOn` integer
  - `exchangeRateId` string
  - `exchangeRate` number
  - `exchangeRateDate` integer
  - `functionalAmount` number
  - `createdOn` integer
  - `status` 'ATTEMPTING_PAYMENT_COLLECTION' | 'APPLIED_PAYMENT' | 'FAILED'
  - `negatedSettlementId` string, uuid

---

[API](https://skmtc.dev/dealhub/apis/subskribe-api.md) - [All operations](https://skmtc.dev/dealhub/apis/subskribe-api/llms.txt) - [OpenAPI document](https://skmtc.dev/dealhub/apis/subskribe-api/revisions/c1ee531b82ce?raw)