# ps.module.SubscriptionApi

All URIs are relative to */*

Method | HTTP request | Description
------------- | ------------- | -------------
[**apiVersionSubscriptionIdDelete**](SubscriptionApi.md#apiVersionSubscriptionIdDelete) | **DELETE** /api/{version}/subscription/{id} | Cancel existing subscription.
[**apiVersionSubscriptionIdGet**](SubscriptionApi.md#apiVersionSubscriptionIdGet) | **GET** /api/{version}/subscription/{id} | Retrieves the details of an existing subscription.
[**apiVersionSubscriptionPost**](SubscriptionApi.md#apiVersionSubscriptionPost) | **POST** /api/{version}/subscription | Create Subscription
[**apiVersionSubscriptionPut**](SubscriptionApi.md#apiVersionSubscriptionPut) | **PUT** /api/{version}/subscription | Updates the specific subscription.

<a name="apiVersionSubscriptionIdDelete"></a>
# **apiVersionSubscriptionIdDelete**
> apiVersionSubscriptionIdDelete(id, version)

Cancel existing subscription.

### Example
```javascript
import ps.module from 'phonespeakv2_api';
let defaultClient = ps.module.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new ps.module.SubscriptionApi();
let id = "id_example"; // String | 
let version = "version_example"; // String | 

apiInstance.apiVersionSubscriptionIdDelete(id, version, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 
 **version** | **String**|  | 

### Return type

null (empty response body)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="apiVersionSubscriptionIdGet"></a>
# **apiVersionSubscriptionIdGet**
> apiVersionSubscriptionIdGet(id, version)

Retrieves the details of an existing subscription.

### Example
```javascript
import ps.module from 'phonespeakv2_api';
let defaultClient = ps.module.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new ps.module.SubscriptionApi();
let id = "id_example"; // String | 
let version = "version_example"; // String | 

apiInstance.apiVersionSubscriptionIdGet(id, version, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 
 **version** | **String**|  | 

### Return type

null (empty response body)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="apiVersionSubscriptionPost"></a>
# **apiVersionSubscriptionPost**
> apiVersionSubscriptionPost(version)

Create Subscription

### Example
```javascript
import ps.module from 'phonespeakv2_api';
let defaultClient = ps.module.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new ps.module.SubscriptionApi();
let version = "version_example"; // String | 

apiInstance.apiVersionSubscriptionPost(version, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **version** | **String**|  | 
 **body** | [**PhoneSpeakServiceCoreSubscriptionsCreateSubscriptionQuery**](PhoneSpeakServiceCoreSubscriptionsCreateSubscriptionQuery.md)|  | [optional] 

### Return type

null (empty response body)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

 - **Content-Type**: audio/x-wav, text/plain, application/octet-stream, application/json-patch+json, application/json, text/json, application/_*+json, application/xml, text/xml, application/_*+xml
 - **Accept**: Not defined

<a name="apiVersionSubscriptionPut"></a>
# **apiVersionSubscriptionPut**
> apiVersionSubscriptionPut(version)

Updates the specific subscription.

### Example
```javascript
import ps.module from 'phonespeakv2_api';
let defaultClient = ps.module.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new ps.module.SubscriptionApi();
let version = "version_example"; // String | 

apiInstance.apiVersionSubscriptionPut(version, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **version** | **String**|  | 
 **body** | [**PhoneSpeakServiceCoreSubscriptionsUpdateSubcriptionQuery**](PhoneSpeakServiceCoreSubscriptionsUpdateSubcriptionQuery.md)|  | [optional] 

### Return type

null (empty response body)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

 - **Content-Type**: audio/x-wav, text/plain, application/octet-stream, application/json-patch+json, application/json, text/json, application/_*+json
 - **Accept**: Not defined