mmb Field guide
API referenceapi/v1/auth/upgrade/claim
MMB / FIELD GUIDE Ideas into action.

Poll an upgrade checkout session

Returns pending until the Stripe webhook lands, then completed with the updated usage summary.

POST
/api/v1/auth/upgrade/claim

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

Legacy reader upgrade (disabled)

The library is free. This legacy endpoint returns library_is_free; new reader checkout sessions are disabled.

Start a device authorization (RFC 8628)

Begins the CLI login flow. Show the user_code and verification_uri to the user, then poll POST /api/v1/auth/device/token.