> ## Documentation Index > Fetch the complete documentation index at: https://docs.hyperprop.com/llms.txt > Use this file to discover all available pages before exploring further. # Get purchases for your organization > Retrieve all purchase records for your organization with powerful filtering options. **What is a purchase?** A purchase represents a transaction where a trader bought an evaluation plan or funded account from your organization. Each purchase is linked to one or more trading accounts. **What you get:** - Purchase details (date, price, currency, status) - The trading plan that was purchased - All trading accounts created from this purchase - Custom metadata you've added (any JSON data) **Filtering & Search:** | Parameter | Description | Example | |-----------|-------------|---------| | `status` | Filter by purchase status | `?status=paid` | | `metadata` | Filter by metadata key:value | `?metadata=promoCode:SUMMER25` | | `search` | Search in metadata (text) | `?search=stripe_pi_123` | | `startDate` | Purchases from this date | `?startDate=2025-01-01` | | `endDate` | Purchases until this date | `?endDate=2025-01-31` | **Pagination:** Results are paginated. Use `limit` and `offset` to navigate through large datasets. **Example queries:** ```http # Get all paid purchases GET /organization/purchases?status=paid # Get purchases with a specific promo code from January 2025 GET /organization/purchases?metadata=promoCode:SUMMER25&startDate=2025-01-01&endDate=2025-01-31 # Search for a specific transaction GET /organization/purchases?search=stripe_pi_3ABC123 # Page 2 with 25 results per page GET /organization/purchases?limit=25&offset=25 ``` **Use cases:** - Generate revenue reports - Track refunds and chargebacks - Find purchases by a specific trader - Audit purchase history for compliance ## OpenAPI ````yaml /api-reference/openapi.json get /v1/organization/purchases openapi: 3.0.0 info: title: Hyperprop Platform API version: 1.0.0 description: >- REST API for the Hyperprop Trading Platform — provision evaluation and funded trading accounts, manage traders and plans, react to account lifecycle events via signed webhooks, and reconcile billing. Built for prop firms integrating from their own backend. Authentication, quick start, error handling, idempotency, pagination, custom metadata, webhooks, and the MCP connector are documented at https://docs.hyperprop.com. x-logo: url: https://app.hyperprop.com/logo-icon.svg altText: Hyperprop href: https://hyperprop.com servers: - url: https://api.hyperprop.com/platform description: Production security: [] tags: - name: Trading accounts description: Create, update, and inspect trading accounts. - name: Traders description: Look up and update the traders in your organization. - name: Trading plans description: Define the plans you sell. - name: Trading rules description: Define how accounts are evaluated. - name: Lockouts description: Pause and resume trading on an account. - name: Payouts description: Check payout eligibility and record payouts. - name: Purchases description: Purchases recorded for your organization. - name: Time Machine description: Restore accounts to an earlier trading day or instant. - name: Webhooks description: Register webhook endpoints and inspect deliveries. - name: Events description: Your organization's event history and real-time event stream. - name: Reconciliation description: Balances, end-of-day snapshots, and fills for reconciliation. - name: Analytics description: Organization performance and plan economics. - name: Billing description: 'Your Hyperprop bill: activity, billing cycles, and forecasts.' - name: Team and roles description: Manage dashboard access for your staff. - name: API keys description: Manage your organization's API key. - name: Logs and health description: API request logs, the audit log, and integration health. - name: Organization profile description: Your organization's profile and logo. - name: Support description: Open and follow up on support tickets. - name: Partner access description: >- Read a trader's journal as an approved partner app, with the trader's own key. paths: /v1/organization/purchases: get: tags: - Purchases summary: Get purchases for your organization description: >- Retrieve all purchase records for your organization with powerful filtering options. **What is a purchase?** A purchase represents a transaction where a trader bought an evaluation plan or funded account from your organization. Each purchase is linked to one or more trading accounts. **What you get:** - Purchase details (date, price, currency, status) - The trading plan that was purchased - All trading accounts created from this purchase - Custom metadata you've added (any JSON data) **Filtering & Search:** | Parameter | Description | Example | |-----------|-------------|---------| | `status` | Filter by purchase status | `?status=paid` | | `metadata` | Filter by metadata key:value | `?metadata=promoCode:SUMMER25` | | `search` | Search in metadata (text) | `?search=stripe_pi_123` | | `startDate` | Purchases from this date | `?startDate=2025-01-01` | | `endDate` | Purchases until this date | `?endDate=2025-01-31` | **Pagination:** Results are paginated. Use `limit` and `offset` to navigate through large datasets. **Example queries:** ```http # Get all paid purchases GET /organization/purchases?status=paid # Get purchases with a specific promo code from January 2025 GET /organization/purchases?metadata=promoCode:SUMMER25&startDate=2025-01-01&endDate=2025-01-31 # Search for a specific transaction GET /organization/purchases?search=stripe_pi_3ABC123 # Page 2 with 25 results per page GET /organization/purchases?limit=25&offset=25 ``` **Use cases:** - Generate revenue reports - Track refunds and chargebacks - Find purchases by a specific trader - Audit purchase history for compliance operationId: getV1OrganizationPurchases parameters: - description: Filter by purchase status (pending, paid, refunded, cancelled) name: status in: query required: false schema: type: string enum: - pending - paid - refunded - cancelled - description: >- Filter by metadata key:value (e.g., "refunded:true", "campaign:affiliate") name: metadata in: query required: false schema: type: string - description: >- Matches metadata text, your external purchase ID (partial, case-insensitive), or the purchase ID (full UUID) name: search in: query required: false schema: type: string - description: Only include purchases from this date onwards x-format: isoDate: true name: startDate in: query required: false schema: type: string - description: Only include purchases up to this date x-format: isoDate: true name: endDate in: query required: false schema: type: string - description: 'Results per page (default: 50, max: 100)' name: limit in: query schema: type: integer minimum: 1 maximum: 100 default: 50 - description: Skip this many results (for pagination) name: offset in: query schema: type: integer minimum: 0 default: 0 - description: >- Cursor for pagination. Pass the `nextCursor` value from the previous response to get the next page. When using cursor, do not send `offset` — it will be ignored. **How it works:** The cursor is an opaque string that points to the last item you received. The server uses it to efficiently fetch the next set of results without scanning previous pages. **Backwards compatible:** If you don't send a cursor, offset/limit pagination works as before. name: cursor in: query required: false schema: type: string - description: >- Sort results. Format: `field:direction` where direction is `asc` or `desc`. **Allowed fields:** `created_at`, `purchase_date`, `price_paid`, `status` **Default:** `created_at:desc` **Examples:** `created_at:asc`, `current_balance:desc` name: sort in: query required: false schema: type: string responses: '200': description: Success - Returns paginated list of purchases content: '*/*': schema: $ref: '#/components/schemas/Model98' '401': description: Unauthorized - Invalid or missing API key content: '*/*': schema: $ref: '#/components/schemas/Model99' '403': description: Forbidden - Your account is not associated with an organization content: '*/*': schema: $ref: '#/components/schemas/Model100' '500': description: An unexpected error occurred content: '*/*': schema: $ref: '#/components/schemas/Model5' security: - X-API-Key: [] components: schemas: Model98: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/Model97' Model99: type: object properties: statusCode: type: number example: 401 error: type: string example: Unauthorized message: type: string example: Invalid or expired session Model100: type: object properties: statusCode: type: number example: 403 error: type: string example: Forbidden message: type: string example: This endpoint is only available for organization users code: type: string example: NOT_ORGANIZATION_USER Model5: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 500 error: type: string example: Internal Server Error message: type: string example: An unexpected error occurred code: type: string description: Machine-readable error code — switch on this, not on message text example: INTERNAL_ERROR Model97: type: object example: organizationId: a6fcc0ce-eb28-4f43-b256-96a3144b0d34 organizationName: FakePropFirm purchases: - id: f47ac10b-58cc-4372-a567-0e02b2c3d479 purchaseDate: '2025-01-15T10:00:00.000Z' startDate: '2025-01-15T10:00:00.000Z' endDate: '2025-02-14T10:00:00.000Z' status: paid pricePaid: 299 currency: USD metadata: stripePaymentId: pi_3ABC123 promoCode: SUMMER25 tradingPlan: id: 09c93da5-f057-4cc5-82da-ff9220292c94 name: 50K Challenge accountSize: 50000 accounts: - id: 7c9e6679-7425-40de-944b-e07fc1f90ae7 accountNumber: ACC-7845KXPQ status: in_progress userId: 550e8400-e29b-41d4-a716-446655440000 userEmail: trader@example.com createdAt: '2025-01-15T10:00:00.000Z' updatedAt: '2025-01-15T10:00:00.000Z' pagination: total: 150 limit: 50 offset: 0 hasMore: true properties: organizationId: type: string description: Your organization ID organizationName: type: string description: Your organization name purchases: $ref: '#/components/schemas/purchases' pagination: $ref: '#/components/schemas/Model96' purchases: type: array description: Array of purchase records items: $ref: '#/components/schemas/Model95' Model96: type: object properties: total: type: number description: Total purchases matching your filters limit: type: number description: Results per page offset: type: number description: Current offset hasMore: type: boolean description: True if more results exist beyond this page nextCursor: type: string description: >- Cursor for the next page. Pass as ?cursor= to get the next set of results. Null if no more results. Model95: type: object properties: id: type: string description: Unique purchase ID purchaseDate: type: string description: When the purchase was made startDate: type: string description: When the evaluation period started endDate: type: string description: When the evaluation period ends status: type: string description: Purchase status (pending, paid, refunded, cancelled) pricePaid: type: number description: Amount paid currency: type: string description: Payment currency metadata: $ref: '#/components/schemas/metadata' tradingPlan: $ref: '#/components/schemas/tradingPlan' accounts: $ref: '#/components/schemas/Model94' createdAt: type: string updatedAt: type: string metadata: type: object description: Custom metadata - any JSON data you need tradingPlan: type: object description: The plan that was purchased properties: id: type: string name: type: string accountSize: type: number Model94: type: array description: Trading accounts created from this purchase items: $ref: '#/components/schemas/Model93' Model93: type: object properties: id: type: string accountNumber: type: string status: type: string userId: type: string userEmail: type: string securitySchemes: X-API-Key: type: apiKey name: X-API-Key in: header description: >- Organization API key. Format: "hp_live_{key}". Organization admins manage the key in the dashboard. ```` ## Related topics - [Get trading accounts for your organization](/platform-api/trading-accounts/get-trading-accounts-for-your-organization.md) - [Get your organization profile](/platform-api/organization-profile/get-your-organization-profile.md) - [Get traders for your organization](/platform-api/traders/get-traders-for-your-organization.md) - [Get trading plans for your organization](/platform-api/trading-plans/get-trading-plans-for-your-organization.md) - [Get team members for your organization](/platform-api/team-and-roles/get-team-members-for-your-organization.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.