SLslashfi

Cancel an invoice series

Changed on

Stop an active series. Its scheduled invoice is voided, and invoices already sent are left as they are. See Skip or cancel.

post/v2/invoices/series/{seriesId}/cancel

Request

  • Base URL
    https://api.slash.com
  • URL
    https://api.slash.com/v2/invoices/series/{seriesId}/cancel
  • Auth
    API key in header X-API-Key

Response

The cancelled series.

idstring required

Series id with the inv_series_ prefix.

status'active' | 'ended' | 'cancelled' required

See How a series works.

customerIdstring

Customer id with the le_cus_ prefix.

accountIdstring required

The account payments settle into, with the sa_group_ prefix.

virtualAccountIdstring

The virtual account payments settle into, with the subaccount_ prefix. Absent when they settle into the account's primary virtual account.

startDatestring date required

The first day the series can issue an invoice on.

timezonestring required

The IANA timezone the series' dates are in.

paymentTermsDaysinteger required

Each invoice is due this many days after it's issued.

taxRatenumber

Tax as a percent of the subtotal after the discount.

memostring
ccEmailsstring[] required
nextInvoiceDatestring date

When the next invoice goes out. Only on active series.

nextInvoiceIdstring

The next invoice, already created as scheduled, with the inv_ prefix. Only on active series.

createdAtstring date-time required

Example response

{
  "id": "inv_series_2rj4l7hmrrrcv",
  "timezone": "America/New_York",
  "lineItems": [
    {
      "name": "Robot arm maintenance",
      "quantity": 2
    }
  ],
  "discount": {
    "percent": 10
  }
}

Changes