Attributes

AttributeDescription
id intThe unique internal ID of the bill
account_id intUnique identifier of the account expandable
user_id intUnique identifier of the vendor (user with vendor type) expandable
amount_due intFinal amount due for this bill, in cents. This represents the total amount owed to the vendor.
amount_paid intThe amount that was paid to the vendor, in cents.
amount_remaining intThe amount remaining that is due to the vendor, in cents.
currency stringThree-letter ISO currency code.
created timestampTime at which the bill was created. Measured in seconds since the Unix epoch.
description stringAn arbitrary string attached to the object. Often useful for displaying to vendors or for internal notes.
footer stringFooter text that appears at the bottom of the bill PDF.
finalized_at timestampTime at which the bill status transitioned to open. Measured in seconds since the Unix epoch.
hosted_bill_url stringThe URL for the hosted bill page, which allows viewing the bill details. If the bill has not been finalized yet, this will be null.
bill_pdf stringThe link to download the PDF for the bill. If the bill has not been finalized yet, this will be null.
metadata objectA set of key-value pairs that you can attach to a bill object. This can be useful for storing additional information about the bill in a structured format.
number stringA unique, identifying string that appears on the bill for reference purposes.
paid boolWill be set to true if payment was successfully made for this bill. Still available for legacy purposes, please look for paid value on status attribute instead.
period_start timestampIf set, represents the start of the bill's billing period. Measured in seconds since the Unix epoch.
period_end timestampIf set, represents the end of the bill's billing period. Measured in seconds since the Unix epoch.
purchase_order stringA purchase order number associated with this bill, if applicable.
status stringThe status of the bill, one of: draft, open, or paid
subtotal intTotal of all line items on the bill before any tax is applied, in cents.
total intTotal after taxes, in cents.
paid_at timestampTime at which the bill status transitioned to paid. Measured in seconds since the Unix epoch.
voided_at timestampTime at which the bill was voided, if applicable. Measured in seconds since the Unix epoch.
created_at timestampTime at which the object was created. Measured in seconds since the Unix epoch.
updated_at timestampTime at which the object was last updated. Measured in seconds since the Unix epoch.
deleted_at timestampIf set, the time at which the object was deleted. Measured in seconds since the Unix epoch.