Skip to main content
POST
/
licenses
/
{license_id}
/
deactivate
Deactivate license
curl --request POST \
  --url https://api.withorb.com/v1/licenses/{license_id}/deactivate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "end_date": "2026-01-27"
}
'
{
  "id": "<string>",
  "subscription_id": "<string>",
  "license_type_id": "<string>",
  "external_license_id": "<string>",
  "status": "active",
  "start_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

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

Path Parameters

license_id
string
required

Body

application/json
end_date
string<date> | null

The date to deactivate the license. If not provided, defaults to end of day today in the customer's timezone.

Example:

"2026-01-27"

Response

OK

id
string
required
subscription_id
string
required
license_type_id
string
required
external_license_id
string
required
status
enum<string>
required
Available options:
active,
inactive
start_date
string<date-time>
required
end_date
string<date-time> | null
required