Billing

Schedule or undo cancellation of the current paid subscription

Setting cancelAtPeriodEnd to true schedules cancellation at the current billing period end; false keeps the subscription. Entitlements update after a verified Stripe subscription event. This endpoint never cancels immediately or issues a refund.

post/billing/subscription-cancellation

Request

  • Base URL: https://api.flashdata.dev/v2
  • URL: https://api.flashdata.dev/v2/billing/subscription-cancellation
  • Auth: API key in cookie __Host-fd_session and API key in header X-CSRF-Token

Headers

Idempotency-Keystring required

Request body

cancelAtPeriodEndboolean required

Response

Cancellation update submitted to Stripe

idstring required
cancelAtPeriodEndboolean required
status'submitted' required

Changes

No recorded changes to this operation across all 1 revision of this API.