Billing Charges

https://api.payload.com/billing_charges

Nested Objects

https://api.payload.com/billing_charges/{id}/billing_schedule

Example

{
  "id": "bcrg_XnysOxsyXcdrGOsuhJgJU2Jg",
  "object": "billing_charge",
  "amount": 182.92,
  "attrs": {},
  "billing_schedule_id": "bscd_1SLGY8tCamm1UPDaIdbCVWbTH",
  "created_at": "2024-06-13 21:20:59",
  "description": "string",
  "end_date": "2024-06-13",
  "modified_at": "2024-06-13 21:20:59",
  "qty": 829.12,
  "start_date": "2024-06-13",
  "total": 280.63,
  "type": "string"
}

Attributes	Description
`id` string readonly	Object ID
`object` string readonly	Value: billing_charge
`amount` number required	Amount of the charge
`attrs` json	Custom object attributes
`billing_schedule_id` id required	ID of the associated Billing Schedule object
`created_at` datetime readonly	Timestamp object was created
`description` string	Description of charge
`end_date` date	End date for when this charge should be applied
`modified_at` datetime readonly	Timestamp object was last updated
`qty` number	Quantity of the item
`start_date` date	Start date for when this charge should be applied
`total` number readonly	Total amount of charge
`type` string	Arbitrary type classification