Skip to content

docs: add APIFY_USER_IS_PAYING env var documentation #1706

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 5 commits into from
Jul 22, 2025
Merged

docs: add APIFY_USER_IS_PAYING env var documentation #1706

merged 5 commits into from
Jul 22, 2025

Conversation

stepskop
Copy link
Contributor

@stepskop stepskop commented Jul 21, 2025 •
edited
Loading

@stepskop stepskop self-assigned this Jul 21, 2025
@stepskop stepskop requested a review from TC-MO as a code owner July 21, 2025 15:36
@stepskop stepskop added adhoc Ad-hoc unplanned task added during the sprint. t-core-services Issues with this label are in the ownership of the core services team. labels Jul 21, 2025
@stepskop stepskop changed the title docs: add APIFY_USER_IS_PAYING env var docs docs: add APIFY_USER_IS_PAYING env var documentation Jul 21, 2025
@stepskop stepskop mentioned this pull request Jul 21, 2025
Merged
@apify-service-account
Copy link

Preview for this PR was built for commit c7b5f01c and is ready at https://pr-1706.preview.docs.apify.com!

@apify-service-account
Copy link

Preview for this PR was built for commit 902663b2 and is ready at https://pr-1706.preview.docs.apify.com!

@apify-service-account
Copy link

Preview for this PR was built for commit 89a13016 and is ready at https://pr-1706.preview.docs.apify.com!

@stepskop stepskop requested a review from barjin July 21, 2025 15:46
barjin
barjin reviewed Jul 21, 2025
View reviewed changes
Copy link
Contributor

@barjin barjin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, looks good!

I'm wondering, should we explain who is a paying user here? Or is it really as simple as "is not on the free plan"? :)

sources/platform/actors/development/programming_interface/environment_variables.md Outdated
@@ -62,6 +62,7 @@ Here's a table of key system environment variables:
| `ACTOR_TIMEOUT_AT` | Date when the Actor will time out. |
| `APIFY_TOKEN` | API token of the user who started the Actor. |
| `APIFY_USER_ID` | ID of the user who started the Actor. May differ from the Actor owner. |
| `APIFY_USER_IS_PAYING` | If set to `1`, the user calling the Actor is paying user. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| `APIFY_USER_IS_PAYING` | If set to `1`, the user calling the Actor is paying user. |
| `APIFY_USER_IS_PAYING` | If set to `1`, the user calling the Actor is a paying user. |

This was referenced Jul 21, 2025
Merged
Open
@stepskop
Copy link
Contributor Author

stepskop commented Jul 21, 2025 •
edited
Loading

Or is it really as simple as "is not on the free plan"? :)

It is that simple.

(actually not right now in this moment, now there are some issues with HT customers, which is also kind of an internal thing, but that will be gone in a week anyway, so I think we don't need to explain)

@apify-service-account
Copy link

Preview for this PR was built for commit c44923d4 and is ready at https://pr-1706.preview.docs.apify.com!

@barjin barjin self-requested a review July 22, 2025 05:48
TC-MO
TC-MO reviewed Jul 22, 2025
View reviewed changes
sources/platform/actors/development/programming_interface/environment_variables.md Outdated
@@ -62,6 +62,7 @@ Here's a table of key system environment variables:
| `ACTOR_TIMEOUT_AT` | Date when the Actor will time out. |
| `APIFY_TOKEN` | API token of the user who started the Actor. |
| `APIFY_USER_ID` | ID of the user who started the Actor. May differ from the Actor owner. |
| `APIFY_USER_IS_PAYING` | If set to `1`, the user calling the Actor is a paying user. |
Copy link
Contributor

@TC-MO TC-MO Jul 22, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not set by anyone manually, rather retrieved?

Suggested change
| `APIFY_USER_IS_PAYING` | If set to `1`, the user calling the Actor is a paying user. |
| `APIFY_USER_IS_PAYING` | Contains `1` if the user who started the Actor is a paying user. |

Copy link
Contributor Author

@stepskop stepskop Jul 22, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, it is set by the platform.

But to me, "Contains" is a little ambiguous. It sounds like it can be an array or a string having "1" in it. So I would be unsure what to expect from this variable ["2", "21", "1"] or "He11o".

What about If it is...., it means that...?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That makes sense to me, feel free to adjust like so, and I'll go over other env vars later today and make sure that language is similar

@stepskop stepskop requested a review from TC-MO July 22, 2025 13:47
TC-MO
TC-MO approved these changes Jul 22, 2025
View reviewed changes
Copy link
Contributor

@TC-MO TC-MO left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@apify-service-account
Copy link

Preview for this PR was built for commit db508e48 and is ready at https://pr-1706.preview.docs.apify.com!

@stepskop stepskop merged commit 31e1135 into master Jul 22, 2025
10 checks passed
@stepskop stepskop deleted the chore/add-user-is-paying branch July 22, 2025 13:51
stepskop added a commit to apify/apify-sdk-js that referenced this pull request Jul 28, 2025
@stepskop
chore: add userIsPaying to the env var interface (#415)
3cd8369 
Adds `APIFY_USER_IS_PAYING` environmental variable as `userIsPaying` to
the `ApifyEnv` interface.

PR adding it to the documentation is here:
apify/apify-docs#1706
@tobice tobice added the validated Issues that are resolved and their solutions fulfill the acceptance criteria. label Jul 28, 2025
stepskop added a commit to apify/apify-shared-python that referenced this pull request Jul 29, 2025
@stepskop
chore: add APIFY_USER_IS_PAYING env var to the ApifyEnvVars (#40)
411c7f1 
Adds `APIFY_USER_IS_PAYING` environmental variable to the `ApifyEnvVars`

PR with updated documentation is here:
apify/apify-docs#1706
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@barjin barjin barjin approved these changes

@TC-MO TC-MO TC-MO approved these changes

Assignees

@stepskop stepskop

Labels
adhoc Ad-hoc unplanned task added during the sprint. t-core-services Issues with this label are in the ownership of the core services team. validated Issues that are resolved and their solutions fulfill the acceptance criteria.
Projects
None yet
Milestone
119th sprint - Core Services team
Development

Successfully merging this pull request may close these issues.
5 participants
@stepskop @apify-service-account @barjin @TC-MO @tobice