---
title: "Preview invoices"
method: GET
path: "/invoices/preview"
tags: ["Billing"]
---

# Preview invoices

`GET /invoices/preview`

## Request

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

Returns a preview of invoice for the specified order id OR subscription id

## Query parameters

- `orderId` string
- `subscriptionId` string

## Response `200`

successful operation

- InvoicePreviewJson[]
  - `orderId` string
  - `lineItems` InvoiceItemPreviewJson[]
    - `orderLineItemId` string
    - `amount` number
    - `listAmount` number
    - `discountAmount` number
    - `listUnitPrice` number
    - `sellUnitPrice` number
  - `invoiceItems` InvoiceItemJson[]
    - `id` string
    - `planId` string
    - `chargeId` string
    - `orderId` string
    - `orderLineItemId` string
    - `subscriptionChargeId` string
    - `subscriptionChargeGroupId` string
    - `listAmount` number
    - `discountAmount` number
    - `amount` number
    - `taxAmount` number
    - `taxRate` TaxRateJson
      - `id` string, uuid
      - `name` string
      - `description` string
      - `taxPercentage` number
      - `taxCode` string
      - `taxInclusive` boolean
      - `status` 'ACTIVE' | 'DISABLED' | 'EXPIRED', required
      - `inUse` boolean
    - `listUnitPrice` number
    - `sellUnitPrice` number
    - `quantity` integer
    - `drawdownQuantityUsed` integer
    - `drawdownQuantityRemaining` integer
    - `periodStartDate` integer
    - `periodEndDate` integer
    - `isBilled` boolean
    - `functionalListAmount` number
    - `functionalDiscountAmount` number
    - `functionalAmount` number
    - `functionalTaxAmount` number
    - `triggerOn` integer
  - `total` number
  - `totalDiscount` number
  - `createdOn` integer

---

[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)
