# Customers

**Category:** Store
**Base URL:** `/store/customers`
**Authentication:** Mixed
**Routes:** 10 routes documented

## Overview

This section documents 10 API routes for customers.

## Quick Reference

| Method | Endpoint | Description |
|--------|----------|-------------|
| GET | `/store/customers/me/subscriptions` | No description |
| GET | `/store/customers/me/subscriptions/:id` | No description |
| POST | `/store/customers/me/subscriptions/:id/cancellation` | No description |
| POST | `/store/customers/me/subscriptions/:id/change-address` | No description |
| POST | `/store/customers/me/subscriptions/:id/change-frequency` | No description |
| POST | `/store/customers/me/subscriptions/:id/pause` | No description |
| POST | `/store/customers/me/subscriptions/:id/resume` | No description |
| POST | `/store/customers/me/subscriptions/:id/retry-payment` | No description |
| POST | `/store/customers/me/subscriptions/:id/skip-next-delivery` | No description |
| POST | `/store/customers/me/subscriptions/:id/swap-product` | No description |

---

## GET Store Customers Me Subscriptions

**Endpoint:** `GET /store/customers/me/subscriptions`
**Authentication:** Customer (Optional)

### Response

The handler does not return an object literal, so the response shape is not derivable from the source.

### Example Request

```bash
curl -X GET 'https://your-store.omnicart.cc/store/customers/me/subscriptions' \
  -H 'Content-Type: application/json'
```

---

## GET Store Customers Me Subscriptions :id

**Endpoint:** `GET /store/customers/me/subscriptions/:id`
**Authentication:** Customer (Optional)

### URL Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id identifier |

### Response

The handler does not return an object literal, so the response shape is not derivable from the source.

### Example Request

```bash
curl -X GET 'https://your-store.omnicart.cc/store/customers/me/subscriptions/:id' \
  -H 'Content-Type: application/json'
```

---

## POST Store Customers Me Subscriptions :id Cancellation

**Endpoint:** `POST /store/customers/me/subscriptions/:id/cancellation`
**Authentication:** Customer (Optional)

### URL Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id identifier |

### Request Body

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

### Response

The handler does not return an object literal, so the response shape is not derivable from the source.

### Example Request

```bash
curl -X POST 'https://your-store.omnicart.cc/store/customers/me/subscriptions/:id/cancellation' \
  -H 'Content-Type: application/json'
```

---

## POST Store Customers Me Subscriptions :id Change-address

**Endpoint:** `POST /store/customers/me/subscriptions/:id/change-address`
**Authentication:** Customer (Optional)

### URL Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id identifier |

### Request Body

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

### Response

The handler does not return an object literal, so the response shape is not derivable from the source.

### Example Request

```bash
curl -X POST 'https://your-store.omnicart.cc/store/customers/me/subscriptions/:id/change-address' \
  -H 'Content-Type: application/json'
```

---

## POST Store Customers Me Subscriptions :id Change-frequency

**Endpoint:** `POST /store/customers/me/subscriptions/:id/change-frequency`
**Authentication:** Customer (Optional)

### URL Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id identifier |

### Request Body

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

### Response

The handler does not return an object literal, so the response shape is not derivable from the source.

### Example Request

```bash
curl -X POST 'https://your-store.omnicart.cc/store/customers/me/subscriptions/:id/change-frequency' \
  -H 'Content-Type: application/json'
```

---

## POST Store Customers Me Subscriptions :id Pause

**Endpoint:** `POST /store/customers/me/subscriptions/:id/pause`
**Authentication:** Customer (Optional)

### URL Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id identifier |

### Request Body

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

### Response

The handler does not return an object literal, so the response shape is not derivable from the source.

### Example Request

```bash
curl -X POST 'https://your-store.omnicart.cc/store/customers/me/subscriptions/:id/pause' \
  -H 'Content-Type: application/json'
```

---

## POST Store Customers Me Subscriptions :id Resume

**Endpoint:** `POST /store/customers/me/subscriptions/:id/resume`
**Authentication:** Customer (Optional)

### URL Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id identifier |

### Request Body

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

### Response

The handler does not return an object literal, so the response shape is not derivable from the source.

### Example Request

```bash
curl -X POST 'https://your-store.omnicart.cc/store/customers/me/subscriptions/:id/resume' \
  -H 'Content-Type: application/json'
```

---

## POST Store Customers Me Subscriptions :id Retry-payment

**Endpoint:** `POST /store/customers/me/subscriptions/:id/retry-payment`
**Authentication:** Customer (Optional)

### URL Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id identifier |

### Request Body

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

### Response

**Success:**
```typescript
{
  type,
  message,
}
```

### Example Request

```bash
curl -X POST 'https://your-store.omnicart.cc/store/customers/me/subscriptions/:id/retry-payment' \
  -H 'Content-Type: application/json'
```

---

## POST Store Customers Me Subscriptions :id Skip-next-delivery

**Endpoint:** `POST /store/customers/me/subscriptions/:id/skip-next-delivery`
**Authentication:** Customer (Optional)

### URL Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id identifier |

### Request Body

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

### Response

The handler does not return an object literal, so the response shape is not derivable from the source.

### Example Request

```bash
curl -X POST 'https://your-store.omnicart.cc/store/customers/me/subscriptions/:id/skip-next-delivery' \
  -H 'Content-Type: application/json'
```

---

## POST Store Customers Me Subscriptions :id Swap-product

**Endpoint:** `POST /store/customers/me/subscriptions/:id/swap-product`
**Authentication:** Customer (Optional)

### URL Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id identifier |

### Request Body

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

### Response

The handler does not return an object literal, so the response shape is not derivable from the source.

### Example Request

```bash
curl -X POST 'https://your-store.omnicart.cc/store/customers/me/subscriptions/:id/swap-product' \
  -H 'Content-Type: application/json'
```

---