Extend Membership

POST

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

x-api-versiondateOptional

Used for API versioning. More details.

Request

This endpoint expects an object.
extendWithItemstringRequired

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.

Built with