UPupfort
Subscriptions

Terminate subscription

Terminates the current subscription for the authenticated partner and permanent_id.

If termination_date is omitted, Upfort uses the request processing date. Future-dated termination behavior is subject to final implementation design.

post/partner/subscriptions/{permanent_id}/terminate

Request

  • Base URL
    https://api.consumer.upfort.com/api
  • Auth
    API key in header X-API-Key

Path parameters

permanent_idstring required

Partner's stable identifier for the subscriber, policy, or membership record.

Request body

termination_datestring date

Termination effective date in YYYY-MM-DD format. Defaults to the processing date when omitted.

reasonstring

Optional freeform termination reason stored for audit.

Response

Subscription terminated.

successtrue required
timestampstring date-time required

Changes

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