Skip to main content
GET
/
api
/
v1
/
invoices
/
{invoiceUuid}
Get Invoice
curl --request GET \
  --url https://business.coinbase.com/api/v1/invoices/{invoiceUuid} \
  --header 'Authorization: Bearer <token>'
{
  "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"
  }
}

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.

Path Parameters

​
invoiceUuid
string<uuid>
required

The unique invoice identifier (UUID).

Example:

"750a84dd-2460-504c-8bb9-f6fa731a2361"

Response

Invoice retrieved successfully.

​
uuid
string<uuid>
required

Unique invoice identifier (UUID).

Example:

"750a84dd-2460-504c-8bb9-f6fa731a2361"

​
invoiceNumber
string
required

Human-readable invoice number.

Example:

"INV-1234"

​
contactName
string
required

Contact name.

Example:

"John Doe"

​
contactEmail
string<email>
required

Contact email address.

Example:

"[email protected]"

​
lineItems
object[]
required

List of line items on the invoice.

​
totalAmountDue
object
required
​
status
enum<string>
required

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"

​
createdAt
string<date-time>
required

Timestamp in RFC 3339 format.

Example:

"2024-03-20T10:30:00Z"

​
updatedAt
string<date-time>
required

Timestamp in RFC 3339 format.

Example:

"2024-03-20T10:30:00Z"

​
createdBy
string
required

User UUID of the person who created the invoice.

Example:

"750a84dd-2460-504c-8bb9-f6fa731a2361"

​
lastUpdatedBy
string
required

User UUID of the person who last updated the invoice.

Example:

"750a84dd-2460-504c-8bb9-f6fa731a2361"

​
entityName
string
required

Business name associated with the entity (populated at invoice creation).

Example:

"Acme Corporation"

​
contactAddress
object

Billing address of the customer/contact being invoiced.

​
purchaseOrderNumber
string

Purchase order number reference.

Example:

"PO-5678"

​
dueDate
string<date-time>

Timestamp in RFC 3339 format.

Example:

"2024-03-20T10:30:00Z"

​
sendDate
string<date-time>

Timestamp in RFC 3339 format.

Example:

"2024-03-20T10:30:00Z"

​
invoiceDate
string<date-time>

Timestamp in RFC 3339 format.

Example:

"2024-03-20T10:30:00Z"

​
discount
object
​
tax
object
​
privateNotes
string

Private notes not visible to the customer.

Example:

"Internal memo about this invoice"

​
memo
string

Memo visible to the customer.

Example:

"Thank you for your business!"

​
footer
string

Footer text for the invoice.

Example:

"Payment terms: Net 30"

​
recurringInvoicePlanId
string

Reference to the recurring invoice plan if this invoice was generated from one.

Example:

"68f7a946db0529ea9b6d3a12"

​
paymentMethod
object

Payment method for the invoice. Currently, cryptocurrency payments are supported.

​
entityAddress
object

Business address of the entity issuing the invoice.