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

Name	Description	Type	Required
`uid`	The entity identifier	string	Yes
`created_at`	Timestamp indicating when the entity was created	string	No
`updated_at`	Timestamp of the entity's most recent update	string	No
`type`	Category of the offering. Possible values include: `"plan"`, `"app"`, `"SMS"`, `"staff_seat"`	string	Yes
`SKU`	Unique code (SKU) for the associated underlying product (e.g., app code name, offering code)	string	Yes
`display_name`	The product's display name	string	Yes
`quantity`	The number of items included in the offering	number	No
`payment_type`	Defines the billing cycle period. Possible values: `"monthly"`, `"annually"`, `"free"`, `"single_charge"`, `"external"`	string	Yes
`status`	Current status of the directory offering. Possible values: `"active"`, `"inactive"`	string	No
`vendor`	The business entity or vendor that offers this product. Possible values: `"partner"`, `"inTandem"`	string	No
`prices`	List of prices and their respective currencies	array	Yes
`enable_trial`	Whether or not this offering supports trial period	boolean	No
`trial_type`	Specifies how the trial option is managed. Possible value: `"expire"`. Future values include: `"Automatic charge"`, `"Manually charge"`, `"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
`staff_seats_offering`	Indicates the staff seats offering both bundled to this offering and additional seats the business can purchase.	string	Yes
`bundle_seats_count`	How many seats are bundled (included in the price) to this offering.	number	Yes
`can_purchase_additional_seats`	Indicates if a business can purchase additional seats beyond the bundled subscription.	boolean	No
`reporting_tags`	A comma-separated list of tags to be used for reporting purposes	string	No

Example Entity

{
  "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,
  "staff_seats_offering": "ec3d112d-98ee-428f-9f65-183aba589cb95",
  "bundle_seats_count": 5,
  "can_purchase_additional_seats": false,
  "reporting_tags": "core"