# Get SMS OUT Price File

Returns the SMS OUT price file of the plan assigned to the account in an SMS OUT domain (A2P,
P2P or OTP), or only its headers.

`GET` downloads the prices of the plan as a gzipped CSV file. `HEAD` returns the headers
of the file without its body, so you can check whether your copy is current before you
download it. The three domains have the same file format; the path selects the domain.

## File Format

The file is a CSV file (UTF-8, LF line endings, a header row) compressed with gzip. Each row
is one price of the plan. Prices are in USD, VAT excluded. They are printed as the lookup
returns them: never rounded, with trailing zeros dropped and at least one decimal kept
(`0.0`, `1.5`, `0.0525`).

| Column | Description |
| --- | --- |
| Source prefix | Prefix of the sending number. Empty when the price applies to an SMS from any number. Same as `source_prefix` in the [SMS OUT Price Object](sms-out-price-object.html). |
| Destination prefix | Destination prefix. Empty when the price applies to any destination. Same as `destination_prefix`. |
| Country | Destination country, by name. Same as `country`. |
| MCC | Mobile country code of the destination network. Empty when the price applies to any network. Same as `mcc`. |
| MCC name | Name of the mobile country code. Same as `mcc_name`. |
| MNC | Mobile network code of the destination network. Empty when the price applies to any network of the country. Same as `mnc`. |
| MNC name | Name of the mobile network. Same as `mnc_name`. |
| Reject SMS | `true` when the plan rejects SMS to the destination, otherwise `false`. Same as `reject_sms`. |
| Price | Price per SMS. Empty when Reject SMS is `true`. Same as `price`. |

The file leaves out some settings of a price, so two rows can look alike or show one
destination at different prices.

Example of the file content:

```
Source prefix,Destination prefix,Country,MCC,MCC name,MNC,MNC name,Reject SMS,Price
,336,France,208,France,,,false,0.0525
,338,France,,,,,true,
,49151,Germany,262,Germany,1,Telekom Deutschland,false,0.075
,49151,Germany,262,Germany,2,Vodafone,false,0.078
```

## Request

Host: `api-sms.didww.com` (Sandbox: `api-sms-sandbox.didww.com`)

HTTP Method: `GET` or `HEAD`

URI Path:

| Domain | URI Path | File name |
| --- | --- | --- |
| SMS OUT A2P | `/v3/sms_out/a2p/prices.csv.gz` | `sms_out_a2p_prices.csv.gz` |
| SMS OUT P2P | `/v3/sms_out/p2p/prices.csv.gz` | `sms_out_p2p_prices.csv.gz` |
| SMS OUT OTP | `/v3/sms_out/otp/prices.csv.gz` | `sms_out_otp_prices.csv.gz` |

The access token must list `api-sms.didww.com` in its `aud`. The `read` scope is
enough.

### Request Headers

| Name | Type | Is Required? | Description |
| --- | --- | --- | --- |
| If-Modified-Since | `string` | No | The `Last-Modified` date of the copy you hold. The file (or, for `HEAD`, its headers) is sent only if it changed after that date. Otherwise the response is `304 Not Modified`. Ignored when the request also carries `If-None-Match`. |

### Response Headers

| Name | Description |
| --- | --- |
| Content-Disposition | `attachment` with the file name of the domain, for example `sms_out_a2p_prices.csv.gz`. |
| Last-Modified | HTTP date of the later of the last change of the file content and the last change of the account's plan assignment in this domain. Send it back in `If-Modified-Since`. |
| Cache-Control | Always `private`. |
| Accept-Ranges | Always `none`. The file is served whole, without byte ranges. |
| Vary | Always `Authorization`. One URL returns each account the file of its own plan. |
| Content-Length | Size of the gzipped file in bytes. Not sent with `304 Not Modified`. |

No `ETag` is sent. A request that carries `If-None-Match` is always answered in full.

## Examples

Download the FileDownload if ChangedCheck the File

