GET
/
v1
/
entities
/
{entity_id}
/
invoices
List Invoices
curl --request GET \
  --url https://api.prime.coinbase.com/v1/entities/{entity_id}/invoices
{
  "invoices": [
    {
      "id": "<string>",
      "billing_month": 123,
      "billing_year": 123,
      "due_date": "<string>",
      "invoice_number": "<string>",
      "state": "INVOICE_STATE_UNSPECIFIED",
      "usd_amount_paid": 123,
      "usd_amount_owed": 123,
      "invoice_items": [
        {
          "description": "<string>",
          "currency_symbol": "<string>",
          "invoice_type": "INVOICE_TYPE_UNSPECIFIED",
          "rate": 123,
          "quantity": 123,
          "price": 123,
          "average_auc": 123,
          "total": 123
        }
      ]
    }
  ]
}

Use the Prime SDK or CLI to test this endpoint by following the quickstart guide and running with the following examples

InvoiceService invoiceService = PrimeServiceFactory.createInvoiceService(client);

ListInvoicesRequest request = new ListInvoicesRequest.Builder("ENTITY_ID_HERE").build();

ListInvoicesResponse response = invoiceService.listInvoices(request);

For more information, please visit the Prime Java SDK.

Path Parameters

​
entity_id
string
required

The entity ID

Query Parameters

​
states
enum<string>[]

Invoice states to filter the response

​
billing_year
integer

Filter invoices by year

​
billing_month
integer

Integer representing the month to filter by, 1 for January, 12 for December

​
cursor
integer

Cursor used for pagination (last consumed record)

​
limit
integer

Number of items to retrieve

Response

200 - application/json

A successful response.

The response is of type object.