User Info

Get user info and purchase status

Changed on Aug 13, 2026

Returns customer profile, active purchase details including usage and plan info, and a customer portal URL.

post/v1/sdk/user-info

Request

Base URL
https://api.solvapay.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/solvapay/apis/solvapay-rest-api/docs/v1/sdk/user-info/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

customerRefstring required

productRefstring required

Response

User info with purchase status

statusstring required

Human-readable status summary

verifyUrlstring nullable

Customer portal session URL

Example response

{
  "purchase": {
    "endDate": "2025-11-27T10:00:00Z",
    "plan": {
      "billingCycle": "monthly",
      "currency": "USD",
      "price": 2999,
      "reference": "pln_2B3C4D5E",
      "type": "recurring"
    },
    "planType": "recurring",
    "productName": "My API Product",
    "reference": "pur_1A2B3C4D",
    "startDate": "2025-10-27T10:00:00Z",
    "status": "active",
    "usage": {
      "meterRef": "requests",
      "percentUsed": 25,
      "remaining": 750,
      "total": 1000,
      "used": 250
    }
  },
  "status": "Active subscription: My API Product (25% usage consumed)",
  "user": {
    "email": "john@example.com",
    "externalRef": "auth_user_12345",
    "name": "John Doe",
    "reference": "cus_3C4D5E6F"
  },
  "verifyUrl": "https://solvapay.com/customer/manage?id=abc123"
}

Changes

Aug 13, 2026e356f6586bf2 Revision changes
- info
  response property purchase/allOf[UserInfoPurchaseDto]/plan/allOf[UserInfoPlanDto]/limits deprecated
Jul 30, 20268578b7536a9f Revision changes
- breaking
  the response property became nullable for the status
- breaking
  the response property became nullable for the status
- breaking
  the response's property type changed from object to no type for status
- breaking
  the response's property type changed from object to no type for status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- info
  added to the response property allOf list for the response status
- info
  added to the response property allOf list for the response status

Operation history (9 revisions)