UpsertProductTrialConfigurationDto

Represents the configuration for trials of a product

allow_repeat_trialsbooleanOptional

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.

enabledbooleanOptional

Indicates if trials should be enabled for the product.

new_customer_order_lookback_scaleenumOptional

Possible enum values

invalid
day
week
month
year

new_customer_order_lookback_valueintegerOptional

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

new_customers_onlybooleanOptional

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

period_scaleenumOptional

Possible enum values

invalid
day
week
month
year

period_valueintegerOptional

The trial period value.

repeat_trial_cooldown_scaleenumOptional

Possible enum values

invalid
day
week
month
year

repeat_trial_cooldown_valueintegerOptional

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

revoke_immediately_when_canceledbooleanOptional

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

Example

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