Billing Charges

Billing Charges API Docs

Endpoint

https://api.payload.co/billing_charges

Nested Objects

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

Example

{
  "id": "bcrg_109Y5P5rz2DuEZquxrmMAPBvE",
  "object": "billing_charge",
  "amount": 225.22,
  "attrs": {},
  "billing_schedule_id": "bscd_EPIED8e9AlKXb5xLPreQLeZ3",
  "created_at": "2021-07-07 23:19:32",
  "description": "string",
  "modified_at": "2021-07-07 23:19:32",
  "qty": 278.39,
  "total": 984.41,
  "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
modified_at
datetime readonly
Timestamp object was last updated
qty
number
Quantity of the item
total
number readonly
Total amount of charge
type
string
Arbitrary type classification