---
title: "GET /user/invoices/{invoice_id}"
method: GET
path: "/user/invoices/{invoice_id}"
---

# GET /user/invoices/{invoice_id}

`GET /user/invoices/{invoice_id}`

## Request

- Base URL: `https://developers.whmcs.com/api/v2`
- URL: `https://developers.whmcs.com/api/v2/user/invoices/{invoice_id}`
- Auth: none declared

Retrieve a specific invoice for the authenticated client.

Poll this endpoint while a payment clears. Payment is complete only when the status is `Paid`. A `Payment Pending` invoice (an in-progress ACH or SEPA direct debit, for example) has not completed.

To hand the shopper off to a WHMCS payment page, use the `POST /user/invoices/{invoice_id}/payment-link` endpoint.

## Path parameters

- `invoice_id` integer, required

## Response `200`

Invoice information.

- object
  - `data` Invoice, required
    - `id` integer, required
    - `invoice_number` string, nullable
    - `date_created` string, date, nullable
    - `date_due` string, date, nullable
    - `status` 'Draft' | 'Unpaid' | 'Payment Pending' | 'Paid' | 'Collections' | 'Cancelled' | 'Refunded', required: The payment lifecycle status. - `Paid` is the only accepted, terminal state. The order provisions on that transition. - `Payment Pending` indicates that payment is in progress but has not yet cleared. Keep polling until the status is `Paid`. Only `Unpaid` and `Collections` status invoices can be paid. The `POST /user/invoices/{invoice_id}/payment-link` and `POST /user/invoices/{invoice_id}/payment-session` endpoints refuse any other status with a `422` error.
    - `subtotal` number, float
    - `total` number, float
    - `balance` number, float
    - `payment_method` string, nullable

## Other responses

- `401`: Access Not Authorized
- `403`: The caller is authenticated but does not have permission to use this resource (the _View & Pay Invoices_ permission).
- `404`: Entity Not Found
- `default`: General Error

---

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