MembershipsSubscription

Start Subscription

Use this endpoint to enable subscription for the membership. This requires that a payment method is active and selected for the membership. If the subscription has an unprocessed refund (partial regret), the request is rejected unless confirmPendingRefund is set to true.

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.

Query parameters

confirmPendingRefundbooleanOptional

When true, allows starting the subscription even if it has an unprocessed refund (partial regret) that might be processed at a later point and affect the membership. Defaults to false, in which case the request is rejected when an unprocessed refund exists.

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.
usableUntilDatedateOptional

The last date the membership remains usable if auto-renewal is cancelled now, inclusive. Terminating only switches auto-renewal off and does not shorten the period already paid for, so this is the end of that period, or of the last period a notice period forces a renewal into. It is not the date the termination itself takes effect: that is reported separately as terminateAt. Null when it cannot be determined, for example when auto-renewal is off or is managed externally. Informational only: do not send this value back as a terminationDate when terminating - omit that field and the server applies its own earliest acceptable date.

renewalRequiredBeforeTerminationbooleanOptional
True when the notice period runs past the end of the paid period, so the membership renews, and is charged, once more before it can be terminated. Null whenever usableUntilDate is null, since there is then no termination to describe.
nextRenewalAttemptDatedateOptional

The next date an automatic renewal payment will be attempted. Null when no further attempt is planned, for example when auto-renewal is off or every scheduled attempt is already in the past.