SOsolvapay
Customers

Get customer session by sessionId

Changed on

Retrieves a customer session by its sessionId with all data hydrated including customer details and purchases. The session must belong to the authenticated provider.

get/v1/sdk/customers/customer-sessions/{sessionId}

Request

Path parameters

sessionIdstring required
Example:e3f1c2d4b6a89f001122334455667788

Customer session ID/token

Response

Customer session retrieved successfully

createdAtstring required

Session creation date

customerUrlstring required

Full customer URL based on backend configuration (ready to redirect customer)

expiresAtstring required

Session expiration date

sessionIdstring required

Customer session ID/token

status'active' | 'expired' | 'used' required

Session status

updatedAtstring required

Session last update date

Example response

{
  "createdAt": "2025-01-01T11:45:00.000Z",
  "customer": {
    "email": "customer@example.com",
    "externalRef": "auth_user_12345",
    "name": "John Doe",
    "purchases": [
      {
        "amount": 9900,
        "cancellationReason": "Customer request",
        "cancelledAt": "2025-10-28T10:00:00Z",
        "currency": "GBP",
        "customerEmail": "customer@example.com",
        "customerRef": "cus_3C4D5E6F",
        "endDate": "2025-11-27T10:00:00Z",
        "exchangeRate": 1.32,
        "isRecurring": true,
        "origin": "paid",
        "originalAmount": 7500,
        "planRef": "pln_abc123",
        "planSnapshot": {
          "currency": "USD",
          "isMetered": true,
          "name": "Pro Monthly",
          "price": 2999,
          "reference": "pln_1A2B3C4D"
        },
        "productName": "API Gateway Manager",
        "productRef": "prd_abc123",
        "reference": "pur_1A2B3C4D",
        "startDate": "2025-10-27T10:00:00Z",
        "status": "active",
        "usage": {
          "periodEnd": "2025-11-01T00:00:00Z",
          "periodStart": "2025-10-01T00:00:00Z"
        }
      }
    ],
    "reference": "cus_3c4d5e6f7g8h"
  },
  "customerUrl": "https://solvapay.com/customer/manage?id=e3f1c2d4b6a89f001122334455667788",
  "expiresAt": "2025-01-01T12:00:00.000Z",
  "sessionId": "e3f1c2d4b6a89f001122334455667788",
  "status": "active",
  "updatedAt": "2025-01-01T11:45:00.000Z"
}

Changes

  • e13ee57d07a6Revision changes
    • info

      added to the /////// response property allOf list for the response status

    • info

      removed from the /////// response property allOf list for the response status

  • aacdf8ae7816Revision changes
    • breaking

      the response property /////// became optional for the status

    • breaking

      the /////// response's property type changed from object to no type for status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added to the /////// response property allOf list for the response status

    • info

      added the required property /////// to the response with the status

    • info

      added the required property /////// to the response with the status

    • info

      added the required property /////// to the response with the status