Delete customer

This performs a deletion of this customer, its subscriptions, and its invoices. This operation is irreversible. Note that this is a soft deletion, but the data will be inaccessible through the API and Orb dashboard. For hard-deletion, please reach out to the Orb team directly.

Note: This operation happens asynchronously and can be expected to take a few minutes to propagate to related resources. However, querying for the customer on subsequent GET requests while deletion is in process will reflect its deletion with a deleted: true property. Once the customer deletion has been fully processed, the customer will not be returned in the API.

On successful processing, this returns an empty dictionary ({}) in the API.

Path Parameters

customer_id string required

Responses

• 204
• 400
• 401
• 404
• 409
• 413
• 429
• 500

---

No Content

Response Headers

Bad Request

Response Headers

application/json

Schema

Example (from schema)

---

Schema

oneOf
ConstraintViolationError
DuplicateResourceCreationError
RequestValidationError
---
type string required
Possible values: [https://docs.withorb.com/reference/error-responses#400-constraint-violation]
status integer required
Possible values: [400]
detail string nullable
title string nullable
type string required
Possible values: [https://docs.withorb.com/reference/error-responses#400-duplicate-resource-creation]
status integer required
Possible values: [400]
detail string nullable
title string nullable
type string required
Possible values: [https://docs.withorb.com/reference/error-responses#400-request-validation-errors]
status integer required
Possible values: [400]
detail string nullable
title string nullable
validation_errors undefined[] required

{}

Unauthorized

Response Headers

application/json

Schema

Example (from schema)

---

Schema

type string required

Possible values: [https://docs.withorb.com/reference/error-responses#401-authentication-error]

status integer required

Possible values: [401]

detail string nullable
title string nullable

{
  "type": "https://docs.withorb.com/reference/error-responses#401-authentication-error",
  "status": 401,
  "detail": "string",
  "title": "string"
}

Not Found

Response Headers

application/json

Schema

Example (from schema)

---

Schema

oneOf
FeatureNotAvailableError
ResourceNotFoundError
URLNotFound
---
type string required
Possible values: [https://docs.withorb.com/reference/error-responses#404-feature-not-available]
status integer required
Possible values: [400]
detail string nullable
title string nullable
type string required
Possible values: [https://docs.withorb.com/reference/error-responses#404-resource-not-found]
status integer required
Possible values: [404]
detail string nullable
title string required
type string required
Possible values: [https://docs.withorb.com/reference/error-responses#404-url-not-found]
status integer required
Possible values: [404]
detail string nullable
title string nullable

{}

Conflict

Response Headers

application/json

Schema

Example (from schema)

---

Schema

type string required

Possible values: [https://docs.withorb.com/reference/error-responses#409-resource-conflict]

status integer required

Possible values: [409]

detail string nullable
title string nullable

{
  "type": "https://docs.withorb.com/reference/error-responses#409-resource-conflict",
  "status": 409,
  "detail": "string",
  "title": "string"
}

Request Entity Too Large

Response Headers

application/json

Schema

Example (from schema)

---

Schema

oneOf
RequestTooLargeError
ResourceTooLargeError
TooManyResultsError
---
type string required
Possible values: [https://docs.withorb.com/reference/error-responses#413-request-too-large]
status integer required
Possible values: [413]
detail string nullable
title string nullable
type string required
Possible values: [https://docs.withorb.com/reference/error-responses#413-resource-too-large]
status integer required
Possible values: [413]
detail string nullable
title string nullable
type string required
Possible values: [https://docs.withorb.com/reference/error-responses#413-too-many-results]
status integer required
Possible values: [413]
detail string nullable
title string nullable

{}

Too Many Requests

Response Headers

application/json

Schema

Example (from schema)

---

Schema

type string required

Possible values: [https://docs.withorb.com/reference/error-responses#429-too-many-requests]

status integer required

Possible values: [429]

detail string nullable
title string nullable

{
  "type": "https://docs.withorb.com/reference/error-responses#429-too-many-requests",
  "status": 429,
  "detail": "string",
  "title": "string"
}

Internal Server Error

Response Headers

application/json

Schema

Example (from schema)

---

Schema

type string required

Possible values: [https://docs.withorb.com/reference/error-responses#500-internal-server-error]

status integer required
detail string nullable
title string nullable

{
  "type": "https://docs.withorb.com/reference/error-responses#500-internal-server-error",
  "status": 0,
  "detail": "string",
  "title": "string"
}

Loading...