Skip to main content
POST
Cancel a creator's checkout-link subscription at the period end
Required scope
  • write:creator — Modify creator profiles, settings, and creator-specific data.

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
uuid
string<uuid>
required

Fanvue subscription identifier.

Response

Subscription set to cancel at the period end

uuid
string
required

Fanvue's unique subscription identifier.

status
enum<string>
required

Access state of the subscription, matching the checkout_link.subscription.* webhooks: active means the fan currently has access (including subscriptions scheduled to cancel at the period end — check cancelAtPeriodEnd), expired means access has ended. Revoke access only on expired.

Available options:
active,
expired
cancelAtPeriodEnd
boolean
required

True when the subscription is set to end (not renew) at its period end.

expiresAt
string<date-time>
required

End of the current paid period: when access ends, or the next renewal date.