Companies

List a company's plan invoices

Changed on

Lists the plan invoices issued to a company, newest first. Poll it to see when an invoice is paid: the status becomes paid and assignmentId names the plan assignment it created. Cursor-paginated. Requires plans.read.

get/companies/{id}/plan-invoices

Request

  • Base URL: https://api.cavuno.com/v1
  • URL: https://api.cavuno.com/v1/companies/{id}/plan-invoices
  • Auth: HTTP bearer

Path parameters

idstring required

The company's opaque object id: the id field returned by the company endpoints (e.g. p17xq4c2b9r5gz3e8j0r6t4k7m2n9d5w). This is NOT the slug or display name; passing a slug like antler returns 404. To look up a company by name or slug, use GET /v1/companies, POST /v1/companies/search, or POST /v1/companies/find-or-create and read the returned id.

Query parameters

cursorstring
limitinteger

Response

A page of plan invoices.

object'list' required
urlstring required
hasMoreboolean required
nextCursorstring nullable required

Example response

{
  "url": "/v1/companies/{id}/plan-invoices"
}

Changes