Skip to main content
Source objects represent the funding methods connected to your Plane account. When you need to make a payment, Plane creates a charge against one of your sources to collect the money. If a payment needs to be reversed, Plane processes a refund back to the original source. Your sources can be either external bank accounts or your Plane balance (funds you’ve preloaded). You can connect multiple sources and designate one as your default to streamline the payment process.

​
Attributes

​
id
string
required
Unique identifier for the source object.
​
name
string
required
A descriptive name for the source that helps you identify it in your dashboard and API responses.
​
type
string
required
The type of funding source. Possible values: bank (connected bank account) or balance (your Plane account balance).
​
currency
string
required
The three-letter ISO currency code that this source supports (e.g., USD, EUR, GBP).
​
status
string
required
The current status of the source. Possible values: pending (being verified), verified (active and ready to use), disabled (temporarily disabled), or removed (permanently removed).
​
default
boolean
required
Indicates whether this source is set as the default funding method for your account. Only one source per workspace can be marked as default.
​
metadata
object
Set of key-value pairs that you can attach to the source object. This can be useful for storing additional information about the source in a structured format.
​
workspace
string
required
The unique identifier of the workspace that owns this source.
​
created
timestamp
required
ISO 8601 formatted timestamp indicating when the source was created.
​
updated
timestamp
required
ISO 8601 formatted timestamp indicating when the source was last modified.
{
  "id": "src_mEX4cw7VrLMsje9tzNvZKpHj",
  "name": "Chase Business Account",
  "type": "bank",
  "currency": "USD",
  "status": "verified",
  "default": true,
  "metadata": {},
  "workspace": "wsp_1di2DQuiZgk8rv",
  "created": "2024-01-15T10:30:00Z",
  "updated": "2024-01-15T10:30:00Z"
}
1

Pending

When you first add a source to your account, it starts in pending status while Plane verifies the funding method.
Bank accounts typically require 1-2 business days for verification through micro-deposits or instant verification methods.
2

Verified

Once verification is complete, the source moves to verified status and becomes available for payments.
You can now use this source for charges and it will appear in your available funding methods.
3

Removed

Sources can be permanently removed from your account when they are no longer needed.
If you remove a source, you’ll need to verify it again if you want to add it back to your account.