Models

Family Model

A group of products or services.

If you are implementing a Family model, make sure you pass familyId to the Product model. This way, you can associate a family with a product.

Properties

idstring
required

Unique identifier of the family

namestring
required

Customer-facing name.

descriptionstring
optional

Customer-facing description.

Code Example

import { Integrator } from '@churnkey/ts-sdk'

export class Family extends Integrator.Family {
    constructor(family: YourFamily) {
        super(
            {
                id: family.id,
                ... // map other properties
            }
        )
    }
}