Bill object

string

required

Example:

external_reference

string

required

Maximum length: 255

Example:

customer_id

string

required

Example:

status

enum<string>

required

Available options:

unpaid,

paid,

voided

Example:

currency

string

required

Example:

amount_due

integer

required

Required range: 1 <= x <= 99999999

Example:

amount_paid

integer

required

Required range: 0 <= x <= 99999999

Example:

amount_remaining

integer

required

Required range: 0 <= x <= 99999999

Example:

account_id

string

Example:

bill_date

string<date>

Example:

due_date

string<date>

Example:

payment_rules

object

Show child attributes

metadata

object

Example:

Create a BillCreates a new bill for a customer or account. Bills represent payment requests that can be associated directly with customers or with specific accounts under customers.

⌘I

{
  "id": "bill_H4jp6KnU5cPw263v1jyz4",
  "external_reference": "INV-2024-001",
  "customer_id": "bcus_H4jp6KnU5cPw263v1jyz4",
  "account_id": "bacc_H4jp6KnU5cPw263v1jyz4",
  "status": "unpaid",
  "currency": "ZAR",
  "amount_due": 2000,
  "amount_paid": 1500,
  "amount_remaining": 500,
  "bill_date": "2025-01-01",
  "due_date": "2025-01-31",
  "payment_rules": {
    "min_amount": 100,
    "max_amount": 1000000,
    "underpayment_allowed": true,
    "overpayment_allowed": false
  },
  "metadata": {
    "customer_id": "cust_123456",
    "order_id": "ord_789012"
  }
}

Collect

Billing

Technical Guides