Companies

Cancel a company's plan invoice

Changed on

Cancels a plan invoice awaiting payment, the same as Cancel invoice in the company plan dialog: a recurring invoice stops recurring, the Stripe invoice is voided, and the company can be assigned or invoiced again. Canceling an invoice that is already canceled returns it unchanged. Requires an Idempotency-Key header and plans.manage.

post/companies/{id}/plan-invoices/{invoiceId}/cancel

Request

  • Base URL: https://api.cavuno.com/v1
  • URL: https://api.cavuno.com/v1/companies/{id}/plan-invoices/{invoiceId}/cancel
  • 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.

invoiceIdstring required

The plan invoice ID returned by the list or create call.

Response

The plan invoice after the cancel.

idstring required

The plan invoice ID.

object'company_plan_invoice' required
companyIdstring required
planIdstring required
planNamestring nullable required
status'issued' | 'paid' | 'canceled' | 'uncollectible' required

issued: awaiting payment. paid: paid, and the plan was assigned to the company. canceled: canceled before payment. uncollectible: marked uncollectible in Stripe.

amountCentsinteger required

Amount per invoice, in currency minor units.

currencystring required

Lowercase ISO 4217 currency code.

billingInterval'month' | 'year' nullable required

Null for a one-off invoice; otherwise how often it recurs.

billingIntervalCountinteger nullable required

Number of intervals between invoices (3 months = quarterly).

contactEmailstring required

The billing email the invoice is for.

hostedInvoiceUrlstring nullable required

The payment page for the employer. Cavuno does not send the invoice itself; share this link with them.

dueAtstring nullable required

ISO-8601 due date (30 days after issue).

assignmentIdstring nullable required

The plan assignment created when the invoice was paid; null until then.

createdAtstring required

ISO-8601 creation time.

updatedAtstring required

ISO-8601 time of the last change.

Changes