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": "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

Changed in 7 of the 27 revisions of this API.1297

    • response property purchase/allOf[UserInfoPurchaseDto]/plan/allOf[UserInfoPlanDto]/limits deprecated

      response-property-deprecated

  • 8578b7536a9f1062See the full diff
    • the response property purchase became nullable for the status 200

      response-property-became-nullable

    • the response property user became nullable for the status 200

      response-property-became-nullable

    • the purchase response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • the user response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • removed the required property purchase/planType from the response with the 200 status

      response-required-property-removed

    • removed the required property purchase/productName from the response with the 200 status

      response-required-property-removed

    • removed the required property purchase/reference from the response with the 200 status

      response-required-property-removed

    • removed the required property purchase/status from the response with the 200 status

      response-required-property-removed

    • removed the required property user/email from the response with the 200 status

      response-required-property-removed

    • removed the required property user/reference from the response with the 200 status

      response-required-property-removed

    • removed the optional property purchase/endDate from the response with the 200 status

      response-optional-property-removed

    • removed the optional property purchase/plan from the response with the 200 status

      response-optional-property-removed

    • removed the optional property purchase/startDate from the response with the 200 status

      response-optional-property-removed

    • removed the optional property purchase/usage from the response with the 200 status

      response-optional-property-removed

    • removed the optional property user/externalRef from the response with the 200 status

      response-optional-property-removed

    • removed the optional property user/name from the response with the 200 status

      response-optional-property-removed

    • added UserInfoPurchaseDto to the purchase response property allOf list for the response status 200

      response-property-all-of-added

    • added UserInfoUserDto to the user response property allOf list for the response status 200

      response-property-all-of-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • the customerRef request property's maxLength was set to 20

      request-property-max-length-set

    • the productRef request property's maxLength was set to 20

      request-property-max-length-set

    • the endpoint scheme security SecretKey was added to the API

      api-security-added

    • the endpoint scheme security bearer was removed from the API

      api-security-removed

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • removed the optional property purchase/usage/meterId from the response with the 200 status

      response-optional-property-removed

    • added the optional property purchase/usage/meterRef to the response with the 200 status

      response-optional-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • the customerRef request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • the productRef request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    This revision also has 44 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • endpoint added

      endpoint-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog