Bearer authentication header of the form `Bearer <token>`, where `<token>` is your auth token.

Bearer Auth

Get a refund

Parameters

Plane Documentation

Dashboard

Support

Retrieve the details of an existing refund.

Authentication

Pagination

Idempotency

Errors

Workspaces

Workspace

Entities

Entity

Contracts

Contract

Projects

Project

Checklists

Checklist

Tasks

Task

Workflows

Workflow

Approvals

Approval

Sources

Source

Worker object

Worker

Create a worker

Returns a list of all workers in your Plane workspace.

List workers

Retrieve the details of an existing worker.

Get a worker

Invite a worker to set up their account on Plane.

Invite a worker

Employment object

Employment

Compensation object

Compensation

Classification object

Classification

Location object

Location

Role object

Role

Reporting object

Reporting

Payment object

Payment

To send funds to a worker on Plane, you create a new payment object.

Create a payment

Returns a list of all payments in your Plane workspace.

List payments

Retrieve the details of an existing payment.

Get a payment

Cancel a payment

Payment Request object

Payment Request

Returns a list of all payment requests in your Plane workspace.

List payment requests

Retrieve the details of an existing payment request.

Get a payment request

Approve a payment request

Decline a payment request

Pay a payment request

Charge object

Charge

Create a charge

Returns a list of all charges in your Plane workspace.

List charges

Retrieve the details of an existing charge.

Get a charge

Refund object

Refund

Returns a list of all refunds in your Plane workspace.

List refunds

Payroll object

Payroll

Payroll Change object

Payroll Change

Working with the API

Core Resources

Workers

Payments

Payroll

Get a refund

Parameters

Working with the API

Core Resources

Workers

Payments

Payroll

​Parameters

Parameters