Create plan experiment
Start an experiment from the plan’s current version with the changes given. It is sold only through its own code, sent as planCode after the plan’s code; new buyers of the plan keep getting the current version.
planCode set to <plan code>:<experiment code>. The experiment code is never reused in the plan.Authorizations
Headers
Unique key used to safely retry this write for 24 hours without applying it twice.
1 - 200API version used by this reference. Send this header to select this contract explicitly.
Path Parameters
Body
The experiment's own code: lowercase letters, numbers, hyphens and underscores. It is sold as planCode <plan code>:<code> and is never reused in the plan.
Currencies the current version does not sell, with the exchange rate (local units per USD) used for the amounts not listed, credit purchases, add-ons and overage.
Credits plans that roll over unused credits: the most plan credits a subscription can hold. Null removes the cap.
1 <= x <= 2147483647Balance plans that roll over unused balance: the most plan balance a subscription can hold, in USD cents. Other currencies convert it with the plan's exchange rate unless the dashboard sets a custom amount for that currency. Null removes the cap.
1 <= x <= 2147483647Response
Success
Public plan experiment ID.
The code to sell it with as planCode, such as pro:price-test. It always sells the experiment's latest version while running, and the plan's current version once closed.
running sells its latest version; won became the plan's current version; archived stopped selling.
running, won, archived The plan's version that was current when it started.
Its latest version.
The version its code sells to new buyers today.
Active, trialing, past due and paused subscriptions on its versions.
-9007199254740991 <= x <= 9007199254740991"plan_experiment"