Get Upgrade Options

GET

Retrieve a list of available upgrade options for a membership. Each upgrade option is represented by an itemNumber, which includes predefined details such as the upgraded benefits and any pricing adjustments. The itemNumber returned from this endpoint can be used as a parameter in the upgradeMembership endpoint to execute 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.

Response

This endpoint returns an object.
renewalOptionslist of objects
cacheInstanceIdstringOptional

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