SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester
invoicing

Archive a customer (sets is_active=false). Fails with 409 if the customer has open invoices.

Archive a customer (sets is_active=false). Fails with 409 if the customer has open invoices.

DELETEhttps://staging.softsolz.uk/api/v1/services/invoicing/customers/{id}

Recent Requests

Log in to see full request history
TimeStatusUser Agent
Make a request to see history.

Path Params

idstringrequired

Headers

Authorizationstringrequired

Bearer token: `Bearer sk_live_...` (or `sk_test_...` for sandbox). A login token will not work here.

Response

Response Body

idintegerCustomer id.
deletedbooleanAlways true when the customer was archived.

Request

import { SoftSolz } from '@softsolz/sdk';
const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });
const result = await client.invoicing.deleteCustomer('<id>');
console.log(result);

Credentials

Sent as a Bearer token. Stored only in your browser.

Response · 200

{
"data": {
"id": 0,
"deleted": true
}
}