Sign in
AddOns

Update an addon

Update an existing addon

patch/addons/{addon_id}

Path parameters

addon_idstring required
Example:addon.1zYnCiM9Bpg.lv25y

Request body

namestring

Name of addon

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"
}

Changes

Changed in 4 of the 34 revisions of this API.134

  • cc0b10fb537e1See the full diff
    • ●

      added the new NAMED_LICENSE enum value to the allOf[CreateAddOnRequest]/type response property for the response status 200

      response-property-enum-value-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • b3351be4b4621See the full diff
    • ○

      added the required property allOf[subschema #2]/displayName to the response with the 200 status

      response-required-property-added

  • a6c96c5ec06e2See the full diff
    • ○

      added the new optional request property billableName

      new-optional-request-property

    • ○

      added the optional property allOf[CreateAddOnRequest]/billableName to the response with the 200 status

      response-optional-property-added

  • 6b13f6f47735121See the full diff
    • ▲

      removed the required property allOf[subschema #2]/displayName from the response with the 200 status

      response-required-property-removed

    • ●

      removed the request property billableName

      request-property-removed

    • ●

      removed the optional property allOf[CreateAddOnRequest]/billableName from the response with the 200 status

      response-optional-property-removed

    • ○

      removed the NAMED_LICENSE enum value from the allOf[CreateAddOnRequest]/type response property for the response status 200

      response-property-enum-value-removed

    This revision also has 74 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog