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

Authentication using Bearer tokens. Include your API key in the Authorization header.

Key Types:

  • Test Keys: sk_test_* for development and testing
  • Live Keys: sk_* for production environments
  • Public Keys: pk_test_* or pk_* for client-side operations

📩 Need access? Contact Support to request your API keys.

Usage:

Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc

Path Parameters

​
bill
required

Bill identifier - either the unique ID provided by Moment or the external reference provided by the merchant.

The unique ID provided by Moment to identify this bill

Example:

"bill_H4jp6KnU5cPw263v1jyz4"

Body

application/json

Request payload for updating an existing bill

Response

200
application/json

Bill updated successfully

A bill represents a payment request that can be associated with a customer or specific account.