Bills

Bills are payment requests addressed to specific buyers. Bill line items have fixed prices, typically denominated in fiat currency.

Resource

Name Type Facade
pos merchant
facade
This field indicates the facade from which the bill is being requested:

  • "pos/bill" if the pos facade is used to request an invoice resource
  • "merchant/bill" if the merchant facade is used to request an invoice resource

string ✓ ✓
data
bill data object
object ✓ ✓
status
Can "draft", "sent", "new", "paid", or "complete"
string ✓ ✓
url
Web address of bill
string ✓ ✓
number
Bill identifier, specified by merchant
string ✓ ✓
createdDate
Date and time of Bill creation, ISO-8601 format yyyy-mm-ddThh:mm:ssZ. (UTC)
string ✓ ✓
dueDate
Date and time at which a bill is due, ISO-8601 format yyyy-mm-ddThh:mm:ssZ. (UTC)
string ✓ ✓
currency
ISO 4217 3-character currency code. This is the currency associated with the price field
string ✓ ✓
name
Bill recipient's name
string ✓
address1
Bill recipient's address
string ✓
address2
Bill recipient's address
string ✓
city
Bill recipient's city
string ✓
state
Bill recipient's state or province
string ✓
zip
Bill recipient's ZIP code
string ✓
country
Bill recipient's country
string ✓
email
Bill recipient's email address
string ✓ ✓
cc
Email addresses to which a copy of the bill must be sent
array ✓ ✓
phone
Bill recipient's phone number
string ✓
passProcessingFee
If set to true, BitPay's processing fee will be included in the amount charged on the invoice
boolean ✓ ✓
id
Bill resource id
string ✓ ✓
merchant
Internal identifier for BitPay, this field can be ignored by the merchants.
string ✓
items
List of line items
array ✓ ✓
id
item resource Id
string ✓ ✓
description
Line item description
string ✓ ✓
price
Line item unit price for the corresponding currency
number ✓ ✓
quantity
Line item number of units
number ✓ ✓
token
API token for bill resource. This token is actually derived from the API token used to create the bill and is tied to the specific resource id created.
string ✓ ✓