Billing

What cancelling the plan would do

Computed from live state for the confirm dialog: whether the plan ends immediately (a free trial) or at period end, which sites go offline, and how many members lose access.

get/billing/subscription/cancel-preview

Request

  • Base URL: https://api.nippy.host
  • URL: https://api.nippy.host/billing/subscription/cancel-preview
  • Auth: bearer (a scheme the document does not define)

Response

immediateboolean required

True when cancelling ends the plan at once (a free trial). False when it is scheduled for the end of the paid period.

endsAtstring date-time nullable required

When the plan ends if cancelled: the period end for a paid subscription; null when immediate.

trialEndsAtstring date-time nullable required

When the free trial would otherwise have run to — set only when immediate, so the dialog can say "now, not on <date>".

sitesGoingOfflinestring[] required

Hostnames of the live sites that go offline when the plan ends — the newest first, exactly the ones enforcement would suspend. They return if the account subscribes again.

membersLosingAccessnumber required

Members (other than the owner) who lose access when the plan ends. Non-zero only on a Team plan.

Changes

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