FAfanvue

Cancel a creator's checkout-link subscription at the period end

Changed on

Stop the specified subscription from renewing. The fan keeps access until expiresAt — the response's status stays active with cancelAtPeriodEnd: true — and the subscription then ends without a further charge. Emits the checkout_link.subscription.cancel_at_period_end_changed webhook. Returns 400 if the subscription is already set to cancel, and 404 if it does not exist, has ended, or does not belong to this creator.

Cancelling a subscription in payment retry — a failed renewal Fanvue is still reattempting — stops further charge attempts immediately. The response then reflects the already-ended access (status: expired), and no webhook is emitted: the checkout_link.subscription.deactivated event already fired when the failed renewal ended the subscription.

post/creators/{creatorUserUuid}/checkout-links/subscriptions/{uuid}/cancel

Request

  • Base URL
    https://api.fanvue.com
  • URL
    https://api.fanvue.com/creators/{creatorUserUuid}/checkout-links/subscriptions/{uuid}/cancel
  • Auth
    OAuth 2
    Authorization code: https://auth.fanvue.com/oauth2/auth
    Token URL: https://auth.fanvue.com/oauth2/token scopes: write:creator

Path parameters

creatorUserUuidstring uuid required
uuidstring uuid required

Fanvue subscription identifier.

Headers

X-Fanvue-API-Versionstring required
Example:2025-06-26

API version to use for the request

Response

Subscription set to cancel at the period end

uuidstring required

Fanvue's unique subscription identifier.

status'active' | 'expired' 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.

cancelAtPeriodEndboolean required

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

expiresAtstring date-time required

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

Changes