Archive a customer - Slash

POST

/

v2

/

customers

/

{customerId}

/

archive

Archive a customer

curl --request POST \
  --url https://api.slash.com/v2/customers/{customerId}/archive \
  --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/customers/{customerId}/archive', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.slash.com/v2/customers/{customerId}/archive"

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/customers/{customerId}/archive"

	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": "le_cus_2rj4l7hmrrrcv",
  "name": "Acme Robotics",
  "email": "ap@acme.example",
  "status": "active",
  "createdAt": "2023-11-07T05:31:56Z",
  "phone": "+14155550123",
  "address": {
    "line1": "<string>",
    "city": "<string>",
    "line2": "<string>",
    "state": "<string>",
    "postalCode": "<string>",
    "countryCode": "<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

customerId

string

required

Customer id with the le_cus_ prefix.

Response

The archived customer.

Someone you invoice. An invoice copies the customer's name, email and address into its billedTo when it's created, so editing a customer doesn't change invoices already issued.

id

string

required

Customer id with the le_cus_ prefix.

Example:

"le_cus_2rj4l7hmrrrcv"

name

string

required

The name invoices are addressed to.

Example:

"Acme Robotics"

email

string

required

Where invoices and reminders are sent.

Example:

"ap@acme.example"

status

enum<string>

required

archived marks a customer you no longer bill. Archived customers can still be invoiced and are listed unless you filter by status.

Available options:

active,

archived

createdAt

string<date-time>

required

phone

string

Example:

"+14155550123"

address

Address · object

Hide child attributes

address.line1

string

required

Minimum string length: 1

address.city

string

required

Minimum string length: 1

address.line2

string

address.state

string

address.postalCode

string

address.countryCode

string

ISO 3166-1 alpha-2 country code.

Required string length: 2

⌘I

Archive a customer

curl --request POST \
  --url https://api.slash.com/v2/customers/{customerId}/archive \
  --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/customers/{customerId}/archive', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.slash.com/v2/customers/{customerId}/archive"

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/customers/{customerId}/archive"

	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": "le_cus_2rj4l7hmrrrcv",
  "name": "Acme Robotics",
  "email": "ap@acme.example",
  "status": "active",
  "createdAt": "2023-11-07T05:31:56Z",
  "phone": "+14155550123",
  "address": {
    "line1": "<string>",
    "city": "<string>",
    "line2": "<string>",
    "state": "<string>",
    "postalCode": "<string>",
    "countryCode": "<string>"
  }
}