> ## Documentation Index
> Fetch the complete documentation index at: https://api.fanvue.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List action purchases for one of your experiences

> Returns the action purchases fans have made in one of your experiences, newest first, so you can reconcile against the webhooks you received.

    **Fulfil on the webhook, never on the bridge result.** Grant the action when you receive `app.experience.action.payment.succeeded`, keyed on `purchase_reference` so a redelivery grants nothing twice. The `purchaseResult` message your iframe receives from Fanvue is UX only — it tells your surface to stop showing a spinner, and it is never proof that money moved. This read is the reconciliation path: poll it when you think you missed a webhook, or to confirm one you are unsure about.

    Owner app only: the experience must belong to the app whose credentials make the call, otherwise 403. Purchases belonging to another app are never returned, and a foreign experience uuid is refused before anything about it is read — this is not a way to enumerate experiences, creators or fans.

    Every attempt is listed, not only the settled ones, so a `pending` that never landed and a `refunded` purchase are both visible. `amount` is in minor units (cents), frozen at the purchase attempt. Paging is keyset: pass the `nextCursor` from a prior response, and a purchase created while you page never shifts a row onto or off a later page.

> [!NOTE]
>
> **Required scope**
>
> * `read:experience` — Exchange a fan's experience token for the resolved experience and the fan's identity, so an embedded fan-facing experience can render the right content.


## OpenAPI

````yaml /openapi-v1.json get /v1/experiences/{experienceUuid}/action-purchases
openapi: 3.1.0
info:
  title: Fanvue API
  version: '0.1'
servers:
  - url: https://api.fanvue.com
security: []
paths:
  /v1/experiences/{experienceUuid}/action-purchases:
    get:
      summary: List action purchases for one of your experiences
      description: >-
        Returns the action purchases fans have made in one of your experiences,
        newest first, so you can reconcile against the webhooks you received.

            **Fulfil on the webhook, never on the bridge result.** Grant the action when you receive `app.experience.action.payment.succeeded`, keyed on `purchase_reference` so a redelivery grants nothing twice. The `purchaseResult` message your iframe receives from Fanvue is UX only — it tells your surface to stop showing a spinner, and it is never proof that money moved. This read is the reconciliation path: poll it when you think you missed a webhook, or to confirm one you are unsure about.

            Owner app only: the experience must belong to the app whose credentials make the call, otherwise 403. Purchases belonging to another app are never returned, and a foreign experience uuid is refused before anything about it is read — this is not a way to enumerate experiences, creators or fans.

            Every attempt is listed, not only the settled ones, so a `pending` that never landed and a `refunded` purchase are both visible. `amount` is in minor units (cents), frozen at the purchase attempt. Paging is keyset: pass the `nextCursor` from a prior response, and a purchase created while you page never shifts a row onto or off a later page.
      operationId: listExperienceActionPurchases
      parameters:
        - $ref: '#/components/parameters/ApiVersionHeader'
        - schema:
            type: string
            format: uuid
            example: 00000000-0000-4000-8000-000000000010
          required: true
          name: experienceUuid
          in: path
        - schema:
            type: integer
            exclusiveMinimum: 0
            maximum: 100
            description: Number of results to return (default 50, max 100).
          required: false
          description: Number of results to return (default 50, max 100).
          name: limit
          in: query
        - schema:
            type: string
            description: Opaque cursor for the next page, from a prior response.
          required: false
          description: Opaque cursor for the next page, from a prior response.
          name: cursor
          in: query
      responses:
        '200':
          description: A page of the experience's action purchases
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        purchaseReference:
                          type: string
                          description: >-
                            The `expact_…` reference minted with the purchase
                            attempt. THE fulfilment idempotency key: grant the
                            action at most once per reference, and only for a
                            purchase whose status is `succeeded`.
                          example: expact_5c9a1f0e-9f3f-4c2a-8f31-1d0f6a2b7c44
                        experienceUuid:
                          type: string
                          format: uuid
                          description: The experience the action belongs to.
                          example: 00000000-0000-4000-8000-000000000010
                        externalActionId:
                          type: string
                          description: >-
                            The app's own stable key for the action that was
                            bought.
                          example: spin
                        clientReferenceId:
                          type:
                            - string
                            - 'null'
                          description: >-
                            The app-supplied reference carried through the
                            purchase, or null when the app supplied none.
                          example: round-42
                        buyerUuid:
                          type: string
                          format: uuid
                          description: >-
                            UUID of the fan who bought the action. The only
                            identifier of the buyer this surface carries — no
                            handle, no display name, no email.
                          example: 00000000-0000-4000-8000-000000000003
                        amount:
                          type: integer
                          description: >-
                            Price in minor currency units (cents), frozen at the
                            purchase attempt. A later re-pricing of the action
                            does not move it.
                          example: 700
                        currency:
                          type: string
                          description: ISO 4217 code of the amount. USD only today.
                          example: USD
                        status:
                          type: string
                          enum:
                            - pending
                            - succeeded
                            - failed
                            - refunded
                            - disputed
                            - cancelled
                          description: >-
                            Where the money for this purchase attempt ended up.
                            Fulfil only on `succeeded`. `refunded`, `disputed`
                            and `cancelled` all mean the money is not the
                            creator's, so revoke on any of them — the difference
                            between them only records how the reversal was
                            written, not whether to act. `refunded` is a
                            reversal carrying a refund reference (a settled
                            payment paid back, or an authorisation voided before
                            capture); `disputed` is a chargeback that was lost
                            and reversed; `cancelled` is a reversal carrying
                            neither reference (a delayed capture that failed, or
                            the uncaptured-invoice sweeper). An open dispute
                            that has not been lost is still `succeeded` here —
                            the money has not moved — so watch
                            `app.experience.action.dispute.*` for that, not this
                            field. A refund the processor accepted and then
                            rejected also reports `succeeded` again: this field
                            is where the money ended up, not what was attempted.
                        invoiceNumber:
                          type: string
                          description: >-
                            Fanvue invoice number for the charge. For support
                            and accounting, not fulfilment.
                          example: FVE-20260904-1234
                        createdAt:
                          type: string
                          format: date-time
                          description: When the purchase attempt was opened.
                          example: '2026-09-04T10:00:00.000Z'
                        paidAt:
                          type:
                            - string
                            - 'null'
                          format: date-time
                          description: When the charge settled, or null while it has not.
                          example: '2026-09-04T10:00:02.000Z'
                      required:
                        - purchaseReference
                        - experienceUuid
                        - externalActionId
                        - clientReferenceId
                        - buyerUuid
                        - amount
                        - currency
                        - status
                        - invoiceNumber
                        - createdAt
                        - paidAt
                  nextCursor:
                    type:
                      - string
                      - 'null'
                    description: Cursor for the next page, or null if none.
                required:
                  - data
                  - nextCursor
              example:
                data:
                  - purchaseReference: expact_5c9a1f0e-9f3f-4c2a-8f31-1d0f6a2b7c44
                    experienceUuid: 00000000-0000-4000-8000-000000000010
                    externalActionId: spin
                    clientReferenceId: round-42
                    buyerUuid: 00000000-0000-4000-8000-000000000003
                    amount: 700
                    currency: USD
                    status: succeeded
                    invoiceNumber: FVE-20260904-1234
                    createdAt: '2026-09-04T10:00:00.000Z'
                    paidAt: '2026-09-04T10:00:02.000Z'
                  - purchaseReference: expact_9b1e2d43-6d81-4f0a-9a77-2b4c8e5f1a03
                    experienceUuid: 00000000-0000-4000-8000-000000000010
                    externalActionId: reveal
                    clientReferenceId: null
                    buyerUuid: 00000000-0000-4000-8000-000000000004
                    amount: 250
                    currency: USD
                    status: refunded
                    invoiceNumber: FVE-20260904-1235
                    createdAt: '2026-09-04T09:58:00.000Z'
                    paidAt: '2026-09-04T09:58:03.000Z'
                nextCursor: null
        '400':
          description: >-
            Bad Request - API version not supported OR validation failed OR the
            cursor could not be decoded
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '401':
          $ref: '#/components/responses/UnauthorizedResponse'
        '403':
          $ref: '#/components/responses/UnauthorizedResponse'
        '404':
          description: Experience not found, or not owned by the calling app
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '410':
          $ref: '#/components/responses/SunsetVersionResponse'
        '429':
          $ref: '#/components/responses/RateLimitResponse'
        '502':
          description: Failed to read the purchases from the upstream
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '503':
          description: Developer API upstream is not configured
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
      security:
        - BearerAuth:
            - read:experience
