API

Every chaser.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Credit Notes

list

creditNotes.list List all credit notes Risk: read

await corsair.chaser.api.creditNotes.list({});

Input

Name	Type	Required	Description
`page`	`number`	No	—
`limit`	`number`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`total`	`number`	No	—

data full type

{
  id: string,
  customer_id: string,
  amount: number,
  currency: string,
  status: string
}[]

Customers

list

customers.list List all customers Risk: read

await corsair.chaser.api.customers.list({});

Input

Name	Type	Required	Description
`page`	`number`	No	—
`limit`	`number`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`total`	`number`	No	—

data full type

{
  id: string,
  name: string,
  email?: string,
  status?: string
}[]

Invoices

get

invoices.get Get an invoice by ID Risk: read

await corsair.chaser.api.invoices.get({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`customer_id`	`string`	Yes	—
`amount`	`number`	Yes	—
`currency`	`string`	Yes	—
`status`	`string`	Yes	—
`due_date`	`string`	No	—

list

invoices.list List all invoices Risk: read

await corsair.chaser.api.invoices.list({});

Input

Name	Type	Required	Description
`page`	`number`	No	—
`limit`	`number`	No	—
`customer_external_id`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`total`	`number`	No	—

data full type

{
  id: string,
  customer_id: string,
  amount: number,
  currency: string,
  status: string,
  due_date?: string
}[]

Organization

get

organization.get Get organization details Risk: read

await corsair.chaser.api.organization.get({});

Input: empty object Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	Yes	—
`email`	`string`	No	—

Overview

Plugins

Credit Notes

list

Customers

list

Invoices

get

list

Organization

get

​Credit Notes

​list

​Customers

​list

​Invoices

​get

​list

​Organization

​get

Credit Notes

list

Customers

list

Invoices

get

list

Organization

get