---
title: Subscribers
description: The persons that use a subscription.

---

# Subscribers

The persons that use a subscription.


## [GET /subscribers/{subscriberId}](/end-user-api/subscribers#tag/subscribers/GET/subscribers/{subscriberId})

Get subscriber

Retrieve detailed information about a specific subscriber using its unique identifier.

Authentication: X-Api-Key + Bearer JWT

### Path parameters

- `subscriberId` (`string`, required) — The unique identifier of the subscriber.

### Responses

#### 200

A subscriber object.

Type: [Subscriber](/end-user-api/models.md#models/Subscriber)

#### 400

The request was malformed or invalid.

Type: [Error](/end-user-api/models.md#models/Error)

#### 401

Authentication is required to access this resource.

Type: [Error](/end-user-api/models.md#models/Error)

#### 404

The requested resource was not found.

Type: [Error](/end-user-api/models.md#models/Error)

#### 500

An unexpected error occurred on the server.

Type: [Error](/end-user-api/models.md#models/Error)

### Example request

```bash
curl https://apiv2.example.com/api/v2/end-user/subscribers/SUBSCRIBER_ID \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
```

## [PUT /subscribers/{subscriberId}](/end-user-api/subscribers#tag/subscribers/PUT/subscribers/{subscriberId})

Update subscriber

Update the details of an existing subscriber.

Authentication: X-Api-Key + Bearer JWT

### Path parameters

- `subscriberId` (`string`, required) — The unique identifier of the subscriber.

### Header parameters

- `X-Idempotency-Key` (`string`, optional, max length 256) — A unique key to ensure idempotency of requests. If a request with the same key has already been processed, the same result will be returned. The key must be unique for each distinct operation. Keys are expired after 24 hours, but we recommend using a new key for each request. Modified requests with the same idempotency keys are rejected with a `409 Conflict` status code.

### Request body (required)

Type: `object`

- `address` (`object`, optional, deprecated) — Deprecated. Use `changeSubscriptionServiceAddress` instead. The service address of the mobile subscription of the subscriber. The request fails when the subscriber does not have exactly one mobile subscription. — A postal address. Used wherever the API needs a physical location, such as billing addresses, shipping destinations, and coverage checks.
  - `attention` (`string`, optional, personal data, example John Doe) — An optional line for specifying a person, department, or attention to a specific entity within an address.
  - `city` (`string`, required, example Natick) — The city or municipality of the address.
  - `country` (`string`, required, pattern ^[A-Z]{2}$, example US) — The two-letter country abbreviation (e.g., 'US' for United States, 'SE' for Sweden).
  - `region` (`string`, optional, example Ontario) — A province, region, or territory name, applicable in certain countries (e.g., 'Ontario' in Canada, 'Sindh' in Pakistan).
  - `state` (`string`, optional, example CA) — For countries that use states or regions, the state or administrative area code (e.g., 'CA' for California in the United States).
  - `street` (`string`, optional, personal data, example 500 S Main St) — The first line of the address, typically street and house number.
  - `street1` (`string`, required, personal data, deprecated) — Deprecated. Use `street` instead. The first line of the address, typically street and house number.
  - `street2` (`string`, optional, personal data, example Apt 1) — The second line of the address, typically apartment, suite, unit, building, floor, etc.
  - `zip` (`string`, required, personal data, example 01701) — The zip code of the address. Depending on the country, this may be referred to as a postal code or postcode. A US ZIP code must hold five digits. The four-digit extension (ZIP+4) is refused.
- `contactNumber` (`string`, optional, phone, personal data, example +15551234567) — A phone number for reaching the subscriber, separate from the number their subscription provides.
- `email` (`string`, optional, email, personal data, example john.doe@example.com) — The email address of the subscriber.
- `metadata` (`object with string keys`, optional) — A set of key-value pairs that can be attached to an object for storing additional information in a semi-structured format. Provided by API clients and returned as-is; the platform does not interpret the values.
  - `*` (`string`, optional)
- `name` (`string`, optional, example John Doe) — The full name of the subscriber.

### Responses

#### 200

Subscriber updated successfully.

Type: [Subscriber](/end-user-api/models.md#models/Subscriber)

#### 400

The request was malformed or invalid.

Type: [Error](/end-user-api/models.md#models/Error)

#### 401

Authentication is required to access this resource.

Type: [Error](/end-user-api/models.md#models/Error)

#### 403

Access to this resource is forbidden.

Type: [Error](/end-user-api/models.md#models/Error)

#### 404

The requested resource was not found.

Type: [Error](/end-user-api/models.md#models/Error)

#### 500

An unexpected error occurred on the server.

Type: [Error](/end-user-api/models.md#models/Error)

### Example request

```bash
curl https://apiv2.example.com/api/v2/end-user/subscribers/SUBSCRIBER_ID \
  --request PUT \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "address": {
    "attention": "John Doe",
    "city": "Natick",
    "country": "US",
    "region": "Ontario",
    "state": "CA",
    "street": "500 S Main St",
    "street1": "string",
    "street2": "Apt 1",
    "zip": "01701"
  },
  "contactNumber": "+15551234567",
  "email": "john.doe@example.com",
  "metadata": {
    "propertyName": "string"
  },
  "name": "John Doe"
}'
```