Delete customer

curl --request DELETE \
  --url https://api.withorb.com/v1/customers/{customer_id} \
  --header 'Authorization: Bearer <token>'

{
  "type": "https://docs.withorb.com/reference/error-responses#400-constraint-violation",
  "status": 400,
  "detail": "<string>",
  "title": "<string>"
}

Customer

Delete customer

This performs a deletion of this customer, its subscriptions, and its invoices, provided the customer does not have any issued invoices. Customers with issued invoices cannot be deleted. This operation is irreversible. Note that this is a soft deletion, but the data will be inaccessible through the API and Orb dashboard.

For a 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.

DELETE

customers

{customer_id}

Delete customer

curl --request DELETE \
  --url https://api.withorb.com/v1/customers/{customer_id} \
  --header 'Authorization: Bearer <token>'

{
  "type": "https://docs.withorb.com/reference/error-responses#400-constraint-violation",
  "status": 400,
  "detail": "<string>",
  "title": "<string>"
}

Authorizations

Authorization

string

header

required

API Keys can be issued in the Orb's web application.

Path Parameters

customer_id

string

required

Response

No Content

Update customer

List balance transactions

⌘I

API documentation

Alert

Coupon

Credit

Credit note

Customer

Dimensional Price Group

Event

Invoice

Item

Metric

Availability

Plan

Price

Subscription Change

Subscription

Price interval

Webhook

Delete customer

Authorizations

Path Parameters

Response