MembershipsLifecycle

Extend Membership

Use this endpoint to extend the duration of an active membership. The extension will terminate the current period and create a new period starting from today, based on the provided extension configuration. The overall membership duration will be greater than the original duration. You must provide the itemNumber from the getExtendOptions endpoint to apply the extension.

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 extend calculation on. This is NOT the date by which the extend will actually take effect, and therefore you should not provide the periodEnd date from Get Upgrade 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.