Customer HTTP API
API for customer-scoped operations including authentication, usage, and receipt uploads
Specification: OpenAPI 3.1.0; API version 1.0.0.
Download the OpenAPI document.
See the API guide for authentication, shared errors and complete workflows.
Operation pages show the parameters, bodies and response statuses declared by the source specification. A missing declaration does not establish that a runtime requirement or error response cannot exist.
Operations
| Method | Path | Operation |
|---|---|---|
| POST | /api/client/projects/{projectId}/identify | Identify a customer with an identity token |
| POST | /api/client/projects/{projectId}/oauth/token | Exchange a Modem sign-in code and its PKCE verifier for a session |
| POST | /api/client/refresh | Refresh a customer session |
| GET | /api/client/projects/{projectId}/customers/{customerId}/usage | Retrieve a customer’s usage |
| GET | /api/client/projects/{projectId}/customers/{customerId}/usage/percentage | Retrieve a customer’s usage as a percentage |
| GET | /api/client/projects/{projectId}/customers/{customerId}/product | Retrieve a customer’s current product |
| GET | /api/client/projects/{projectId}/customers/{customerId}/products/{sourceProductId}/upgrade-options | List eligible upgrade destinations |
| POST | /api/client/projects/{projectId}/customers/{customerId}/product-upgrades/process | Verify and process an existing product upgrade |
| POST | /api/client/projects/{projectId}/customers/{customerId}/product-upgrades/confirm | Confirm a previewed paid product upgrade |
| POST | /api/client/projects/{projectId}/customers/{customerId}/product-upgrades/preview | Preview a paid product upgrade |
| GET | /api/client/projects/{projectId}/customers/{customerId}/products/active | List active subscribed products |
| POST | /api/client/projects/{projectId}/customers/{customerId}/upload-receipt | Upload a StoreKit receipt |
| POST | /api/client/projects/{projectId}/customers/{customerId}/stripe/{checkoutSessionId} | Process a completed Stripe Checkout Session |
| POST | /api/client/projects/{projectId}/products/{productId}/customers/{customerId}/stripe | Create a Stripe Checkout Session |
Last updated on