PATCH
/
addons
/
{addon_id}
Update an addon
curl --request PATCH \
  --url https://api.togai.com/addons/{addon_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "billableName": "<string>"
}'
{
  "name": "<string>",
  "type": "LICENSE",
  "billableName": "<string>",
  "id": "addon.1zYnCiM9Bpg.1zYn",
  "createdAt": "2023-11-07T05:31:56Z",
  "status": "ACTIVE",
  "displayName": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
addon_id
string
required
Maximum length: 50
Example:

"addon.1zYnCiM9Bpg.lv25y"

Body

application/json

Payload to update addon

Request to update an addon

​
name
string

Name of addon

Maximum length: 255
​
billableName
string

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

Maximum length: 255

Response

Response for Create and Get addons requests

Request to create an addon

​
name
string
required

Name of addon

Maximum length: 255
​
type
enum<string>
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

Available options:
LICENSE,
FIXED_FEE,
CREDIT_GRANT,
NAMED_LICENSE
​
id
string
required

Id of addon

Example:

"addon.1zYnCiM9Bpg.1zYn"

​
createdAt
string<date-time>
required

Created Time of addon

​
status
enum<string>
required

status of addon

Available options:
ACTIVE,
ARCHIVED
Example:

"ACTIVE"

​
displayName
string
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.

​
billableName
string

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

Maximum length: 255