Skip to content
This repository was archived by the owner on Jan 9, 2025. It is now read-only.

Commit 3af93b8

Browse files
authored
Merge pull request #103 from apify/feat/add-missing-update-limits
docs(api): Add missing update users limits endpoint
2 parents 1565fb7 + 8b59f65 commit 3af93b8

File tree

2 files changed

+39
-0
lines changed

2 files changed

+39
-0
lines changed
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
title: UpdateLimitsRequest
2+
type: object
3+
properties:
4+
maxMonthlyUsageUsd:
5+
type: number
6+
example: 300
7+
description: |
8+
If your platform usage in the billing period exceeds the prepaid usage, you will be charged extra.
9+
Setting this property you can update your hard limit on monthly platform usage to prevent accidental overage or to limit the extra charges
10+
dataRetentionDays:
11+
type: number
12+
example: 90
13+
description: |
14+
Apify securely stores your ten most recent Actor runs indefinitely, ensuring they are always accessible.
15+
Unnamed storages and other Actor runs are automatically deleted after the retention period.
16+
If you're subscribed, you can change it to keep data for longer or to limit your usage. [Lear more](https://docs.apify.com/platform/storage/usage#data-retention)

openapi/paths/users/users@me@limits.yaml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,26 @@ get:
1818
deprecated: false
1919
x-legacy-doc-urls:
2020
- https://docs.apify.com/api/v2#/reference/users/account-and-usage-limits/get-limits
21+
put:
22+
tags:
23+
- Users/Account and usage limits
24+
summary: Update limits
25+
description: |
26+
Updates the account's limits manageable on your account's [Limits page](https://console.apify.com/billing#/limits).
27+
Specifically the: `maxMonthlyUsageUsd` and `dataRetentionDays` limits (see request body schema for more details).
28+
operationId: users_me_limits_put
29+
requestBody:
30+
description: ''
31+
content:
32+
application/json:
33+
schema:
34+
$ref: ../../components/schemas/users/UpdateLimitsRequest.yaml
35+
responses:
36+
'201':
37+
description: ''
38+
headers: {}
39+
content:
40+
application/json:
41+
schema:
42+
type: object
43+
deprecated: false

0 commit comments

Comments
 (0)