Get Membership History | NaviPartner | NP Retail API Documentation

1 import requests 2 3 url = "https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%2520International%2520Ltd./membership/cdef7890-abcd-0123-1234-567890abcdef/history" 4 5 headers = {"x-np-api-key": "<NaviPartner API Key>"} 6 7 response = requests.get(url, headers=headers) 8 9 print(response.json())

1 { 2 "membership": { 3 "autoRenewalActivated": false, 4 "blocked": false, 5 "communityCode": "RIVERLAND", 6 "entries": [ 7 { 8 "entryId": "22349999-bbbb-cccc-dddd-2234567890bc", 9 "itemNumber": "M12345", 10 "lifecycleAction": "new", 11 "blocked": false, 12 "membershipCode": "GOLD", 13 "description": "A description of the time entry", 14 "createdAt": "2024-09-17T00:00:00", 15 "activateOnFirstUse": false, 16 "documentNumber": "DOC123456", 17 "documentId": "EA3AD944335C49DB962E4C854937990A", 18 "unitPrice": 100, 19 "amount": 80, 20 "amountInclVat": 100, 21 "validFromDate": "2024-09-17", 22 "validUntilDate": "2025-09-16" 23 } 24 ], 25 "issueDate": "2024-09-17", 26 "membershipCode": "GOLD", 27 "membershipId": "cdef7890-abcd-0123-1234-567890abcdef", 28 "membershipNumber": "MS-DEMO-00152", 29 "customerNumber": "D000188", 30 "validFromDate": "2024-09-17", 31 "validUntilDate": "2025-09-16" 32 } 33 }

Use this endpoint to retrieve the lifecycle history of a membership. It provides a chronological log of events, including creation, renewals, upgrades, and cancellations.

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.

Response

This endpoint returns an object.

membershipobject

The MembershipLifecycleEntriesDTO is a composite type representing the timeline of a membership. It includes details when the membership was activated, renewed, upgraded, or extended.