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.
Path parameters
tenant
Your Entra Tenant ID. More details.
environment
Your Business Central Environment. More details.
company
Your Business Central Company. More details.
membershipId
Unique identifier for a membership.
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
x-api-version
Used for API versioning. More details.
Request
This endpoint expects an object.
optionId
Unique identifier for a membership alteration option.
documentNo
External identifier for the sales document.
Response
This endpoint returns an object.
membership
The MembershipLifecycleEntriesDTO is a composite type representing the timeline of a membership. It includes details when the membership was activated, renewed, upgraded, or extended.