Skip to Content

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

MethodPathOperation
POST/api/client/projects/{projectId}/identifyIdentify a customer with an identity token
POST/api/client/projects/{projectId}/oauth/tokenExchange a Modem sign-in code and its PKCE verifier for a session
POST/api/client/refreshRefresh a customer session
GET/api/client/projects/{projectId}/customers/{customerId}/usageRetrieve a customer’s usage
GET/api/client/projects/{projectId}/customers/{customerId}/usage/percentageRetrieve a customer’s usage as a percentage
GET/api/client/projects/{projectId}/customers/{customerId}/productRetrieve a customer’s current product
GET/api/client/projects/{projectId}/customers/{customerId}/products/{sourceProductId}/upgrade-optionsList eligible upgrade destinations
POST/api/client/projects/{projectId}/customers/{customerId}/product-upgrades/processVerify and process an existing product upgrade
POST/api/client/projects/{projectId}/customers/{customerId}/product-upgrades/confirmConfirm a previewed paid product upgrade
POST/api/client/projects/{projectId}/customers/{customerId}/product-upgrades/previewPreview a paid product upgrade
GET/api/client/projects/{projectId}/customers/{customerId}/products/activeList active subscribed products
POST/api/client/projects/{projectId}/customers/{customerId}/upload-receiptUpload 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}/stripeCreate a Stripe Checkout Session

Workflow guides

Last updated on