Skip to content

feat: add plan limit information to plan/get results #150

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
volmedo merged 2 commits into from
Jan 26, 2026
Merged

feat: add plan limit information to plan/get results #150

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
911cba2
feat: add plan limit information to plan/get results
volmedo Jan 22, 2026
d786367
no limit is signaled by an absent limit
volmedo Jan 23, 2026
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
5 changes: 4 additions & 1 deletion w3-plan.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,9 @@ The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "S

### `plan/get`

Capability can be invoked to get information about the plan that the account is currently signed up for.
Capability can be invoked to get information about the plan that the account is currently signed up for. The plan name and the storage limit are returned.

The plan limit is expressed in bytes and is not to be confused with the storage **included** in the plan. An absent limit indicates that uploads will not be rejected due to hitting a limit (the plan is effectively "unlimited"), which doesn't mean the customer won't be charged for the extra storage.

> `did:mailto:web.mail:alice` invokes `plan/get` capability provided by `did:web:web3.storage`

Expand Down Expand Up @@ -66,6 +68,7 @@ Capability can be invoked to get information about the plan that the account is
"out": {
"ok": {
"product": "did:web:starter.web3.storage",
"limit": "5368709120",
"updatedAt": "2024-01-05T06:56:26.074Z"
}
}
Expand Down