NAnavipartner
memberships > Subscriptions

Get Subscription

Changed on

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

get/{tenant}/{environment}/{company}/membership/{membershipId}/subscription/

Request

  • Base URL
    https://api.npretail.app
  • Auth
    API key in header x-np-api-key

Path parameters

tenantstring required

Your Entra Tenant ID. More details.

environmentstring required

Your Business Central Environment. More details.

companystring required

Your Business Central Company. More details.

membershipIdstring uuid required

Unique identifier for a membership.

Headers

x-api-versionstring date

Used for API versioning. More details.

Response

Response with status 200

idstring uuid required

Unique identifier for a subscription.

blockedboolean required

Defines if the subscription is blocked and therefore not useable for renewing the membership.

startedAtstring date-time

Defines the date the subscription was started.

committedUntilstring date

Defines the date that the subscription is committed until. It's not possible to terminate the subscription before this date.

terminateAtstring date

Defines the date the membership will be terminated if it has been requested to terminate.

terminationRequestedAtstring date-time

Defines the date and time termination was requested.

terminationReason'CUSTOMER_INITIATED' | 'FORCED_TERMINATION'
usableUntilDatestring date

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.

renewalRequiredBeforeTerminationboolean

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.

nextRenewalAttemptDatestring date

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.

autoRenew'NO' | 'YES_INTERNAL' | 'YES_EXTERNAL' | 'TERMINATION_REQUESTED' required

Indicates the auto-renewal state

Changes

  • 48cacf22ffcdRevision changes
    • breaking

      the response's body type changed from no type to object for status

    • warning

      deleted the header request parameter x-np-api-key

    • info

      the endpoint scheme security NPApiKeyAuthScheme was added to the API

    • info

      for the path request parameter membershipId, the type was generalized from no type to string, and format from no format to uuid

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 407697660280Revision changes
    • info

      api operation id get-subscription removed and replaced with memberships_serviceSubscription_getSubscription