Skip to main content
POST
Revoke a license

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

license_id
string<MeteroidId>
required

License ID

Example:

"lic_7n42DGM5Tflk9n8mt7Fhc7"

Body

application/json
immediately
boolean

Stop at once: the installation drops its license on its next refresh. Otherwise the license keeps working until it expires, and is not renewed.

Response

License revoked

auto_issued
boolean
required

Issued automatically for a subscription to a plan that issues licenses.

created_at
string<date-time>
required
customer_id
string<MeteroidId>
required
Example:

"cus_7n42DGM5Tflk9n8mt7Fhc7"

customer_name
string
required
has_activation_code
boolean
required

Whether the activation code can still be retrieved: only until activation or revocation.

id
string<MeteroidId>
required
Example:

"lic_7n42DGM5Tflk9n8mt7Fhc7"

offline
boolean
required

Issued as a signed offline license: never activated nor refreshed.

revoked_immediately
boolean
required

Revoked to stop at once: the installation drops its license on its next refresh instead of keeping it until it expires.

status
enum<string>
required
Available options:
PENDING,
ACTIVE,
REVOKED
validity_days
integer<int32>
required

Lifetime of each license token the installation receives on refresh; for an offline license, the lifetime it was issued with.

Required range: x >= 0
instance_id
string | null

The installation the license is bound to, once activated.

last_refreshed_at
string<date-time> | null
plan_name
string | null
revoked_at
string<date-time> | null
subscription_id
string<MeteroidId> | null
Example:

"sub_7n42DGM5Tflk9n8mt7Fhc7"