Cancel an invoice series

POST

invoices

series

{seriesId}

cancel

Cancel an invoice series

curl --request POST \
  --url https://api.slash.com/v2/invoices/series/{seriesId}/cancel \
  --header 'X-API-Key: <api-key>' \
  --header 'x-legal-entity: <x-legal-entity>'

const options = {
  method: 'POST',
  headers: {'x-legal-entity': '<x-legal-entity>', 'X-API-Key': '<api-key>'}
};

fetch('https://api.slash.com/v2/invoices/series/{seriesId}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.slash.com/v2/invoices/series/{seriesId}/cancel"

headers = {
    "x-legal-entity": "<x-legal-entity>",
    "X-API-Key": "<api-key>"
}

response = requests.post(url, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.slash.com/v2/invoices/series/{seriesId}/cancel"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("x-legal-entity", "<x-legal-entity>")
	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "id": "inv_series_2rj4l7hmrrrcv",
  "status": "active",
  "accountId": "<string>",
  "recurrence": {
    "type": "weekly",
    "dayOfWeek": 3
  },
  "startDate": "2023-12-25",
  "timezone": "America/New_York",
  "paymentTermsDays": 123,
  "end": {
    "type": "never"
  },
  "lineItems": [
    {
      "name": "Robot arm maintenance",
      "quantity": 2,
      "unitAmount": {
        "amount": 123,
        "currency": "<string>"
      },
      "total": {
        "amount": 123,
        "currency": "<string>"
      },
      "catalogItemId": "<string>"
    }
  ],
  "amounts": {
    "subtotal": {
      "amount": 123,
      "currency": "<string>"
    },
    "discount": {
      "amount": 123,
      "currency": "<string>"
    },
    "tax": {
      "amount": 123,
      "currency": "<string>"
    },
    "total": {
      "amount": 123,
      "currency": "<string>"
    }
  },
  "ccEmails": [
    "<string>"
  ],
  "paymentMethods": [
    {
      "type": "bank_transfer",
      "passFeeToPayer": true
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "customerId": "<string>",
  "virtualAccountId": "<string>",
  "discount": {
    "type": "percentage",
    "percent": 10
  },
  "taxRate": 123,
  "memo": "<string>",
  "nextInvoiceDate": "2023-12-25",
  "nextInvoiceId": "<string>"
}

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

Authorizations

X-API-Key

string

header

required

User API key authentication. Create a key under Settings → API keys in the Slash dashboard (https://app.slash.com/global-settings/api-keys) and send the x-legal-entity header naming the legal entity to act on with every request. Keys scoped to a legal entity are rejected with 403 user_api_key_required.

Headers

x-legal-entity

string

required

The legal entity to act on. Required on every request; a user API key can act on any legal entity its user has access to.

Pattern: ^le_[a-zA-Z0-9]+$

Path Parameters

seriesId

string

required

Series id with the inv_series_ prefix.

Response

The cancelled series.

Issues the same invoice to a customer on a schedule. Each invoice is created scheduled ahead of its send date, is sent at 9:00 in the series' timezone, and then behaves like any other invoice. All amounts are in USD.

string

required

Series id with the inv_series_ prefix.

Example:

"inv_series_2rj4l7hmrrrcv"

status

enum<string>

required

See How a series works.

Available options:

active,

ended,

cancelled

accountId

string

required

The account payments settle into, with the sa_group_ prefix.

recurrence

Weekly · object

required

Which days the series issues an invoice on.

Weekly
Monthly on a date
Monthly on a weekday

Hide child attributes

recurrence.type

enum<string>

required

Available options:

weekly

recurrence.dayOfWeek

integer

required

0 is Sunday.

Required range: 0 <= x <= 6

startDate

string<date>

required

The first day the series can issue an invoice on.

timezone

string

required

The IANA timezone the series' dates are in.

Example:

"America/New_York"

paymentTermsDays

integer

required

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

end

Never · object

required

When the series stops issuing invoices.

Never
After a number of invoices
On a date

Hide child attributes

end.type

enum<string>

required

Available options:

never

lineItems

InvoiceLineItem · object[]

required

Hide child attributes

lineItems.name

string

required

Example:

"Robot arm maintenance"

lineItems.quantity

number

required

Example:

2

lineItems.unitAmount

Money · object

required

A signed monetary amount expressed in minor units.

Hide child attributes

lineItems.unitAmount.amount

integer

required

Amount in the currency's minor units.

lineItems.unitAmount.currency

string

required

Uppercase ISO 4217 currency code.

Pattern: ^[A-Z]{3}$

lineItems.total

Money · object

required

quantity times unitAmount.

Hide child attributes

lineItems.total.amount

integer

required

Amount in the currency's minor units.

lineItems.total.currency

string

required

Uppercase ISO 4217 currency code.

Pattern: ^[A-Z]{3}$

lineItems.catalogItemId

string

The catalog item the line was added from, with the cat_item_ prefix. The line keeps the name and price it was written with.

amounts

object

required

Each invoice's amounts.

Hide child attributes

amounts.subtotal

Money · object

required

A signed monetary amount expressed in minor units.

Hide child attributes

amounts.subtotal.amount

integer

required

Amount in the currency's minor units.

amounts.subtotal.currency

string

required

Uppercase ISO 4217 currency code.

Pattern: ^[A-Z]{3}$

amounts.discount

Money · object

required

A signed monetary amount expressed in minor units.

Hide child attributes

amounts.discount.amount

integer

required

Amount in the currency's minor units.

amounts.discount.currency

string

required

Uppercase ISO 4217 currency code.

Pattern: ^[A-Z]{3}$

amounts.tax

Money · object

required

A signed monetary amount expressed in minor units.

Hide child attributes

amounts.tax.amount

integer

required

Amount in the currency's minor units.

amounts.tax.currency

string

required

Uppercase ISO 4217 currency code.

Pattern: ^[A-Z]{3}$

amounts.total

Money · object

required

A signed monetary amount expressed in minor units.

Hide child attributes

amounts.total.amount

integer

required

Amount in the currency's minor units.

amounts.total.currency

string

required

Uppercase ISO 4217 currency code.

Pattern: ^[A-Z]{3}$

ccEmails

string[]

required

paymentMethods

InvoicePaymentMethod · object[]

required

Hide child attributes

paymentMethods.type

enum<string>

required

bank_transfer (ACH, wire or realtime payment to the account's details) is always offered.

Available options:

bank_transfer,

ach_debit,

card,

crypto

paymentMethods.passFeeToPayer

boolean

required

Whether the payer covers the method's processing fee.

createdAt

string<date-time>

required

customerId

string

Customer id with the le_cus_ prefix.

virtualAccountId

string

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

discount

Percentage · object

Taken off the line items' subtotal before tax.

Percentage
Fixed

Hide child attributes

discount.type

enum<string>

required

Available options:

percentage

discount.percent

number

required

Percent of the subtotal. 10 means 10%.

Example:

10

taxRate

number

Tax as a percent of the subtotal after the discount.

memo

string

nextInvoiceDate

string<date>

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

nextInvoiceId

string

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

⌘I

Cancel an invoice series

curl --request POST \
  --url https://api.slash.com/v2/invoices/series/{seriesId}/cancel \
  --header 'X-API-Key: <api-key>' \
  --header 'x-legal-entity: <x-legal-entity>'

const options = {
  method: 'POST',
  headers: {'x-legal-entity': '<x-legal-entity>', 'X-API-Key': '<api-key>'}
};

fetch('https://api.slash.com/v2/invoices/series/{seriesId}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.slash.com/v2/invoices/series/{seriesId}/cancel"

headers = {
    "x-legal-entity": "<x-legal-entity>",
    "X-API-Key": "<api-key>"
}

response = requests.post(url, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.slash.com/v2/invoices/series/{seriesId}/cancel"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("x-legal-entity", "<x-legal-entity>")
	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "id": "inv_series_2rj4l7hmrrrcv",
  "status": "active",
  "accountId": "<string>",
  "recurrence": {
    "type": "weekly",
    "dayOfWeek": 3
  },
  "startDate": "2023-12-25",
  "timezone": "America/New_York",
  "paymentTermsDays": 123,
  "end": {
    "type": "never"
  },
  "lineItems": [
    {
      "name": "Robot arm maintenance",
      "quantity": 2,
      "unitAmount": {
        "amount": 123,
        "currency": "<string>"
      },
      "total": {
        "amount": 123,
        "currency": "<string>"
      },
      "catalogItemId": "<string>"
    }
  ],
  "amounts": {
    "subtotal": {
      "amount": 123,
      "currency": "<string>"
    },
    "discount": {
      "amount": 123,
      "currency": "<string>"
    },
    "tax": {
      "amount": 123,
      "currency": "<string>"
    },
    "total": {
      "amount": 123,
      "currency": "<string>"
    }
  },
  "ccEmails": [
    "<string>"
  ],
  "paymentMethods": [
    {
      "type": "bank_transfer",
      "passFeeToPayer": true
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "customerId": "<string>",
  "virtualAccountId": "<string>",
  "discount": {
    "type": "percentage",
    "percent": 10
  },
  "taxRate": 123,
  "memo": "<string>",
  "nextInvoiceDate": "2023-12-25",
  "nextInvoiceId": "<string>"
}

Banking

Money movement

Bill pay

Invoicing

Accounting

Platform

Cancel an invoice series

Authorizations

Headers

Path Parameters

Response