Create a catalog item - Slash

POST

/

v2

/

invoices

/

catalog-items

Create a catalog item

curl --request POST \
  --url https://api.slash.com/v2/invoices/catalog-items \
  --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 '
{
  "name": "Robot arm maintenance",
  "description": "Quarterly on-site service",
  "unitAmount": {
    "amount": 45000,
    "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({
    name: 'Robot arm maintenance',
    description: 'Quarterly on-site service',
    unitAmount: {amount: 45000, currency: 'USD'}
  })
};

fetch('https://api.slash.com/v2/invoices/catalog-items', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.slash.com/v2/invoices/catalog-items"

payload = {
    "name": "Robot arm maintenance",
    "description": "Quarterly on-site service",
    "unitAmount": {
        "amount": 45000,
        "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/catalog-items"

	payload := strings.NewReader("{\n  \"name\": \"Robot arm maintenance\",\n  \"description\": \"Quarterly on-site service\",\n  \"unitAmount\": {\n    \"amount\": 45000,\n    \"currency\": \"USD\"\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": "cat_item_2rj4l7hmrrrcv",
  "name": "Robot arm maintenance",
  "unitAmount": {
    "amount": 123,
    "currency": "<string>"
  },
  "status": "active",
  "createdAt": "2023-11-07T05:31:56Z",
  "description": "<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

name

string

required

Required string length: 1 - 255

unitAmount

object

required

Price per unit in USD cents.

Hide child attributes

unitAmount.amount

integer

required

Required range: x >= 0

Example:

45000

unitAmount.currency

enum<string>

required

Available options:

USD

description

string

Required string length: 1 - 1000

Response

The created catalog item.

A product or service you invoice often. Invoices copy its name and price into a line item, so editing an item doesn't change invoices that already use it.

id

string

required

Catalog item id with the cat_item_ prefix.

Example:

"cat_item_2rj4l7hmrrrcv"

name

string

required

Example:

"Robot arm maintenance"

unitAmount

Money · object

required

Price per unit.

Hide child attributes

unitAmount.amount

integer

required

Amount in the currency's minor units.

unitAmount.currency

string

required

Uppercase ISO 4217 currency code.

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

status

enum<string>

required

archived marks an item you no longer sell. Archived items can still be invoiced and are listed unless you filter by status.

Available options:

active,

archived

createdAt

string<date-time>

required

description

string

⌘I

Create a catalog item

curl --request POST \
  --url https://api.slash.com/v2/invoices/catalog-items \
  --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 '
{
  "name": "Robot arm maintenance",
  "description": "Quarterly on-site service",
  "unitAmount": {
    "amount": 45000,
    "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({
    name: 'Robot arm maintenance',
    description: 'Quarterly on-site service',
    unitAmount: {amount: 45000, currency: 'USD'}
  })
};

fetch('https://api.slash.com/v2/invoices/catalog-items', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.slash.com/v2/invoices/catalog-items"

payload = {
    "name": "Robot arm maintenance",
    "description": "Quarterly on-site service",
    "unitAmount": {
        "amount": 45000,
        "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/catalog-items"

	payload := strings.NewReader("{\n  \"name\": \"Robot arm maintenance\",\n  \"description\": \"Quarterly on-site service\",\n  \"unitAmount\": {\n    \"amount\": 45000,\n    \"currency\": \"USD\"\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": "cat_item_2rj4l7hmrrrcv",
  "name": "Robot arm maintenance",
  "unitAmount": {
    "amount": 123,
    "currency": "<string>"
  },
  "status": "active",
  "createdAt": "2023-11-07T05:31:56Z",
  "description": "<string>"
}