License API

1 min read

Activate licenses, exchange tokens, and check license status.

Activate a License Key

Exchange a license key for access and refresh tokens.

POST /api/licenses/activate

Request body:

json

{
  "licenseKey": "mfl_lic_xxxxxxxxxxxx",
  "siteDomain": "www.yourfirm.com"
}

Response:

json

{
  "accessJwt": "eyJ...",
  "refreshToken": "rt_xxxxxxxxxxxx",
  "expiresAt": "2024-04-01T00: 00: 00Z"
}

Exchange Auth Code

Exchange an OAuth authorization code for tokens (used by the portal Connect flow).

POST /api/licenses/exchange

Request body:

json

{
  "code": "auth_code_xxxx",
  "siteDomain": "www.yourfirm.com"
}

Response: Same format as activate.

Check License Status

Get the current status of a license.

GET /api/licenses/status
Authorization: Bearer <access_token>

Response:

json

{
  "status": "active",
  "plan": "pro",
  "seats": 3,
  "allowedDomains": ["www.yourfirm.com", "yourfirm.com"],
  "expiresAt": "2024-04-01T00: 00: 00Z"
}

Status Values

Status	Description
`active`	License is active and valid
`trial`	In free trial period
`grace`	Subscription lapsed, in 7-day grace period
`expired`	License has expired
`revoked`	License was manually revoked

Was this page helpful?