object BillingCharge
Fields
| Field | Type | Description |
|---|---|---|
id | String | Public API ID for this identifiable. |
legacy_id | BigInt | Numeric legacy ID for this identifiable; use only where legacy IDs are required. |
confirmation_date | DateTime | Confirmation date in ISO-8601 format. |
charge_label | String | Configured label for this charge. |
category | String | Billing category for this charge. |
quantity | Int | Number of billable units. |
rate_amount | Decimal | Rate per billable unit. |
amount | Decimal | Total charge amount. |
customer_account_id | String | Public API Account ID for the billed customer. |
customer_name | String | Display name of the billed customer. |
warehouse_id | String | Public API Warehouse ID associated with the charge. |
warehouse_from | String | Display name of the warehouse associated with the charge. |
status | BillingChargeStatus | Current invoice status of the charge. |
transaction_type | BillingChargeTransactionType | Billing transaction type. |
Referenced By
- BillingChargeEdge Type
Example
{
"id": "UmVjb3JkOjEyMzQ=",
"legacy_id": 1234,
"confirmation_date": "2026-07-09T15:30:00Z",
"charge_label": "receiving_fee",
"category": "inbound",
"quantity": 2,
"rate_amount": 19.99,
"amount": 39.98,
"customer_account_id": "QWNjb3VudDoxMjM0",
"customer_name": "Acme Brand",
"warehouse_id": "V2FyZWhvdXNlOjEyMzQ=",
"warehouse_from": "Primary Warehouse",
"status": "READY_TO_INVOICE",
"transaction_type": "INBOUND"
}