Skip to main content
GET
Get the authenticated user's one-time (app-OTP) payment by invoice number
Required scope
  • read:self — Access your own user profile information, including basic account details and settings.

Authorizations

Authorization
string
header
required

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.

Headers

X-Fanvue-API-Version
string
default:2025-06-26
required

API version to use for the request

Example:

"2025-06-26"

Path Parameters

appUuid
string<uuid>
required
Example:

"00000000-0000-4000-8000-000000000001"

invoiceNumber
string
required
Example:

"FVE-20260619-1234"

Response

The user's one-time payment

uuid
string
required

Horizon purchase identifier.

appUuid
string
required

UUID of the app the purchase belongs to.

buyerUuid
string
required

UUID of the purchasing Fanvue user.

planUuid
string
required

UUID of the purchased pricing plan / item.

invoiceNumber
string | null
required

Fanvue invoice number. Use as the idempotency key for fulfilment. Null for purchases that settled before reconciliation was enabled, or not yet settled.

billingReferenceId
string
required

The appotp_… reference minted at checkout.

clientReferenceId
string
required

Merchant-supplied reference passed at checkout via ?client_reference_id=; empty string when unset.

status
enum<string>
required

Lifecycle status of the one-time purchase.

Available options:
pending,
completed,
failed,
refunded,
expired
amount
number
required

Amount in minor currency units, snapshotted at checkout.

currency
string
required

ISO currency code.

externalPaymentId
string
required

Provider payment id; empty string until completed.

createdAt
string<date-time>
required

When the purchase was created.

updatedAt
string<date-time>
required

When the purchase was last updated.