Cancel Membership — NaviPartner | NP Retail API Documentation

Cancel an active membership using this endpoint. You can provide a cancellation date, allowing the membership to run until that date, or cancel it immediately.

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.

Request

This endpoint expects an object.

cancelDatedateRequired

The lifecycle dates for the membership.

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.

1 curl -X POST https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%20International%20Ltd./membership/membership/cdef7890-abcd-0123-1234-567890abcdef/cancel \ 2 -H "Content-Type: application/json" \ 3 -d '{ 4 "cancelDate": "2024-10-07" 5 }'

1 { 2 "membership": { 3 "blocked": false, 4 "communityCode": "RIVERLAND", 5 "entries": [ 6 { 7 "timeEntryId": 2332, 8 "validFromDate": "2024-09-17", 9 "validUntilDate": "2024-10-07", 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": "2024-10-07" 27 } 28 }

1	curl -X POST https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%20International%20Ltd./membership/membership/cdef7890-abcd-0123-1234-567890abcdef/cancel \
2	-H "Content-Type: application/json" \
3	-d '{
4	"cancelDate": "2024-10-07"
5	}'

1	{
2	"membership": {
3	"blocked": false,
4	"communityCode": "RIVERLAND",
5	"entries": [
6	{
7	"timeEntryId": 2332,
8	"validFromDate": "2024-09-17",
9	"validUntilDate": "2024-10-07",
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": "2024-10-07"
27	}
28	}