> ## Documentation Index
> Fetch the complete documentation index at: https://docs.praxis-ai.com/llms.txt
> Use this file to discover all available pages before exploring further.
# List payments
> Retrieves a paginated list of Stripe payments with optional filtering by account, institution, or user search
## OpenAPI
````yaml /mdx/api-reference/admin/admin-api.json post /api/admin/stripePayments
openapi: 3.0.0
info:
title: Pria Admin API
version: 2.0.1
description: >-
Pria API Documentation Praxis's developer platform is a core part of our
mission to empower organizations to grow better. Our APIs are designed to
enable teams of any shape or size to build robust integrations that help
them customize and get the most value out of Pria. All Pria APIs are built
using REST conventions and designed to have a predictable URL structure.
They use many standard HTTP features, including methods (POST,
GET, PUT, DELETE) and error response codes.
All API calls are
made under https://hiimpria.ai/api and all responses return standard JSON.
In these docs, you'll find lists of all available endpoints for a given API,
along with interactive code blocks for building requests. For walkthroughs
of basic usage for these APIs, check out the API guides.
servers:
- url: https://pria.praxislxp.com
description: Pria API Server
security: []
tags:
- name: Authentication
description: User authentication, registration, and password management (/api/auth)
- name: OAuth
description: OAuth authentication providers - Google, GitHub, SSO (/api/auth/oauth)
- name: User
description: User profile management and account operations (/api/user)
- name: User Institutions
description: User institution memberships and switching (/api/user/institution)
- name: User Tools
description: Available tools for authenticated users (/api/user/tools)
- name: Institutions
description: Institution settings and configuration (/api/user/institution)
- name: Conversation
description: AI conversation and Q&A endpoints (/api/ai)
- name: Realtime
description: Real-time voice AI and WebRTC sessions (/api/ai/rt)
- name: Assistant
description: AI assistant configuration and management (/api/user/assistant)
- name: History
description: Conversation history and favorites (/api/user/history)
- name: RAG
description: >-
Document upload, embedding, and retrieval-augmented generation
(/api/user/files, /api/user/rag)
- name: Setting
description: Instance variables and settings management (/api/user/setting)
- name: Branding
description: Digital twin branding and customization (/api/agent/branding)
- name: Agent
description: Agent engagement and session management (/api/agent)
- name: SDK Launch
description: >-
SDK launch token signing and verification for secure iframe embedding
(/api/auth/sdk-sign, /api/auth/sdk-verify)
- name: Testing
description: Health checks, diagnostics, and test endpoints (/api/test)
- name: Admin Accounts
description: Account management for super admins (/api/admin/account)
- name: Admin Institutions
description: Institution management for admins (/api/admin/institution)
- name: Admin Users
description: User management for admins (/api/admin/user)
- name: Admin Entitlements
description: >-
User-institution relationships and permissions
(/api/admin/userInstitution)
- name: Admin Sessions
description: Session management for admins (/api/admin/session)
- name: Admin Histories
description: Conversation history management and analytics (/api/admin/history)
- name: Admin Assistants
description: AI assistant management for admins (/api/admin/assistant)
- name: Admin Questions
description: Institution question and prompt management (/api/admin/question)
- name: Admin Tools
description: Tool configuration management (/api/admin/tool)
- name: Admin AI Models
description: AI model configuration (/api/admin/aimodel)
- name: Admin MCP Servers
description: Model Context Protocol server management (/api/admin/mcpserver)
- name: Admin Feedbacks
description: User feedback management (/api/admin/feedback)
- name: Admin Uploads
description: Upload management (/api/admin/upload)
- name: Admin Charts
description: Analytics and visualization chart management (/api/admin/chart)
- name: Admin Memory
description: Admin inspection and editing of user/instance memory parameters.
- name: Admin Usage Limits
description: Per-user usage-vs-cap reporting and account-wide at-limit counts.
paths:
/api/admin/stripePayments:
post:
tags:
- Admin Payments
summary: List payments
description: >-
Retrieves a paginated list of Stripe payments with optional filtering by
account, institution, or user search
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentSearchRequest'
responses:
'200':
description: Successfully retrieved payments list
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentListResponse'
'401':
description: Unauthorized - Invalid or missing access token
'403':
description: Forbidden - Admin access required
security:
- apiKeyAuth: []
components:
schemas:
PaymentSearchRequest:
type: object
properties:
account:
type: string
description: Account ID(s) to filter payments (space-separated for multiple)
institution:
type: string
description: Institution ID to filter payments
usersearch:
type: string
description: Search term for users (matches email, first name, last name)
page:
type: integer
minimum: 1
default: 1
description: Page number (1-based)
pageSize:
type: integer
minimum: 1
maximum: 5000
default: 100
description: Number of results per page
limitsearch:
type: integer
deprecated: true
description: Legacy limit parameter (use pageSize instead)
PaymentListResponse:
type: object
properties:
success:
type: boolean
description: Request success status
data:
type: array
items:
type: object
properties:
_id:
type: string
description: Payment record ID
date:
type: string
format: date-time
description: Payment date
user:
type: object
description: User who made the payment
properties:
_id:
type: string
email:
type: string
fname:
type: string
lname:
type: string
institution:
type: object
description: Institution associated with payment
nullable: true
properties:
_id:
type: string
name:
type: string
amount:
type: integer
description: Payment amount in cents
currency:
type: string
description: Currency code (e.g., "usd")
credits:
type: integer
description: Credits purchased
plan:
type: string
description: Plan name
source:
type: string
description: Payment source
description:
type: string
description: Payment description
invoiceUrl:
type: string
description: Stripe invoice URL
description: Array of payment objects
total:
type: integer
description: Total number of matching payments
hasMore:
type: boolean
description: Whether more results are available
page:
type: integer
description: Current page number
pageSize:
type: integer
description: Number of results per page
message:
type: string
description: Response message
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: x-access-token
description: JWT token passed in x-access-token header
````