Create an invoice series

POST

invoices

series

curl --request POST \
  --url https://api.slash.com/v2/invoices/series \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --header 'X-Idempotency-Key: <x-idempotency-key>' \
  --header 'x-legal-entity: <x-legal-entity>' \
  --data '
{
  "customerId": "le_cus_2rj4l7hmrrrcv",
  "recurrence": {
    "type": "monthly_day_of_month",
    "dayOfMonth": 1
  },
  "startDate": "2026-11-01",
  "timezone": "America/New_York",
  "paymentTermsDays": 30,
  "lineItems": [
    {
      "name": "Platform subscription",
      "quantity": 1,
      "unitAmount": {
        "amount": 99000,
        "currency": "USD"
      }
    }
  ]
}
'

const options = {
  method: 'POST',
  headers: {
    'X-Idempotency-Key': '<x-idempotency-key>',
    'x-legal-entity': '<x-legal-entity>',
    'X-API-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    customerId: 'le_cus_2rj4l7hmrrrcv',
    recurrence: {type: 'monthly_day_of_month', dayOfMonth: 1},
    startDate: '2026-11-01',
    timezone: 'America/New_York',
    paymentTermsDays: 30,
    lineItems: [
      {
        name: 'Platform subscription',
        quantity: 1,
        unitAmount: {amount: 99000, currency: 'USD'}
      }
    ]
  })
};

fetch('https://api.slash.com/v2/invoices/series', 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"

payload = {
    "customerId": "le_cus_2rj4l7hmrrrcv",
    "recurrence": {
        "type": "monthly_day_of_month",
        "dayOfMonth": 1
    },
    "startDate": "2026-11-01",
    "timezone": "America/New_York",
    "paymentTermsDays": 30,
    "lineItems": [
        {
            "name": "Platform subscription",
            "quantity": 1,
            "unitAmount": {
                "amount": 99000,
                "currency": "USD"
            }
        }
    ]
}
headers = {
    "X-Idempotency-Key": "<x-idempotency-key>",
    "x-legal-entity": "<x-legal-entity>",
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

package main

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

func main() {

	url := "https://api.slash.com/v2/invoices/series"

	payload := strings.NewReader("{\n  \"customerId\": \"le_cus_2rj4l7hmrrrcv\",\n  \"recurrence\": {\n    \"type\": \"monthly_day_of_month\",\n    \"dayOfMonth\": 1\n  },\n  \"startDate\": \"2026-11-01\",\n  \"timezone\": \"America/New_York\",\n  \"paymentTermsDays\": 30,\n  \"lineItems\": [\n    {\n      \"name\": \"Platform subscription\",\n      \"quantity\": 1,\n      \"unitAmount\": {\n        \"amount\": 99000,\n        \"currency\": \"USD\"\n      }\n    }\n  ]\n}")

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

	req.Header.Add("X-Idempotency-Key", "<x-idempotency-key>")
	req.Header.Add("x-legal-entity", "<x-legal-entity>")
	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	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>"
}

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-Idempotency-Key

string

required

Unique caller-generated key for one create request. Once an authenticated, schema-valid request reaches the operation, the key is permanently consumed for that operation and legal entity whether the operation succeeds or fails. Reusing it in that scope returns 409 and never replays a response, unlike API v1, which replays the original response for a matching key.

Required string length: 1 - 255

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]+$

Body

application/json

customerId

string

required

Customer id with the le_cus_ 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: today or later in timezone.

timezone

string

required

The IANA timezone the series' dates are in.

Minimum string length: 1

Example:

"America/New_York"

paymentTermsDays

integer

required

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

Required range: 0 <= x <= 365

lineItems

InvoiceLineItemCreate · object[]

required

Required array length: 1 - 200 elements

Hide child attributes

lineItems.name

string

required

Required string length: 1 - 255

Example:

"Robot arm maintenance"

lineItems.quantity

number

required

Number of units greater than zero. Fractional quantities are allowed.

Example:

2

lineItems.unitAmount

object

required

Price per unit in USD cents.

Hide child attributes

lineItems.unitAmount.amount

integer

required

Required range: x >= 0

Example:

45000

lineItems.unitAmount.currency

enum<string>

required

Available options:

USD

lineItems.catalogItemId

string

The catalog item this line comes from, with the cat_item_ prefix. Send the item's name and unitAmount too; the line keeps what you send.

accountId

string

The account payments settle into, with the sa_group_ prefix. Required when the legal entity has more than one account that can receive payments.

virtualAccountId

string

A virtual account to settle into instead of the account's primary one, with the subaccount_ prefix.

end

Never · object

Defaults to { "type": "never" }.

Never
After a number of invoices
On a date

Hide child attributes

end.type

enum<string>

required

Available options:

never

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%.

Required range: x <= 100

Example:

10

taxRate

number

Tax as a percent of the subtotal after the discount.

Required range: 0 <= x <= 100

memo

string

Required string length: 1 - 500

ccEmails

string<email>[]

Maximum array length: 10

paymentMethods

InvoicePaymentMethodInput · object[]

How the customer can pay, each type at most once. bank_transfer is always offered.

Maximum array length: 4

Hide child attributes

paymentMethods.type

enum<string>

required

Available options:

bank_transfer,

ach_debit,

card,

crypto

paymentMethods.passFeeToPayer

boolean

Whether the payer covers the processing fee. Defaults to false; ignored for bank_transfer.

Response

The created 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

Create an invoice series

curl --request POST \
  --url https://api.slash.com/v2/invoices/series \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --header 'X-Idempotency-Key: <x-idempotency-key>' \
  --header 'x-legal-entity: <x-legal-entity>' \
  --data '
{
  "customerId": "le_cus_2rj4l7hmrrrcv",
  "recurrence": {
    "type": "monthly_day_of_month",
    "dayOfMonth": 1
  },
  "startDate": "2026-11-01",
  "timezone": "America/New_York",
  "paymentTermsDays": 30,
  "lineItems": [
    {
      "name": "Platform subscription",
      "quantity": 1,
      "unitAmount": {
        "amount": 99000,
        "currency": "USD"
      }
    }
  ]
}
'

const options = {
  method: 'POST',
  headers: {
    'X-Idempotency-Key': '<x-idempotency-key>',
    'x-legal-entity': '<x-legal-entity>',
    'X-API-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    customerId: 'le_cus_2rj4l7hmrrrcv',
    recurrence: {type: 'monthly_day_of_month', dayOfMonth: 1},
    startDate: '2026-11-01',
    timezone: 'America/New_York',
    paymentTermsDays: 30,
    lineItems: [
      {
        name: 'Platform subscription',
        quantity: 1,
        unitAmount: {amount: 99000, currency: 'USD'}
      }
    ]
  })
};

