Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-13121230447.8 KB
AddOns

Create an AddOn

Create an AddOn

post/addons

Request body

namestring required

Name of addon

type'LICENSE' | 'FIXED_FEE' | 'CREDIT_GRANT' | 'NAMED_LICENSE' required

LICENSE: Addon can be used in license rate cards FIXED_FEE: Addon can be used in fixed fee rate cards CREDIT_GRANT: Addon can be used in credit grant rate cards NAMED_LICENSE: Addon can be used in license rate cards

billableNamestring

Billable name of addon. Billable name takes precedence over name to display in invoice.

Response

Response for Create and Get addons requests

namestring required

Name of addon

type'LICENSE' | 'FIXED_FEE' | 'CREDIT_GRANT' | 'NAMED_LICENSE' required

LICENSE: Addon can be used in license rate cards FIXED_FEE: Addon can be used in fixed fee rate cards CREDIT_GRANT: Addon can be used in credit grant rate cards NAMED_LICENSE: Addon can be used in license rate cards

billableNamestring

Billable name of addon. Billable name takes precedence over name to display in invoice.

idstring required

Id of addon

createdAtstring date-time required

Created Time of addon

status'ACTIVE' | 'ARCHIVED' required

status of addon

displayNamestring required

Display name of addon. This is an auto-generated field which contains billableName of addon. If billableName is not provided, name will be used as display name.

Example response

{
  "id": "addon.1zYnCiM9Bpg.1zYn",
  "status": "ACTIVE"
}