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 âś“ âś“