The governance entity object

{
  "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
  "lago_organization_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
  "code": "team",
  "name": "Team",
  "description": "Team that consumed the usage.",
  "attribution_keys": [
    "team",
    "team_id"
  ],
  "role": "hierarchical",
  "lago_parent_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
  "parent_code": "department",
  "created_at": "2022-04-29T08:59:51Z",
  "updated_at": "2022-04-29T08:59:51Z"
}

lago_id

string<uuid>

required

Unique identifier of the usage attribution type, created by Lago.

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

lago_organization_id

string<uuid>

required

Unique identifier of the organization, created by Lago.

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

code

string

required

Unique code used to identify the usage attribution type within the organization.

Example:

"team"

name

string | null

required

Name of the usage attribution type.

Example:

"Team"

description

string | null

required

Description of the usage attribution type.

Example:

"Team that consumed the usage."

attribution_keys

string[]

required

Keys of the event properties that attribute usage to this type. A key belongs to a single usage attribution type of the organization.

Example:

["team", "team_id"]

role

enum<string>

required

Role of the usage attribution type:

hierarchical: the type can have a parent and children, and forms a level of the account tree.
flat: the type stands on its own. It cannot have a parent or children.

Available options:

hierarchical,

flat

Example:

"hierarchical"

lago_parent_id

string<uuid> | null

required

Unique identifier of the parent usage attribution type, created by Lago. It is null when the type has no parent.

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

parent_code

string | null

required

Code of the parent usage attribution type. It is null when the type has no parent.

Example:

"department"

created_at

string<date-time>

required

Creation date of the usage attribution type, in UTC.

Example:

"2022-04-29T08:59:51Z"

updated_at

string<date-time>

required

Date of the last update of the usage attribution type, in UTC.

Example:

"2022-04-29T08:59:51Z"