|
`uid`
|
The entity unique identifier
|
`string`
|
No
|
|
`created_at`
|
Timestamp indicating when the entity was created
|
`string`
|
No
|
|
`updated_at`
|
Timestamp of the entity's most recent update
|
`string`
|
No
|
|
`type`
|
Type of the offering. Possible values include: **package** for the main business subscription; **app** for marketplace app subscriptions and **addon** for other SKUs like SMS and staff_seats. A user can have one subscription with package, one subscription per SKU of type apps and any number of subscriptions for any SKU
|
`string` (enum: `package`, `app`, `addon`)
|
Yes
|
|
`SKU`
|
The unique code of the single SKU this offering represents. Offerings support exactly one SKU; to combine multiple SKUs, use a bundledOffering or similar higher-level abstraction.
|
`string`
|
Yes
|
|
`display_name`
|
The SKU's display name
|
`string`
|
Yes
|
|
`quantity`
|
The number of items included in the offering. Use `-1` to indicate **unlimited** quantity (e.g., unlimited staff seats). When quantity is `-1`, the system treats the resource as uncapped — no usage limit is enforced. This is typically used for `staff_seat` add-on offerings distributed as part of a bundle.
|
`number`
|
Yes
|
|
`payment_type`
|
The payment type field defines the payment options available for an offering, **external**: Payment is not done by the platform (typically an API call from the partner), **external_single_charge**: A one-time externally-managed payment (typically an API call from the partner) that grants a single credit (e.g., SMS); behaves like external for billing but its quota is counted as purchased; not supported for package offerings, **free**: No payment is required; **single_charge**: A single, one-time payment is required to obtain the offering; **monthly**: A recurring payment made on a monthly basis; **annual**: A recurring payment made on a yearly basis; **bundle**: A subscription bundled with another subscription
|
`string` (enum: `monthly`, `annualy`, `free`, `single_charge`, `external`, `external_single_charge`, `bundle`)
|
Yes
|
|
`is_active`
|
Current status of the directory offering
|
`boolean`
|
No
|
|
`is_listed`
|
Listing visibility. Defaults to `true` for every offering; when `false` the offering is hidden from listings but remains reachable via a direct link to its info page.
|
`boolean`
|
No
|
|
`vendor`
|
The business entity or vendor that offers this SKU.
|
`string` (enum: `partner`, `inTandem`)
|
No
|
|
`prices`
|
List of price objects for the offering, one per supported currency.
|
`array`
|
Yes
|
|
`trial_type`
|
Specifies how the trial option is managed. expire: trial is enabled and subscription will expire after trial_period days. no_trial: no trial period. Future values may include: automatic_charge (auto-charge after trial), manually_charge (stay active without charging).
|
`string` (enum: `expire`, `no_trial`)
|
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 list of tags to be used for reporting purposes. Tags categorize offerings for analytics and billing reports. Common tags include: **base** for standard base offerings; **free** for free tier offerings; **trial** for trial-period offerings; **ghost** for internal/hidden offerings; **business_management** for business management related offerings; **sandbox** for test environment offerings; **core** for core platform offerings.
|
`array`
|
No
|