---
title: "Get Invoice"
method: GET
path: "/v1/installations/{integrationConfigurationId}/billing/invoices/{invoiceId}"
tags: ["marketplace"]
---

# Get Invoice

`GET /v1/installations/{integrationConfigurationId}/billing/invoices/{invoiceId}`

## Request

- Base URL: `https://api.vercel.com`
- URL: `https://api.vercel.com/v1/installations/{integrationConfigurationId}/billing/invoices/{invoiceId}`
- Auth: HTTP bearer

Get Invoice details and status for a given invoice ID.<br/> <br/> See [Billing Events with Webhooks documentation](https://vercel.com/docs/integrations/create-integration/marketplace-api#working-with-billing-events-through-webhooks) on how to receive invoice events. This endpoint is used to retrieve the invoice details.

## Path parameters

- `integrationConfigurationId` string, required
- `invoiceId` string, required

## Response `200`

- object
  - `created` string, required: System creation date. ISO 8601 timestamp.
  - `discounts` object[]: Invoice discounts.
    - `amount` string, required: Discount amount. A dollar-based decimal string.
    - `billingPlanId` string, required: Partner's billing plan ID.
    - `details` string: Additional discount details.
    - `end` string: Start and end are only needed if different from the period's start/end. ISO 8601 timestamp.
    - `name` string, required: Discount name.
    - `resourceId` string: Partner's resource ID. If not specified, indicates installation-wide discount.
    - `start` string: Start and end are only needed if different from the period's start/end. ISO 8601 timestamp.
  - `externalId` string: Partner-supplied Invoice ID, if applicable.
  - `invoiceDate` string, required: Invoice date. ISO 8601 timestamp.
  - `invoiceId` string, required: Vercel Marketplace Invoice ID.
  - `invoiceNumber` string: User-readable invoice number.
  - `items` object[], required: Invoice items.
    - `billingPlanId` string, required: Partner's billing plan ID.
    - `details` string: Additional item details.
    - `end` string: Start and end are only needed if different from the period's start/end. ISO 8601 timestamp.
    - `name` string, required: Invoice item name.
    - `price` string, required: Item price. A dollar-based decimal string.
    - `quantity` number, required: Item quantity.
    - `resourceId` string: Partner's resource ID. If not specified, indicates installation-wide item.
    - `start` string: Start and end are only needed if different from the period's start/end. ISO 8601 timestamp.
    - `total` string, required: Item total. A dollar-based decimal string.
    - `units` string, required: Units for item's quantity.
  - `memo` string: Additional memo for the invoice.
  - `outstandingTotal` string: Amount still owed on the invoice, per the payment processor. Can be positive even for states "refunded" or "refund_requested", since a refund does not settle an unpaid remainder. A dollar-based decimal string. Absent when no payment data is available yet.
  - `paidAt` string: Moment the invoice was paid. ISO 8601 timestamp.
  - `paidTotal` string: Total amount paid and retained: payments received minus refunds applied. A dollar-based decimal string. Absent when no payment data is available yet.
  - `pendingRefundTotal` string: Requested refund amount not yet applied by the payment processor: "refundTotal" minus "refundedTotal". A dollar-based decimal string. Only present when a refund was requested or applied.
  - `period` object, required: Subscription period for this billing cycle. ISO 8601 timestamps.
    - `end` string, required
    - `start` string, required
  - `refundedAt` string: Most recent moment the invoice was refunded. ISO 8601 timestamp.
  - `refundedTotal` string: Total refund amount applied by the payment processor, on the same pre-tax basis as "refundTotal". Counts both money returned and debt cancelled on unpaid invoices. May be lower than "refundTotal", which is the requested amount. A dollar-based decimal string. Only present when a refund was requested or applied.
  - `refundReason` string: The reason for refund. Only present when a refund has been requested.
  - `refundTotal` string: Total refund amount requested. Only present when a refund has been requested. A dollar-based decimal string.
  - `state` 'draft' | 'invoiced' | 'notpaid' | 'overdue' | 'paid' | 'pending' | 'refund_requested' | 'refunded' | 'scheduled', required: Invoice state. Reports the payment state of the invoice; refund progress is reported separately via "refundedTotal" and "pendingRefundTotal". The states "refunded" and "refund_requested" only appear when the payment state cannot be determined.
  - `test` false | true: Whether the invoice is in the testmode (no real transaction created).
  - `total` string, required: Invoice total amount. A dollar-based decimal string.
  - `updated` string, required: System update date. ISO 8601 timestamp.

## Other responses

- `400`: One of the provided values in the request query is invalid.
- `401`: The request is not authorized.
- `403`: You do not have permission to access this resource.
- `404`
- `410`
- `429`

## Changes

- **2026-10-19** `08cb01e9f3a4`: 4 info
  - added the optional property `outstandingTotal` to the response with the `200` status
  - added the optional property `paidTotal` to the response with the `200` status
  - added the optional property `pendingRefundTotal` to the response with the `200` status
  - added the optional property `refundedTotal` to the response with the `200` status
- **2026-07-21** `2ae10ee9d21c`: 2 info
  - added the non-success response with the status `410`
  - added the non-success response with the status `429`
- **2026-06-11** `14b4658f819e`: 1 warning
  - added the new `overdue` enum value to the `state` response property for the response status `200`
- **2026-01-22** `c12186034433`: 2 warning, 2 info
  - added the new `false` enum value to the `test` response property for the response status `200`
  - added the new `true` enum value to the `test` response property for the response status `200`
  - added the optional property `paidAt` to the response with the `200` status
  - added the optional property `refundedAt` to the response with the `200` status
- **2025-11-28** `45991e5c8b6d`: 1 warning
  - added the new `draft` enum value to the `state` response property for the response status `200`

[Operation history](https://skmtc.dev/vercel/apis/vercel-api/changes/v1/installations/:integrationConfigurationId/billing/invoices/:invoiceId/get.md)

---

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