Get Membership History

GET

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

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 MembershipLifecycleDTO is a composite type representing the timeline of a membership. It includes details when the membership was activated, renewed, upgraded, or extended.

cacheInstanceIdstringOptional

Identifier for the NST instance. Providing this value will increase the performance of the API when the NST is load-balanced.

GET

1 curl https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%20International%20Ltd./membership/membership/cdef7890-abcd-0123-1234-567890abcdef/history

200ExampleGetMembershipHistory

1 {
2   "membership": {
3     "blocked": false,
4     "communityCode": "RIVERLAND",
5     "entries": [
6       {
7         "timeEntryId": 1223,
8         "validFromDate": "2024-09-17",
9         "validUntilDate": "2025-09-16",
10         "activateOnFirstUse": false,
11         "lifecycleAction": "new",
12         "itemNumber": "M12345",
13         "amount": 80,
14         "amountInclVat": 100,
15         "receiptNumber": "R123456789",
16         "receiptLine": 10,
17         "membershipCode": "GOLD"
18       }
19     ],
20     "issueDate": "2024-09-17",
21     "membershipCode": "GOLD",
22     "membershipId": "cdef7890-abcd-0123-1234-567890abcdef",
23     "membershipNumber": "MS-DEMO-00152",
24     "customerNumber": "D000188",
25     "validFromDate": "2024-09-17",
26     "validUntilDate": "2025-09-16"
27   }
28 }

Built with

1	{
2	"membership": {
3	"blocked": false,
4	"communityCode": "RIVERLAND",
5	"entries": [
6	{
7	"timeEntryId": 1223,
8	"validFromDate": "2024-09-17",
9	"validUntilDate": "2025-09-16",
10	"activateOnFirstUse": false,
11	"lifecycleAction": "new",
12	"itemNumber": "M12345",
13	"amount": 80,
14	"amountInclVat": 100,
15	"receiptNumber": "R123456789",
16	"receiptLine": 10,
17	"membershipCode": "GOLD"
18	}
19	],
20	"issueDate": "2024-09-17",
21	"membershipCode": "GOLD",
22	"membershipId": "cdef7890-abcd-0123-1234-567890abcdef",
23	"membershipNumber": "MS-DEMO-00152",
24	"customerNumber": "D000188",
25	"validFromDate": "2024-09-17",
26	"validUntilDate": "2025-09-16"
27	}
28	}