Plumtier Docs Deploy free

Errors

What each status code and error message means, and what your app should do.

Every license API response has the same shape. The call's boolean (activated, valid or deactivated) says how it went, and error holds a message you can show to people when it's false.

Status codes

CodeWhen
200The call worked. For validate, also when the key is not valid: read valid.
400A required field is missing, or activation was refused (limit, disabled, expired, other product).
404The key doesn't exist, or the instance isn't activated for this key.
5xx or no answerThe store couldn't answer. Retry later and use your offline grace period.

Messages

errorWhat to do
license_key is required.Send the key.
instance_name is required.Send a device name when activating.
license_key and instance_id are required.Send both when deactivating.
This license key doesn't exist.Ask the user to check the key. It's in their receipt email.
This license key has been disabled.Lock the app. The order was refunded or the seller turned the key off.
This license key has expired.Offer to renew or buy again.
This license key is for a different product.The user pasted a key for another of your products.
This license key has reached its activation limit of N.Point them to https://shop.example.com/portal to free a device.
This instance isn't activated for this key.The device was removed. Activate again.
Tip
Show error as is: messages are written for buyers. Branch your logic on valid/activated, the HTTP status and license_key.status, which are stable, not on the message text.