v20

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-214885191.3 KB

User Info

Get user info and purchase status

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

post/v1/sdk/user-info

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": "meter_ABC123",
      "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"
}