Valdyr
View as MarkdownOpen in ClaudeOpen in ChatGPT

End-User API

The API for an application that acts for one of your users: profile, customers, orders, and subscriptions

With the End-User API, your application acts for one signed-in user. The user reads their own profile, manages the customers that they belong to, places orders, and controls their subscriptions. The API limits every request to what that user can see and do.

Every request sends two credentials. An API key identifies your application, and a bearer token identifies the user. The base URL is {BASE_URL}/api/v2/end-user.

The End-User API and the Platform API share one version. The Api-Revision header and the revision pin of the API key work the same way on both.

Start here

Authentication

The impersonation key, the bearer token of the user, and what the API refuses.

Build for your users

Sign a user in, show their subscriptions, and sell a change through an order.

Errors

The structure of an error response, and what each status code means.

Versioning

The revision chain that both APIs share.

Browse the endpoints

AccountThe profile of the user that makes the request. AuthThe email login that gives the user the bearer token for every other operation. CustomersThe customers that the user manages, and the catalog of each one. InvoicesThe invoices of the customers that the user manages. LicensesThe licenses of the user. OrdersThe orders that the user makes and submits. Payment IntentsThe payments that the platform collected, or tried to collect, for those invoices. Payment SessionsThe payment sessions that collect the money for an order. Product CatalogsThe product catalogs that a storefront sells from, for the customer that the user orders for. SubscribersThe persons that use a subscription. Subscription ActionsThe recorded action attempts for the subscriptions of the user. Subscription AddonsThe add-ons on a subscription, and the add-ons that the user can buy. Subscription UsageThe data, voice and SMS usage of a subscription. SubscriptionsThe subscriptions of the user, and the SIM operations on them. ToolsLookups that an order flow needs before the user commits to an offering. SchemasEvery request, response and webhook payload schema in the API.