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

Merged
merged 5 commits into from
Jul 22, 2025
Merged

docs: add APIFY_USER_IS_PAYING env var documentation #1706

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c7b5f01
chore: add env var docs
Jul 21, 2025
902663b
fix: add missing period
Jul 21, 2025
89a1301
chore: improve styling
stepskop Jul 21, 2025
c44923d
fix: grammar
stepskop Jul 21, 2025
db508e4
chore: copy
stepskop Jul 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions sources/platform/actors/development/programming_interface/environment_variables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

| `ACTOR_WEB_SERVER_PORT` | TCP port for the Actor to start an HTTP server on. This server can be used to receive external messages or expose monitoring and control interfaces. The server also receives messages from the [Actor Standby](/platform/actors/development/programming-interface/standby) mode. |
| `ACTOR_WEB_SERVER_URL` | Unique public URL for accessing the Actor run web server from the outside world. |
| `APIFY_API_PUBLIC_BASE_URL` | Public URL of the Apify API. May be used to interact with the platform programmatically. Typically set to `api.apify.com`. |
Expand Down