-
Notifications
You must be signed in to change notification settings - Fork 148
docs: ppr announced as legacy model, ppr to ppe migration #2144
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from all commits
e396273
ea15b67
6facd19
499d4e8
12d9de3
d2add14
d4ef2ef
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -12,10 +12,44 @@ sidebar_position: 2 | |||||||||||||
| import Tabs from '@theme/Tabs'; | ||||||||||||||
| import TabItem from '@theme/TabItem'; | ||||||||||||||
|
|
||||||||||||||
| :::warning Legacy pricing model | ||||||||||||||
|
|
||||||||||||||
| Pay per result is deprecated and will be superseded by Pay per event early in 2026. [Migrate to PPE in one click](#one-click-migration-to-ppe) (backward compatible) | ||||||||||||||
|
|
||||||||||||||
| ::: | ||||||||||||||
|
|
||||||||||||||
| In this model, you set a price per 1,000 results. Users are charged based on the number of results your Actor produces and stores in the run's default dataset. Your profit is calculated as 80% of the revenue minus platform usage costs. | ||||||||||||||
|
|
||||||||||||||
| The details on how your cost is computed can be found in [Example of a PPR pricing model](#example-of-a-ppr-pricing-model). | ||||||||||||||
|
|
||||||||||||||
| ## One click migration to PPE | ||||||||||||||
|
|
||||||||||||||
| Select your PPR Actor, go to the Publication tab, open the Monetization section, and click the `Migrate to Pay per event` button. | ||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||
|
|
||||||||||||||
|  | ||||||||||||||
|
|
||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🙌 |
||||||||||||||
| ### Why should I migrate? | ||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| The Pay per event pricing model offers superior flexibility in charging not only for the results but also for any event. | ||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
You can also use italics to highlight: price per event model offers...
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is valid for the entire PR, there's several locations where capital P is used unnecessarily |
||||||||||||||
| This helps you to pass on the costs of external APIs or additional processing directly to your users, price different functionalities of your Actor differently, avoid revenue loss from small but usage-heavy runs, and more. | ||||||||||||||
|
|
||||||||||||||
|
|
||||||||||||||
| Given that the Pay per event model is fully compatible with Pay per result, and to bring more simplicity to users of your Actors, we are fully deprecating PPR in favor of PPE. | ||||||||||||||
| The migration is completely automatic and fully backward compatible. | ||||||||||||||
|
|
||||||||||||||
| ### What happens during migration | ||||||||||||||
|
|
||||||||||||||
| The migration switches your pricing model from Pay per result to Pay per event. Your price per 1,000 results is automatically converted to an equivalent `apify-default-dataset-item` [event](./pay-per-event#use-synthetic-default-dataset-item-event-apify-default-dataset-item) price. | ||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I was thinking of adding this exact line but then I removed it. |
||||||||||||||
| This change does not count towards the pricing change limits that you are allowed to do once every 30 days. | ||||||||||||||
|
|
||||||||||||||
| **Code changes:** No changes to your Actor code are required if it already respects the `ACTOR_MAX_PAID_DATASET_ITEMS` environment variable (the price limit set by users). | ||||||||||||||
|
|
||||||||||||||
| **After migration:** With Pay per event, you can define additional custom events beyond dataset items. [Learn more](./pay-per-event) | ||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| **Respecting user spending limits:** You can continue using the `ACTOR_MAX_PAID_DATASET_ITEMS` environment variable to respect user-specified price limits. | ||||||||||||||
|
|
||||||||||||||
| Bleu sky and flying high free as a bird | ||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What is this? Is this some sort of Lorem Ipsum? |
||||||||||||||
|
|
||||||||||||||
| ## How is profit computed | ||||||||||||||
|
|
||||||||||||||
| Your profit is calculated from the mentioned formula: | ||||||||||||||
|
|
||||||||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PPR is depracted & considered legacy right now, but will be superseded by PPE early in 2026? That doesn't make sense to me.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It has been deprecated now and will be completely replaced with PPE. Not sure how to word that the best.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps something like this:
or
In v1 we mention just a year, reason being to give reasonable timeframe, but not commit to anything specific.
In v2 I've skipped a year completely to just reflect current state, without mentioning any future possibilities.