components:
  parameters:
    ApiVersionHeader:
      name: X-Fanvue-API-Version
      in: header
      required: true
      schema:
        type: string
        default: '2025-06-26'
        example: '2025-06-26'
      description: API version to use for the request
  responses:
    UnauthorizedResponse:
      description: Unauthorized Response
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
            required:
              - error
    SunsetVersionResponse:
      description: API version no longer supported (sunset)
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
              message:
                type: string
              nextVersion:
                type: string
            required:
              - error
              - message
    RateLimitResponse:
      description: Too many requests - rate limit exceeded
      headers:
        Retry-After:
          description: Number of seconds to wait before retrying the request
          schema:
            type: integer
        X-RateLimit-Limit:
          description: The maximum number of requests allowed in the current window
          schema:
            type: integer
        X-RateLimit-Remaining:
          description: The number of requests remaining in the current window
          schema:
            type: integer
        X-RateLimit-Reset:
          description: The Unix timestamp (seconds) when the rate limit window resets
          schema:
            type: integer
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
            required:
              - error
  securitySchemes:
    BearerAuth:
      type: oauth2
      description: >-
        OAuth 2.0 access token, presented as a JWT bearer token in the
        `Authorization` header. Obtain a token via the authorization-code flow;
        the scopes granted to the token determine which operations it may call.
      flows:
        authorizationCode:
          authorizationUrl: https://auth.fanvue.com/oauth2/auth
          tokenUrl: https://auth.fanvue.com/oauth2/token
          refreshUrl: https://auth.fanvue.com/oauth2/token
          scopes:
            read:self: >-
              Access your own user profile information, including basic account
              details and settings.
            read:chat: >-
              Read chat conversations, messages, and chat-related data. This
              includes viewing chat lists and message history.
            write:chat: >-
              Create new chats and send messages. This scope is required for any
              chat-related actions that modify data.
            read:experience: >-
              Exchange a fan's experience token for the resolved experience and
              the fan's identity, so an embedded fan-facing experience can
              render the right content.
            write:experience: >-
              Request that the creator publish or unpublish a fan-facing
              experience. The app mints a request token; the creator confirms
              and Fanvue performs the change.
            read:fan: Access fan-related data and information within the platform.
            read:post: Read posts, including post details, comments, likes, and tips.
            write:post: Create, edit, and manage posts and content on behalf of users.
            read:media: Access media files, images, videos, and other content assets.
            write:media: >-
              Upload, modify, and manage media files and content assets. Also
              required for vault folder management.
            read:creator: >-
              Access creator profiles, content, and creator-specific
              information.
            write:creator: Modify creator profiles, settings, and creator-specific data.
            read:insights: >-
              Access analytics, metrics, and insights data for performance
              tracking.
            read:tracking_links: >-
              Read tracking links and the users associated with them, including
              per-user tracking metadata.
            write:tracking_links: Create and delete tracking links.
            read:agency: Read agency information, including the agency's team members.
            write:agency: >-
              Manage agency team members and invites, including inviting new
              team members and creators.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.