Invoices

Invoices API Docs

Endpoint

https://api.payload.co/invoices

Nested Objects

https://api.payload.co/invoices/{id}/attachments

https://api.payload.co/invoices/{id}/billing_schedule

https://api.payload.co/invoices/{id}/customer

https://api.payload.co/invoices/{id}/items

https://api.payload.co/invoices/{id}/processing_settings

Example

{
  "id": "inv_HhRHXU9Vw7QvgLydEgydVRo3",
  "object": "invoice",
  "amount_due": 978.91,
  "attachments": [],
  "attrs": {},
  "billing_schedule_id": "bscd_JyYiN9DuVt2lK4Uh20ptpvYd",
  "created_at": "2021-07-07 23:19:31",
  "customer_id": "acct_1ZLhKNrL6n6HRKYOyA1U7ijkx",
  "description": "string",
  "due_date": "2021-07-07",
  "items": [],
  "modified_at": "2021-07-07 23:19:31",
  "paid_timestamp": "2021-07-07",
  "processing_id": "acct_SwWF6kJsfA52Jo5AKfHvHwMD",
  "processing_settings_id": "ps_85XNmDiHh9aLzsKGH8Ngephx",
  "status": "unpaid",
  "total_due": 571.28,
  "total_paid": 53.93,
  "type": "string",
  "billing_contact": {
    "city": "string",
    "email": "string",
    "name": "string",
    "postal_code": "string",
    "state_province": "string",
    "street_address1": "string"
  }
}
Attributes Description
id
string readonly
Object ID
object
string readonly
Value: invoice
amount_due
number readonly
Remaining amount due
attachments
list
Array of associated Invoice Attachment objects
attrs
json
Custom object attributes
billing_schedule_id
id
ID of the associated Billing Schedule object
created_at
datetime readonly
Timestamp object was created
customer_id
id required
ID of the associated Customer Account object
description
string
Description of the invoice
due_date
date required
Date the invoice is due
items
list
Array of associated Line Item objects
modified_at
datetime readonly
Timestamp object was last updated
paid_timestamp
date readonly
Timestamp invoice was fully paid
processing_id
id
ID of the associated Processing Account object
processing_settings_id
id readonly
ID of the processing settings object
status
string
Values: unpaid partially_paid paid canceled
total_due
number readonly
Total amount due
total_paid
number readonly
Total amount paid
type
string
Arbitrary type classification
billing_contact:  
city
string readonly
City of the billing contact
email
string readonly
Email of the billing contact
name
string readonly
Name of the billing contact
postal_code
string readonly
Zipcode of the billing contact
state_province
string readonly
State of the billing contact
street_address1
string readonly
Street address of the billing contact