Skip to main content
GET
Get a creator's checkout-link payment by invoice number
Required scope
  • read:creator — Access creator profiles, content, and creator-specific information.

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

creatorUserUuid
string<uuid>
required
invoiceNumber
string
required

Fanvue payment identifier (invoice number).

Response

The checkout-link payment

invoiceNumber
string
required

Fanvue's unique payment identifier. Use this as the idempotency key for fulfilment.

status
enum<string>
required

Settlement status of the payment.

Available options:
pending,
succeeded,
failed
billingReason
enum<string>
required

What the payment was for: a one-off purchase, the first payment of a subscription, or a subscription renewal. Matches the billing_reason on the checkout_link.payment.* webhook.

Available options:
one_time,
subscription_initial,
subscription_renewal
clientReferenceId
string | null
required

The merchant-supplied reference passed at checkout via ?client_reference_id=. Use it to match the payment to your own order/customer.

gross
number
required

Gross amount the buyer paid, in minor units.

net
number | null
required

Creator net amount after fees, in minor units.

fees
object
required
currency
string | null
required

ISO currency code of the amounts.

transactionId
string | null
required

Payment processor transaction reference.

createdAt
string<date-time>
required

When the payment was created.

paidAt
string<date-time> | null
required

When the payment settled, if it did.

purchaser
object
required
metadata
object
required

Arbitrary merchant metadata passed at checkout via ?metadata[key]=value.