Licensee

The Licensee object represents a licensee in the Marketplace platform. This object contains the following properties:

Field
Type
Description

id

string

The primary identifier for the licensee.

Example: LCE-1234-1234-1234

href

string

A relative reference to the object in the API.

Example: /v1/accounts/licensees/LIC-1234-1234-1234"

status

string

The status of the licensee.

Possible values: Enabled, Active, Disabled, or Deleted.

name

string

The licensee's name.

Example: Stark Industries Finance Dept

icon

string

A relative path to the licensee’s logo.

Example: /static/accounts/LIC-1234-1234-1234/logo.png

externalId

string

The external identifier.

Example: WW-CON-12345678

useBuyerAddress

boolean

Defines whether the address should be copied from the buyer.

Example: true

address

The address of the licensee.

Example:

{
  "addressLine1": "123 Main Street",
  "addressLine2": "Apt 4B",
  "postCode": "12345",
  "city": "Cityville",
  "state": "S",
  "country": "ST"
}

description

string

A description of the licensee.

contact

object

The details of the contact person.

Example:

{
	"name": "Will Smith",
	"firstName": "Will",
	"lastName": "Smith",
	"email": "[email protected]",
	"phone": null,
	"user": {
		"id": "USR-0000-0001",
		"icon": null,
		"name": "Will Smith"
	}
}

buyer

A reference to the Buyer object.

seller

A reference to the Seller object.

account

A reference to the Account object.

audit

object

Possible audit events: Created, Updated, Activated, Disabled, Deactivated, or Deleted.

Example:

{
  "created": { "at": "...", "by": { } },
  "updated": { "at": "...", "by": { } },
  "disabled": { "at": "...", "by": { } },
  "enabled": { "at": "...", "by": { } },
  "activated": { "at": "...", "by": { } },
  "deleted": { "at": "...", "by": { } }
}

Example

{
	"id": "LCE-8893-6916-0000",
	"contact": null,
	"name": "Stark Industries",
	"externalId": null,
	"status": "Active",
	"address": null,
	"useBuyerAddress": false,
	"icon": null,
	"description": null
}

Last updated

Was this helpful?