Skip to main content
POST
billing.license.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
licenseId
string
required

License ID from billing.licenses.list.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
includeKey
boolean
default:false

Return the key, a customer credential. Default false.

Response

The result

licenseId
string
required

Your license record ID.

status
enum<string>
required

Entitlement state.

Available options:
inactive,
active,
expired,
disabled,
unknown
customerId
string

Customer ID.

transactionId
string

Original charge ID.

transactionItemId
string

Original charge item ID.

productId
string

Purchased product ID.

name
string

Customer name.

email
string

Customer email.

activationLimit
number

Maximum activations, when limited.

instancesCount
number

Activated instance count.

disabled
boolean

Entitlement disabled.

expiresAt
string

Expiration time; absent for perpetual licenses.

key
string

Customer credential; returned only when includeKey is true.

createdAt
string

Creation time, ISO 8601.

updatedAt
string

Last update, ISO 8601.