The Bank Account Subtype object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

account_subtype string
The Bank Account Subtype object 
{
  "id": "bank-account-subtype_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "account_subtype": "account_subtype_example"
}
GET /api/accounts/bank-account-subtype/{id}

Retrieve a bank account subtype

Retrieves the details of an existing bank account subtype. Supply the unique bank account subtype ID that was returned from a previous request.

Path parameters

id string required

The identifier of the bank account subtype to retrieve.

Returns

Returns the bank account subtype object if a valid identifier was provided.

GET /api/accounts/bank-account-subtype/{id} 
curl https://api.overplane.dev/api/accounts/bank-account-subtype/bank-account-subtype_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "bank-account-subtype_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "account_subtype": "account_subtype_example"
}
GET /api/accounts/bank-account-subtype

List all bank account subtypes

Returns a list of bank account subtypes. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of bank account subtype objects.

GET /api/accounts/bank-account-subtype 
curl https://api.overplane.dev/api/accounts/bank-account-subtype \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "bank-account-subtype_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "account_subtype": "account_subtype_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/accounts/bank-account-subtype

Create a bank account subtype

Creates a new bank account subtype object.

Body parameters

account_subtype string

Returns

Returns the newly created bank account subtype object if the call succeeded.

POST /api/accounts/bank-account-subtype 
curl https://api.overplane.dev/api/accounts/bank-account-subtype \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json"
Response 
{
  "id": "bank-account-subtype_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "account_subtype": "account_subtype_example"
}
PATCH /api/accounts/bank-account-subtype/{id}

Update a bank account subtype

Updates the specified bank account subtype by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the bank account subtype to update.

Body parameters

account_subtype string

Returns

Returns the updated bank account subtype object.

PATCH /api/accounts/bank-account-subtype/{id} 
curl https://api.overplane.dev/api/accounts/bank-account-subtype/bank-account-subtype_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"account_subtype":"account_subtype_example"}'
Response 
{
  "id": "bank-account-subtype_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "account_subtype": "account_subtype_example"
}
DELETE /api/accounts/bank-account-subtype/{id}

Delete a bank account subtype

Permanently deletes a bank account subtype. This cannot be undone.

Path parameters

id string required

The identifier of the bank account subtype to delete.

Returns

Returns a confirmation that the bank account subtype has been deleted.

DELETE /api/accounts/bank-account-subtype/{id} 
curl https://api.overplane.dev/api/accounts/bank-account-subtype/bank-account-subtype_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "bank-account-subtype_abc123",
  "deleted": true
}