Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.plane.com/llms.txt

Use this file to discover all available pages before exploring further.

Each time Plane collects funds from your company, we create a Charge on your account. For instance, if you schedule two payments for 10,000 USD, Plane will create a charge for 20,000 USD to fund those payments. A Charge can be created to fund a Payroll, Payment, Deposit or even your Plane subscription.

​
Attributes

​
id
string
Unique identifier for the charge.
​
source
string
ID of the source used to fund this charge.
​
date
string
Date of the charge.
​
amount
string
Amount of the charge, in decimal format.
​
currency
string
Three-letter ISO currency code, in uppercase.
​
status
string
The status of the charge. Possible values are pending, processing, succeeded, failed, cancelled or split.
​
reference
string
A reference for this charge visible on your bank statement.
​
note
string
An additional description of the charge.
{
  "id": "ch_oUEpLsdApEb3EGzEeYTBRvGv",
  "source": "src_CKC3YwrnW4x9AYpEwU8tSw6H",
  "date": "2023-09-01",
  "amount": "1283.50",
  "currency": "USD",
  "reference": "ODH8U1MX",
  "note": null,
  "metadata": {}
}