MembershipsSubscription

Terminate Subscription

Use this endpoint to terminate the subscription for the memebrship.

Authentication

x-np-api-keystring
API Key authentication via header

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.
terminationDatedateOptional
The date to terminate the subscription by. If not included, the system will calculate the earliest valid termination date based on the configured notice period, commitment end, and billing cycle.

Response

This endpoint returns an object.
idUUID
Unique identifier for a subscription.
blockedboolean
Defines if the subscription is blocked and therefore not useable for renewing the membership.
autoRenewenum

Indicates the auto-renewal state

startedAtdatetimeOptional
Defines the date the subscription was started.
committedUntildateOptional
Defines the date that the subscription is committed until. It's not possible to terminate the subscription before this date.
terminateAtdateOptional
Defines the date the membership will be terminated if it has been requested to terminate.
terminationRequestedAtdatetimeOptional
Defines the date and time termination was requested.
terminationReasonenumOptional
Defines the reason for a termination.