Skip to main content
PATCH
/
billing
/
bills
/
{bill}
curl --request PATCH \
  --url https://api.momentco.io/billing/bills/{bill} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount_paid": 1500,
  "metadata": {
    "payment_method": "bank_transfer",
    "payment_reference": "TXN123456789"
  }
}'
{
  "id": "bill_H4jp6KnU5cPw263v1jyz4",
  "external_reference": "UBR1234567890",
  "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": 2000,
    "underpayment_allowed": true,
    "overpayment_allowed": false
  },
  "metadata": {
    "invoice_period": "January 2025",
    "service_type": "subscription",
    "payment_method": "bank_transfer",
    "payment_reference": "TXN123456789"
  }
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
bill
required
Example:

Body

application/json
​
currency
string
Example:
​
amount_paid
integer
Required range: 0 <= x <= 99999999
Example:
​
metadata
object
Example:

Response

​
id
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
​
metadata
object
Example: