@tennac-booking/sdk/docs/SubscriptionsUserApi.md

OpenAPI client for @tennac-booking/sdk

# SubscriptionsUserApi

All URIs are relative to *http://localhost*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**cancel**](#cancel) | **DELETE** /api/subscriptions/{clubId}/{subscriptionId} | |
|[**mySubscriptions**](#mysubscriptions) | **GET** /api/subscriptions/me | |
|[**resume**](#resume) | **POST** /api/subscriptions/{clubId}/{subscriptionId}/resume | |
|[**subscribe**](#subscribe) | **POST** /api/subscriptions/subscribe | |
|[**subscriptionPaymentSheet**](#subscriptionpaymentsheet) | **POST** /api/subscriptions/payment-sheet | |

# **cancel**
> SubscriptionMutationResponse cancel()

Annuler un abonnement à la fin de la période (auth classique)

### Example

```typescript
import {
    SubscriptionsUserApi,
    Configuration
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new SubscriptionsUserApi(configuration);

let clubId: string; // (default to undefined)
let subscriptionId: string; // (default to undefined)

const { status, data } = await apiInstance.cancel(
    clubId,
    subscriptionId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **clubId** | [**string**] |  | defaults to undefined|
| **subscriptionId** | [**string**] |  | defaults to undefined|


### Return type

**SubscriptionMutationResponse**

### Authorization

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

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Abonnement annulé (fin de période) |  -  |
|**400** | Bad Request |  -  |
|**401** | Unauthorized |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **mySubscriptions**
> UserSubscriptionsResponse mySubscriptions()

Liste les abonnements de l\'utilisateur courant, groupés par club (auth classique)

### Example

```typescript
import {
    SubscriptionsUserApi,
    Configuration
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new SubscriptionsUserApi(configuration);

const { status, data } = await apiInstance.mySubscriptions();
```

### Parameters
This endpoint does not have any parameters.


### Return type

**UserSubscriptionsResponse**

### Authorization

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

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Abonnements de l\'utilisateur |  -  |
|**401** | Unauthorized |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **resume**
> SubscriptionMutationResponse resume()

Reprendre un abonnement annulé en fin de période (auth classique)

### Example

```typescript
import {
    SubscriptionsUserApi,
    Configuration
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new SubscriptionsUserApi(configuration);

let clubId: string; // (default to undefined)
let subscriptionId: string; // (default to undefined)

const { status, data } = await apiInstance.resume(
    clubId,
    subscriptionId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **clubId** | [**string**] |  | defaults to undefined|
| **subscriptionId** | [**string**] |  | defaults to undefined|


### Return type

**SubscriptionMutationResponse**

### Authorization

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

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Abonnement repris |  -  |
|**400** | Bad Request |  -  |
|**401** | Unauthorized |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **subscribe**
> SubscriptionMutationResponse subscribe(subscribeRequestBody)

S\'abonner à un plan (auth classique)

### Example

```typescript
import {
    SubscriptionsUserApi,
    Configuration,
    SubscribeRequestBody
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new SubscriptionsUserApi(configuration);

let subscribeRequestBody: SubscribeRequestBody; //

const { status, data } = await apiInstance.subscribe(
    subscribeRequestBody
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **subscribeRequestBody** | **SubscribeRequestBody**|  | |


### Return type

**SubscriptionMutationResponse**

### Authorization

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

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**201** | Abonnement créé |  -  |
|**400** | Bad Request |  -  |
|**401** | Unauthorized |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **subscriptionPaymentSheet**
> SubscriptionPaymentSheetResponse subscriptionPaymentSheet(subscriptionPaymentSheetRequest)

Prépare un PaymentSheet Stripe pour souscrire à un plan (paiement obligatoire)

### Example

```typescript
import {
    SubscriptionsUserApi,
    Configuration,
    SubscriptionPaymentSheetRequest
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new SubscriptionsUserApi(configuration);

let subscriptionPaymentSheetRequest: SubscriptionPaymentSheetRequest; //

const { status, data } = await apiInstance.subscriptionPaymentSheet(
    subscriptionPaymentSheetRequest
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **subscriptionPaymentSheetRequest** | **SubscriptionPaymentSheetRequest**|  | |


### Return type

**SubscriptionPaymentSheetResponse**

### Authorization

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

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Payment sheet ready |  -  |
|**400** | Bad Request |  -  |
|**401** | Unauthorized |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)