Cancel at period end | Pivolio Docs

Schedules cancellation at the end of the paid period, and records why.

Conversions keep being delivered until then. When Stripe ends the subscription the workspace becomes unsubscribed: we keep tracking, storing and reporting its events, but stop sending conversions to its destinations. The reason is stored on Stripe’s subscription as cancellation_details.

Authentication

X-Workspace-Idstring

API Key authentication via header

Request

This endpoint expects an object.

reasonenumRequired

Why a customer cancelled.

Mirrors Stripe’s canonical set so the data stays comparable if we ever enable cancellation_reason on the Customer Portal configuration.

commentstring or nullOptional<=1000 characters

Response

Successful Response

Errors

422

Unprocessable Entity Error

$	curl -X POST /billing/cancel \
>	-H "X-Workspace-Id: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"reason": "too_expensive"
>	}'