Skip to main content
GET
/
api
/
v1
/
invoices
List Invoices
curl --request GET \
  --url https://business.coinbase.com/api/v1/invoices \
  --header 'Authorization: Bearer <token>'
{
  "invoices": [
    {
      "uuid": "750a84dd-2460-504c-8bb9-f6fa731a2361",
      "invoiceNumber": "INV-1234",
      "contactName": "John Doe",
      "contactEmail": "[email protected]",
      "lineItems": [
        {
          "itemName": "Web Development Services",
          "quantity": 10,
          "unitPrice": {
            "value": "100.50",
            "currency": "USDC"
          }
        }
      ],
      "totalAmountDue": {
        "value": "100.50",
        "currency": "USDC"
      },
      "status": "OPEN",
      "createdAt": "2024-03-20T10:30:00Z",
      "updatedAt": "2024-03-20T10:30:00Z",
      "createdBy": "750a84dd-2460-504c-8bb9-f6fa731a2361",
      "lastUpdatedBy": "750a84dd-2460-504c-8bb9-f6fa731a2361",
      "entityName": "Acme Corporation",
      "contactAddress": {
        "addressLine1": "123 Main Street",
        "city": "San Francisco",
        "country": "US",
        "addressLine2": "Suite 400",
        "state": "CA",
        "postalCode": "94103"
      },
      "purchaseOrderNumber": "PO-5678",
      "dueDate": "2024-03-20T10:30:00Z",
      "sendDate": "2024-03-20T10:30:00Z",
      "invoiceDate": "2024-03-20T10:30:00Z",
      "discount": {
        "value": "100.50",
        "currency": "USDC"
      },
      "tax": {
        "value": "100.50",
        "currency": "USDC"
      },
      "privateNotes": "Internal memo about this invoice",
      "memo": "Thank you for your business!",
      "footer": "Payment terms: Net 30",
      "recurringInvoicePlanId": "68f7a946db0529ea9b6d3a12",
      "paymentMethod": {
        "crypto": {
          "paymentLinkUrl": "https://pay.coinbase.com/pl_01h8441j23abcd1234567890ef",
          "paymentLinkId": "68f7a946db0529ea9b6d3a12"
        }
      },
      "entityAddress": {
        "addressLine1": "123 Main Street",
        "city": "San Francisco",
        "country": "US",
        "addressLine2": "Suite 400",
        "state": "CA",
        "postalCode": "94103"
      }
    }
  ],
  "nextPageToken": "eyJsYXN0X2lkIjogImFiYzEyMyIsICJ0aW1lc3RhbXAiOiAxNzA3ODIzNzAxfQ=="
}

Authorizations

​
Authorization
string
header
required

A JWT signed using your CDP API Key Secret, encoded in base64. Refer to the Generate Bearer Token section of our Authentication docs for information on how to generate your Bearer Token.

Query Parameters

​
pageSize
integer
default:20

The number of items to return per page.

Required range: 1 <= x <= 100
​
pageToken
string

The token for the next page of items. This should only be populated using the nextPageToken value from the previous response.

​
status
enum<string>

Filter invoices by status. The status of the invoice.

  • DRAFT - Invoice is in draft state and has not been sent.
  • OPEN - Invoice has been sent and is awaiting payment.
  • SCHEDULED - Invoice is scheduled to be sent at a future date.
  • PAID - Invoice has been paid in full.
  • VOID - Invoice has been voided and is no longer valid.
  • OVERDUE - Invoice is past its due date and has not been paid.
Available options:
DRAFT,
OPEN,
SCHEDULED,
PAID,
VOID,
OVERDUE
Example:

"OPEN"

​
contactEmail
string<email>

Filter invoices by contact email address.

Example:

"[email protected]"

​
sortBy
enum<string>
default:createdAt

Field to sort results by. Results are always returned in descending order (most recent first).

Available options:
createdAt,
updatedAt,
dueDate,
sendDate

Response

Invoices retrieved successfully.

​
invoices
object[]
required
​
nextPageToken
string

The token for the next page of items, if any.

Example:

"eyJsYXN0X2lkIjogImFiYzEyMyIsICJ0aW1lc3RhbXAiOiAxNzA3ODIzNzAxfQ=="