MembershipsLifecycle

Upgrade Membership

Use this endpoint to upgrade an active membership to a higher (or lower) plan or tier. The upgrade will terminate the current membership period and apply the new membership tier immediately. However, the overall membership duration remains unchanged. You must provide the itemNumber from the getUpgradeOptions endpoint, which includes the predefined details for the upgrade.

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 upgrade calculation on. This is NOT the date by which the upgrade 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.