Get user info and purchase status
Returns customer profile, active purchase details including usage and plan info, and a customer portal URL.
Request body
Response
User info with purchase status
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]/limitsdeprecatedresponse-property-deprecated
- ○
- ▲
the response property
purchasebecame nullable for the status200response-property-became-nullable
- ▲
the response property
userbecame nullable for the status200response-property-became-nullable
- ▲
the
purchaseresponse's property type/format changed fromobject/to/for status200response-property-type-changed
- ▲
the
userresponse's property type/format changed fromobject/to/for status200response-property-type-changed
- ▲
removed the required property
purchase/planTypefrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
purchase/productNamefrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
purchase/referencefrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
purchase/statusfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
user/emailfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
user/referencefrom the response with the200statusresponse-required-property-removed
- ●
removed the optional property
purchase/endDatefrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
purchase/planfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
purchase/startDatefrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
purchase/usagefrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
user/externalReffrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
user/namefrom the response with the200statusresponse-optional-property-removed
- ○
added
UserInfoPurchaseDtoto thepurchaseresponse propertyallOflist for the response status200response-property-all-of-added
- ○
added
UserInfoUserDtoto theuserresponse propertyallOflist for the response status200response-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
customerRefrequest property's maxLength was set to20request-property-max-length-set
- ●
the
productRefrequest property's maxLength was set to20request-property-max-length-set
- ●
- ○
the endpoint scheme security
SecretKeywas added to the APIapi-security-added
- ○
the endpoint scheme security
bearerwas removed from the APIapi-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/meterIdfrom the response with the200statusresponse-optional-property-removed
- ○
added the optional property
purchase/usage/meterRefto the response with the200statusresponse-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
customerRefrequest property's minLength was increased from0to1request-property-min-length-increased
- ▲
the
productRefrequest property's minLength was increased from0to1request-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
- ○