Skip to main content
POST
Cancel a license

Authorizations

Authorization
string
header
required

Your API key, sent as a bearer token. Create one in the control panel under API Keys, give it only the permissions the integration needs, and copy it when it is created. It cannot be shown again. Each key is restricted to one owned team. The key determines the team for every request.

Path Parameters

license
string
required

The license UUID

Example:

"5d0c8f6e-3b1a-4e27-9f45-1c7a2b8d6e90"

Body

application/json

Send a JSON object containing the fields below. Required fields are marked in the schema.

type
enum<string>
required

The type of operation or resource.

Available options:
immediate,
end_of_billing
delete_floating_ip_uuids
string<uuid>[]

The value of delete_floating_ip_uuids.

Maximum array length: 100

Response

The record, as a JSON object. There is no envelope.

A software license: which product and plan it is, its key, what it costs, and what may be done with it right now.

uuid
string
required

The uuid UUID.

Example:

"5d0c8f6e-3b1a-4e27-9f45-1c7a2b8d6e90"

type
enum<string>
required

The product the license is for.

Available options:
whmcs,
blesta
Example:

"whmcs"

type_label
string
required

The product's name as the panel writes it.

Example:

"WHMCS"

plan_name
string
required

The plan it was bought on, such as "Plus" or "Unlimited".

Example:

"Plus"

name
string
required

The product and plan together, such as "Blesta Unlimited".

Example:

"WHMCS Plus"

status
enum<string>
required

The value of status.

Available options:
pending_payment,
issuing,
active,
pending_cancellation,
cancelled,
expired,
payment_review
Example:

"active"

status_label
string
required

The status in the customer's words, with suspension first.

Example:

"Active"

progress_message
string | null
required

What the license is waiting on, when it is waiting on something.

Example:

null

needs_funds
boolean
required

Whether the purchase is waiting for the account to hold enough credit.

Example:

false

awaits_staff
boolean
required

Whether our team is issuing the license or looking at its purchase by hand.

Example:

false

license_key
string | null
required

The license key, once the license has been issued.

Example:

"Leased-3f9a2c71e8b4d065"

is_suspended
boolean
required

Whether billing has suspended the license because a renewal is unpaid.

Example:

false

download_url
string | null
required

Where the licensed software can be downloaded, when one is set.

Example:

"https://download.whmcs.com/"

billing
BillingData · object
required

The value of billing.

Example:
cancellation_type
enum<string> | null
required

The value of cancellation_type.

Available options:
immediate,
end_of_billing,
null
Example:

null

cancellation_requested_at
string | null
required

The date and time for cancellation requested at, in UTC.

Example:

null

autopay
boolean
required

The value of autopay.

Example:

false

can_cancel
boolean
required

Whether the customer can cancel.

Example:

true

can_withdraw_cancellation
boolean
required

Whether an end-of-period cancellation can still be taken back.

Example:

false

infrastructure_agreed_at
string | null
required

When the customer agreed to use the license on our infrastructure only. Null for a license bought before licenses were sold here.

Example:

"2026-07-21T09:12:33+00:00"

issued_at
string | null
required

The date and time for issued at, in UTC.

Example:

"2026-07-21T09:12:58+00:00"

created_at
string | null
required

The date and time for created at, in UTC.

Example:

"2026-07-21T09:12:33+00:00"