[[DIDWW-API-EXAMPLE-START]]

http

```
1GET /v3/sms_out/a2p/prices.csv.gz HTTP/1.1
2Host: api-sms.didww.com
3Authorization: Bearer [access token]
```

curl

```
1curl -i -X GET https://api-sms.didww.com/v3/sms_out/a2p/prices.csv.gz -H "Authorization: Bearer [access token]"
```

response

```
1HTTP/1.1 200 OK
2Content-Type: application/gzip
3Content-Disposition: attachment; filename="sms_out_a2p_prices.csv.gz"
4Last-Modified: Wed, 14 Oct 2026 06:00:00 GMT
5Cache-Control: private
6Accept-Ranges: none
7Vary: Authorization
8Content-Length: 215384
```

[[DIDWW-API-EXAMPLE-END]]

To save the file with curl, use `-o` with a file name in place of `-i`:

```
curl -o sms_out_a2p_prices.csv.gz https://api-sms.didww.com/v3/sms_out/a2p/prices.csv.gz -H "Authorization: Bearer [access token]"
```

[[DIDWW-API-EXAMPLE-START]]

http

```
1GET /v3/sms_out/a2p/prices.csv.gz HTTP/1.1
2Host: api-sms.didww.com
3Authorization: Bearer [access token]
4If-Modified-Since: Wed, 14 Oct 2026 06:00:00 GMT
```

curl

```
1curl -i -X GET https://api-sms.didww.com/v3/sms_out/a2p/prices.csv.gz -H "If-Modified-Since: Wed, 14 Oct 2026 06:00:00 GMT" -H "Authorization: Bearer [access token]"
```

response

```
1HTTP/1.1 304 Not Modified
2Content-Disposition: attachment; filename="sms_out_a2p_prices.csv.gz"
3Last-Modified: Wed, 14 Oct 2026 06:00:00 GMT
4Cache-Control: private
5Accept-Ranges: none
6Vary: Authorization
```

[[DIDWW-API-EXAMPLE-END]]

With curl, send `HEAD` with `-I` (`--head`), not with `-X HEAD`. `-X HEAD`
changes only the method name: curl still expects the body that `Content-Length`
announces, and the command does not finish normally.

```
curl -I https://api-sms.didww.com/v3/sms_out/a2p/prices.csv.gz -H "Authorization: Bearer [access token]"
```

```
HEAD /v3/sms_out/a2p/prices.csv.gz HTTP/1.1
Host: api-sms.didww.com
Authorization: Bearer [access token]


HTTP/1.1 200 OK
Content-Disposition: attachment; filename="sms_out_a2p_prices.csv.gz"
Last-Modified: Wed, 14 Oct 2026 06:00:00 GMT
Cache-Control: private
Accept-Ranges: none
Vary: Authorization
Content-Length: 215384
```

## Other Responses

Error responses to `GET` are JSON:API error documents. Responses to `HEAD` carry no body.

| Code | Success | Description |
| --- | --- | --- |
| 304 | Yes | The file has not changed since the `If-Modified-Since` date. The response carries the headers of the `200` response except `Content-Length`, and no body. |
| 401 | No | [Unauthorized](../../authentication.html#authentication-v35). The bearer token was refused. The response carries `WWW-Authenticate: Bearer error="invalid_token"`. |
| 403 | No | The token does not carry the `read` scope (title `Insufficient scope`). The response carries `WWW-Authenticate: Bearer error="insufficient_scope"`. |
| 404 | No | The account holds no price plan of the service in this domain, either no plan at all or a plan for which the service publishes no prices (`price_plan_not_assigned`). |
| 429 | No | The request budget of the account on this service for the current window is spent (`too_many_requests`). `Retry-After` gives the number of seconds to wait. |
| 503 | No | The file could not be served, for example because the assigned plan has no generated file yet (`serving_failure`). `Retry-After` gives the number of seconds to wait. |
