The Offering entity

Description

An Offering represents a commercial agreement in the inTandem platform, describing the various attributes of the commercial terms, including pricing, type, and additional metadata.

Entity Properties

Example Entity

Name	Description	Type	Required
`uid`	The entity unique identifier.	`string`	No
`created_at`	Timestamp indicating when the entity was created.	`string (date-time)`	No
`updated_at`	Timestamp of the entity's most recent update.	`string (date-time)`	No
`type`	Category of the offering. Possible values: `package`, `app`, `addon`.	`string`	Yes
`SKU`	The unique code of the associated underlying SKU (e.g., app code name, offering code).	`string`	Yes
`display_name`	The SKU's display name.	`string`	Yes
`quantity`	The number of items included in the offering. Default: `1`.	`number`	Yes
`payment_type`	Defines the billing cycle period. Possible values: `monthly`, `annualy`, `free`, `single_charge`, `external`.	`string`	Yes
`is_active`	Current status of the directory offering. Default: `true`.	`boolean`	No
`vendor`	The business entity or vendor that offers this SKU. Possible values: `partner`, `inTandem`. Default: `inTandem`.	`string`	No
`prices`	List of price objects. Each object contains `price` (number) and `currency` (string with values `USD`, `EUR`, `GBP`).	`array`	Yes
`enable_trial`	Whether or not this offering supports a trial period. Default: `false`.	`boolean`	No
`trial_type`	Specifies how the trial option is managed. Current value: `expire`. Future values may include: `automatic charge`, `manually charge`, `expire`. Default: `expire`.	`string`	No
`trial_period`	Number of days for the trial period. If not specified or set to `0`, it indicates no trial period is offered.	`number`	No
`reporting_tags`	A comma-separated list of tags to be used for reporting purposes. Possible values: ` -`bussiness-management`- The SMB has scheduling/payments/crm & marketing (at least one of them) Missing module tags (only relevant if business-management is on): `no-payments` - has no payments module `no-marketing` - has no marketing module `no-scheulding`- has no scheduling module -`trial`- this is a trial plan (also comes with an indication for the feature) -`connect`- the connect features (only inbox and leads, sometimes with basic scheduling) -`ghost` - users that are not logging into the system but use the platform -`free`- free offerings	`string`	No

{
  "uid": "bc33f12d-98ee-428f-9f65-18bba589cb95",
  "created_at": "2024-01-01T09:00:00Z",
  "updated_at": "2024-03-20T12:34:56Z",
  "type": "package",
  "SKU": "premium_10",
  "display_name": "Premium 10",
  "quantity": 1,
  "payment_type": "monthly",
  "status": "active",
  "vendor": "inTandem",
  "prices": [
    {
      "price": 5.00,
      "currency": "USD"
    },
    {
      "price": 5.00,
      "currency": "EUR"
    }
  ],
  "enable_trial": false,
  "trial_type": "expire",
  "trial_period": 14,
  "reporting_tags": "core"