ProductTrialConfigurationDto

Represents the configuration for trials of a product

allow_repeat_trialsbooleanRequired

Allows customers to trial again after a cooldown period following their previous trial. When disabled, customers can only trial once and never become eligible again.

enabledbooleanRequired

Indicates if trials should be enabled for the product.

new_customer_order_lookback_scaleenumRequired

Possible enum values

invalid
day
week
month
year

new_customer_order_lookback_valueintegerRequired

The lookback period value for determining if a customer is "new". Only used when new_customers_only is enabled.

new_customers_onlybooleanRequired

Restricts trials to customers who have no orders within the lookback period. When enabled, customers with recent orders will be ineligible for trials.

period_scaleenumRequired

Possible enum values

invalid
day
week
month
year

period_valueintegerRequired

The trial period value.

repeat_trial_cooldown_scaleenumRequired

Possible enum values

invalid
day
week
month
year

repeat_trial_cooldown_valueintegerRequired

The cooldown period value before a customer becomes eligible for another trial. Only used when allow_repeat_trial is enabled.

revoke_immediately_when_canceledbooleanRequired

Indicates if the trial should be revoked immediately when canceled or at the end of the trial.

Example

{
  "allow_repeat_trials": true,
  "enabled": true,
  "new_customer_order_lookback_scale": "invalid",
  "new_customer_order_lookback_value": 0,
  "new_customers_only": true,
  "period_scale": "invalid",
  "period_value": 0,
  "repeat_trial_cooldown_scale": "invalid",
  "repeat_trial_cooldown_value": 0,
  "revoke_immediately_when_canceled": true
}