> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# GetMembershipVoidability

# Package: memberships

# Namespace: MembershipsSPI

# Method link: https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/payments/memberships/memberships-service-plugin/get-membership-voidability.md

## Introduction

This method retrieves from your app whether a membership can be voided.

---

## REST API

### Schema

```
 Method: getMembershipVoidability
 Description: This method retrieves from your app whether a membership can be voided.
 URL: null
 Method: POST
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  transactionId
 Method parameters: 
   param name: transactionId | type: transactionId | description: Transaction GUID to check if it can be voided. | required: true
 Return type: GetMembershipVoidabilityResponse
  - name: voidable | type: boolean | description: Whether the membership charge can be voided. 
  - name: reason | type: string | description: Reason why the membership charge cannot be voided. 

 Possible Errors:
   HTTP Code: 404 | Status Code: NOT_FOUND | Application Code: TRANSACTION_NOT_FOUND | Description: Transaction not found


```

### Examples

### Get Membership Voidability
Check if membership can be voided

```curl
curl -X POST \
  'https://provider.example.com/v1/get-voidability' \
  -H 'user-agent: Wix' \
  -H 'accept-encoding: gzip, deflate' \
  -H 'content-type: text/plain; charset=utf-8' \
  --data-binary '{
    "transactionId": "a178aeb7-6687-4402-862f-411a8f899205"
	}'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.memberships.MembershipsSPI.getMembershipVoidability(request, metadata)
 Description: This method retrieves from your app whether a membership can be voided.
 Method parameters:
   param name: metadata | type: Context | description: this message is not directly used by any service, it exists to describe the expected parameters that SHOULD be provided to invoked Velo methods as part of open-platform. e.g. SPIs, event-handlers, etc.. NOTE: this context object MUST be provided as the last argument in each Velo method signature.  Example: ```typescript export function wixStores_onOrderCanceled({ event, metadata }: OrderCanceledEvent) { ... } ``` 
        - name: requestId | type: string | description: A unique identifier of the request. You may print this GUID to your logs to help with future debugging and easier correlation with Wix's logs. 
        - name: currency | type: string | description: [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letter currency code. 
        - name: identity | type: IdentificationData | description: An object that describes the identity that triggered this request. 
           - ONE-OF: 
              - name: anonymousVisitorId | type: string | description: GUID of a site visitor that has not logged in to the site. 
              - name: memberId | type: string | description: GUID of a site visitor that has logged in to the site. 
              - name: wixUserId | type: string | description: GUID of a Wix user (site owner, contributor, etc.). 
              - name: appId | type: string | description: GUID of an app. 
        - name: languages | type: array | description: A string representing a language and region in the format of `"xx-XX"`. First 2 letters represent the language code according to ISO 639-1. This is followed by a dash "-", and then a by 2 capital letters representing the region according to ISO 3166-2. For example, `"en-US"`. 
        - name: instanceId | type: string | description: The service provider app's instance GUID. 
   param name: request | type: GetMembershipVoidabilityRequest   
        - name: transactionId | type: string | description: Transaction GUID to check if it can be voided. 
 Return type: PROMISE<GetMembershipVoidabilityResponse>
  - name: voidable | type: boolean | description: Whether the membership charge can be voided. 
  - name: reason | type: string | description: Reason why the membership charge cannot be voided. 

 Possible Errors:
   HTTP Code: 404 | Status Code: NOT_FOUND | Application Code: TRANSACTION_NOT_FOUND | Description: Transaction not found


```

### Examples

### getMembershipVoidability
```javascript
import { memberships } from '@wix/ecom/service-plugins';

async function getMembershipVoidability(request,metadata) {
  const response = await memberships.getMembershipVoidability(request,metadata);
};
```

### getMembershipVoidability (with elevated permissions)
```javascript
import { memberships } from '@wix/ecom/service-plugins';
import { auth } from '@wix/essentials';

async function myGetMembershipVoidabilityMethod(request,metadata) {
  const elevatedGetMembershipVoidability = auth.elevate(memberships.getMembershipVoidability);
  const response = await elevatedGetMembershipVoidability(request,metadata);
}
```

### getMembershipVoidability (self-hosted)
Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md).

```javascript
import { createClient } from '@wix/sdk';
import { memberships } from '@wix/ecom/service-plugins';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { memberships },
  // Include the auth strategy and host as relevant
});


async function getMembershipVoidability(request,metadata) {
  const response = await myWixClient.memberships.getMembershipVoidability(request,metadata);
};
```

---