Subscription

Cancel the subscription

Cancel the authenticated user posterly subscription. A reason from the fixed catalog is required, matching the dashboard flow. By default an active or trialing plan cancels at the end of the current period. A past due or unpaid plan always ends now, and the unpaid renewal is dropped. Pass immediate: true to end an active plan now. Requires the billing:write scope. Bypasses the API add-on paywall.

post/api/v1/subscription/cancel

Request

  • Base URL: https://www.poster.ly
  • URL: https://www.poster.ly/api/v1/subscription/cancel
  • Auth: HTTP bearer

Request body

reason'too_expensive' | 'not_using' | 'missing_features' | 'technical_issues' | 'switching_service' | 'temporary_break' | 'other' required

Why the user is cancelling. Required; ask the user before calling.

feedbackstring

Optional free-text detail from the user.

immediateboolean

Cancel immediately instead of at period end.

Example request

{
  "reason": "too_expensive",
  "feedback": "Found a cheaper option",
  "immediate": false
}

Response

Subscription cancellation applied.

successtrue required
immediateboolean required
canceled_atstring date-time nullable
cancel_at_period_endboolean required

Example response

{
  "success": true,
  "immediate": false,
  "canceled_at": null,
  "cancel_at_period_end": true
}

Changes

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