Update a catalog item - Slash

PATCH

/

v2

/

invoices

/

catalog-items

/

{catalogItemId}

Update a catalog item

curl --request PATCH \
  --url https://api.slash.com/v2/invoices/catalog-items/{catalogItemId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --header 'x-legal-entity: <x-legal-entity>' \
  --data '
{
  "unitAmount": {
    "amount": 48000,
    "currency": "USD"
  }
}
'

const options = {
  method: 'PATCH',
  headers: {
    'x-legal-entity': '<x-legal-entity>',
    'X-API-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({unitAmount: {amount: 48000, currency: 'USD'}})
};

fetch('https://api.slash.com/v2/invoices/catalog-items/{catalogItemId}', 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/{catalogItemId}"

payload = { "unitAmount": {
        "amount": 48000,
        "currency": "USD"
    } }
headers = {
    "x-legal-entity": "<x-legal-entity>",
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(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/{catalogItemId}"

	payload := strings.NewReader("{\n  \"unitAmount\": {\n    \"amount\": 48000,\n    \"currency\": \"USD\"\n  }\n}")

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

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

catalogItemId

string

required

Catalog item id with the cat_item_ prefix.

Body

application/json

Partial update. An omitted field is left unchanged; null clears description. Invoices that already use the item keep the name and price they were written with.

name

string

Required string length: 1 - 255

description

string | null

Required string length: 1 - 1000

unitAmount

object

Price per unit in USD cents.

Hide child attributes

unitAmount.amount

integer

required

Required range: x >= 0

unitAmount.currency

enum<string>

required

Available options:

USD

Response

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

Update a catalog item

curl --request PATCH \
  --url https://api.slash.com/v2/invoices/catalog-items/{catalogItemId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --header 'x-legal-entity: <x-legal-entity>' \
  --data '
{
  "unitAmount": {
    "amount": 48000,
    "currency": "USD"
  }
}
'

const options = {
  method: 'PATCH',
  headers: {
    'x-legal-entity': '<x-legal-entity>',
    'X-API-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({unitAmount: {amount: 48000, currency: 'USD'}})
};

fetch('https://api.slash.com/v2/invoices/catalog-items/{catalogItemId}', 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/{catalogItemId}"

payload = { "unitAmount": {
        "amount": 48000,
        "currency": "USD"
    } }
headers = {
    "x-legal-entity": "<x-legal-entity>",
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(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/{catalogItemId}"

	payload := strings.NewReader("{\n  \"unitAmount\": {\n    \"amount\": 48000,\n    \"currency\": \"USD\"\n  }\n}")

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

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