fetch('https://api.slash.com/v2/invoices/series', 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"

payload = {
    "customerId": "le_cus_2rj4l7hmrrrcv",
    "recurrence": {
        "type": "monthly_day_of_month",
        "dayOfMonth": 1
    },
    "startDate": "2026-11-01",
    "timezone": "America/New_York",
    "paymentTermsDays": 30,
    "lineItems": [
        {
            "name": "Platform subscription",
            "quantity": 1,
            "unitAmount": {
                "amount": 99000,
                "currency": "USD"
            }
        }
    ]
}
headers = {
    "X-Idempotency-Key": "<x-idempotency-key>",
    "x-legal-entity": "<x-legal-entity>",
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

package main

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

func main() {

	url := "https://api.slash.com/v2/invoices/series"

	payload := strings.NewReader("{\n  \"customerId\": \"le_cus_2rj4l7hmrrrcv\",\n  \"recurrence\": {\n    \"type\": \"monthly_day_of_month\",\n    \"dayOfMonth\": 1\n  },\n  \"startDate\": \"2026-11-01\",\n  \"timezone\": \"America/New_York\",\n  \"paymentTermsDays\": 30,\n  \"lineItems\": [\n    {\n      \"name\": \"Platform subscription\",\n      \"quantity\": 1,\n      \"unitAmount\": {\n        \"amount\": 99000,\n        \"currency\": \"USD\"\n      }\n    }\n  ]\n}")

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

	req.Header.Add("X-Idempotency-Key", "<x-idempotency-key>")
	req.Header.Add("x-legal-entity", "<x-legal-entity>")
	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	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

Create an invoice series

Authorizations

Headers

Body

Response