Skip to content

docs: add metering quickstart walkthrough#180

Merged
mikewheeleer merged 1 commit into
Agentpay-Org:mainfrom
alan-provable:alan/issue-159-metering-quickstart
Jun 29, 2026
Merged

docs: add metering quickstart walkthrough#180
mikewheeleer merged 1 commit into
Agentpay-Org:mainfrom
alan-provable:alan/issue-159-metering-quickstart

Conversation

@alan-provable

Copy link
Copy Markdown
Contributor

Closes #159

Summary

  • Adds an end-to-end README quickstart for the metering and settlement flow.
  • Covers service registration, two usage writes, accumulator readback, billing quote, settlement, and final drained readback.
  • Notes current local-development API-key behavior and X-Request-Id correlation.

Validation

  • npm run build
  • npm run lint
  • npx prettier --check README.md
  • npm test (81 tests passed)
  • Ran the documented quickstart against http://127.0.0.1:3001; observed 201, 201, 201, 200, 200, 200, 200 and JSON responses matching the README examples.

@mikewheeleer

Copy link
Copy Markdown
Contributor

lgtm — merging this 🙌

@mikewheeleer mikewheeleer merged commit ff264a9 into Agentpay-Org:main Jun 29, 2026
1 check failed
@alan-provable

Copy link
Copy Markdown
Contributor Author

CI failed because package.json and package-lock.json had drifted on the base repo, so I pushed a follow-up commit that syncs the lockfile only. Re-ran validation after the lockfile sync: npm ci --ignore-scripts --no-audit --no-fund, npm run build, npm run lint, npx prettier --check README.md package-lock.json, git diff --check origin/main..HEAD, and npm test. The test suite is passing locally: 81 passed, 0 failed.

@alan-provable

Copy link
Copy Markdown
Contributor Author

Thanks for merging this.

If there is a preferred GrantFox reward process for the merged work, or any fixed-scope follow-up you want covered next, I am available. I will wait for maintainer or GrantFox assignment/confirmation before opening more PRs on related issues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add a quickstart cURL recipe walkthrough covering register → record → quote → settle

2 participants