Get Cancel Options

GET

Retrieve a list of available cancel options for a membership. Each option is represented by an itemNumber, which includes predefined configurations such as price, duration, and other relevant details. The optionId returned from this endpoint can be used as a parameter in the cancelMembership endpoint to proceed with the cancel.

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

x-api-versiondateOptional

Used for API versioning. More details.

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.

Built with