MembershipsLifecycle

Renew Membership

Use this endpoint to renew an existing membership. The renewal will add a new period after the current membership period expires. To renew, you must provide the optionId from the getRenewalOptions endpoint, which specifies the predefined renewal configuration such as price and duration.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

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.
optionIdUUIDRequired
Unique identifier for a membership alteration option.
documentNostringOptional
External identifier for the sales document.

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.