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.
Properties
| Name | Description | Type | Required | Example |
|---|---|---|---|---|
| uid | The entity identifier | string | Yes | "bc33f12d-98ee-428f-9f65-18bba589cb95" |
| created_at | Timestamp indicating when the entity was created | string (date-time) | No | "2024-01-01T09:00:00Z" |
| updated_at | Timestamp of the entity's most recent update | string (date-time) | No | "2024-03-20T12:34:56Z" |
| type | Category of the offering. Possible values: package, app, SMS, staff_slot | string | Yes | "plan" |
| SKU | Unique code (SKU) for the associated product | string | Yes | "premium_10" |
| display_name | The product's display name | string | Yes | "Premium 10" |
| quantity | The number of items included in the offering | number | Yes | 1 |
| payment_type | Defines the billing cycle period. Possible values: monthly, annualy, free, single_charge | string | No | "monthly" |
| status | Current status of the offering. Possible values: active, inactive | string | No | "active" |
| prices | Array of price objects, each containing a price and currency | array of objects | Yes | [{"price": 5.00, "currency": "USD"}, {"price": 5.00, "currency": "EUR"}] |
| enable_trial | Indicates if this offering supports a trial period | boolean | No | false |
| trial_type | Trial management type. Possible values: automatic_charge, manual_charge, expire | string | No | "expire" |
| trial_period | Number of days for the trial period | number | No | 14 |
| bundles | List of bundled offering UIDs | array of strings | No | ["bc33f12d-98ee-428f-9f65-12bca589cb21"] |
| staff_seats_offering | Indicates the staff seats offering both bundled and additional seats businesses can purchase | string | Yes | "ec3d112d-98ee-428f-9f65-183aba589cb95" |
| bundle_seats_count | Number of seats bundled (included in the price) | number | Yes | 5 |
| can_purchase_additional_seats | Indicates if a business can purchase additional seats beyond the bundled subscription | boolean | No | false |
Example
{
"uid": "bc33f12d-98ee-428f-9f65-18bba589cb95",
"created_at": "2024-01-01T09:00:00Z",
"updated_at": "2024-03-20T12:34:56Z",
"type": "plan",
"SKU": "premium_10",
"display_name": "Premium 10",
"quantity": 1,
"payment_type": "monthly",
"status": "active",
"prices": [
{
"price": 5.00,
"currency": "USD"
},
{
"price": 5.00,
"currency": "EUR"
}
],
"trial_period": 14,
"bundles": [
"bc33f12d-98ee-428f-9f65-12bca589cb21"
],
"staff_seats_offering": "ec3d112d-98ee-428f-9f65-183aba589cb95",
"bundle_seats_count": 5,
"can_purchase_additional_seats": false
}