Upgrade Membership

POST

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

x-api-versiondateOptional

Used for API versioning. More details.

Request

This endpoint expects an object.
renewWithItemstringRequired

Unique identifier for an item.

Response

This endpoint returns an object.
membershipobject

The MembershipLifecycleDTO is a composite type representing the timeline of a membership. It includes details when the membership was activated, renewed, upgraded, or extended.

cacheInstanceIdstringOptional

Identifier for the NST instance. Providing this value will increase the performance of the API when the NST is load-balanced.