Interface: PlanBuilderOption

An option activated in the Plan Builder outside of any package.

Since

3.16.0

Property	Type	Description	Defined in
<a id="id"></a> `id`	`string`	Option ID	types/general.types.ts:349
<a id="slug"></a> `slug`	`string`	Option code (slug)	types/general.types.ts:351
<a id="name"></a> `name`	`string`	Option name in the language specified in the `locale` parameter	types/general.types.ts:353
<a id="status"></a> `status`	`PlanBuilderActivationStatus`	Option activation status	types/general.types.ts:355
<a id="activatedat"></a> `activatedAt?`	`string`	Option activation date (ISO 8601)	types/general.types.ts:357
<a id="expiresat"></a> `expiresAt?`	`string`	End date of the minimum duration period; the option cannot be deactivated before this date (ISO 8601)	types/general.types.ts:359
<a id="commissionrate"></a> `commissionRate?`	`number`	Cost of activating the option, % of turnover. Returned if the response does not contain the `promotion` object	types/general.types.ts:361
<a id="periodduration"></a> `periodDuration?`	`number`	Minimum duration of the option	types/general.types.ts:363
<a id="promotion"></a> `promotion?`	`PlanBuilderPromotion`	Promo details. Present only if the option is activated via a promo whose period has not expired	types/general.types.ts:365