MembershipsLifecycle

Cancel Membership

Cancel an active membership using this endpoint. You can provide a cancellation date, allowing the membership to run until that date, or cancel it immediately.

Path parameters

tenantstringRequired

Your Entra Tenant ID. More details.

environmentstringRequired

Your Business Central Environment. More details.

companystringRequired

Your Business Central Company. More details.

membershipIdUUIDRequired
Unique identifier for a membership.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

x-api-versiondateOptional

Used for API versioning. More details.

Request

This endpoint expects an object.
optionIdUUIDRequired
Unique identifier for a membership alteration option.
documentNostringOptional
External identifier for the sales document.
documentDatedateOptional

Specifies the date by which to base the cancel calculation on. This is NOT the date by which the cancel will actually take effect, and therefore you should not provide the periodEnd date from Get Cancel Options. If left empty, the system will assume today.

Response

This endpoint returns an object.
membershipobject
The MembershipLifecycleEntriesDTO is a composite type representing the timeline of a membership. It includes details when the membership was activated, renewed, upgraded, or extended.