MembershipsSubscription

Get Subscription

Use this endpoint to get the subscription information about a membership.

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

AuthorizationstringRequired

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

x-api-versiondateOptional

Used for API versioning. More details.

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

Allowed values:
startedAtdatetime or null
Defines the date the subscription was started.
committedUntildate or null
Defines the date that the subscription is committed until. It's not possible to terminate the subscription before this date.
terminateAtdate or null
Defines the date the membership will be terminated if it has been requested to terminate.
terminationRequestedAtdatetime or null
Defines the date and time termination was requested.
terminationReasonenum or null
Defines the reason for a termination.
Allowed values: