# Get Outbound Call Price File

Returns the outbound call price file of the plan assigned to the account, or only its headers.

`GET` downloads the prices of the plan as a gzipped CSV file named
`voice_out_prices.csv.gz`. `HEAD` returns the headers of the file without its body, so
you can check whether your copy is current before you download it.

## 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. The columns carry what the lookup attributes of the matching names
carry (see [Outbound Call Price Object](outbound-call-price-object.html)). 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.002`).

| Column | Description |
| --- | --- |
| Category | `International`, `Origin based` or `Local`. Same as `category`. |
| Country | Destination country of the prefix, by name. Same as `country`. |
| Network | Destination network of the prefix, by name. Same as `network`. |
| Prefix | Destination prefix. Same as `prefix`. |
| Rate | Current per-minute rate. Empty when the plan rejects calls to the destination or no price is in effect. Same as `rate`. |
| Connection fee | Current fee charged once per call. Empty when the plan rejects calls to the destination or no price is in effect. Same as `connection_fee`. |
| Initial increment | First billing increment, in seconds. Empty when no price is in effect. Same as `initial_increment`. |
| Recurring increment | Each following billing increment, in seconds. Empty when no price is in effect. Same as `recurring_increment`. |
| Reject calls | `true` when the plan rejects calls to the destination, otherwise `false`. Same as `reject_calls`. |
| Next rate | Per-minute rate from the Effective date on. Same as `next_rate`. |
| Next connection fee | Fee charged once per call from the Effective date on. Same as `next_connection_fee`. |
| Next initial increment | First billing increment, in seconds, from the Effective date on. Same as `next_initial_increment`. |
| Next recurring increment | Each following billing increment, in seconds, from the Effective date on. Same as `next_recurring_increment`. |
| Effective date | When the scheduled change takes effect, in UTC, for example `2026-11-01T00:00:00Z`. Same as `effective_at`. |
| Comment | The scheduled change of the price. Same as `comment`. |

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

### New Breakout and Removed

The file looks 30 days ahead:

- A prefix that has no price in effect, but whose next price starts within 30 days, is
  listed with the Comment `New Breakout`. Its Rate, Connection fee, Initial increment and
  Recurring increment are empty, and its Next columns carry the price it opens with.
- A prefix that rejects calls, and whose next price starts within 30 days, is listed with
  the Comment `New Breakout` too. It keeps its own increments, and its Next columns carry
  the price it opens with.
- A price that ends within 30 days, with no price of the same prefix taking over when it
  ends, is listed with the Comment `Removed`. The Effective date is the end of the price.

Example of the file content:

```
Category,Country,Network,Prefix,Rate,Connection fee,Initial increment,Recurring increment,Reject calls,Next rate,Next connection fee,Next initial increment,Next recurring increment,Effective date,Comment
International,Germany,Fixed,4930,0.0045,0.0,1,1,false,0.005,0.0,1,1,2026-11-01T00:00:00Z,Increase
International,Germany,Mobile,49151,0.021,0.0,1,1,false,,,,,,
International,Germany,Mobile,49152,0.024,0.0,1,1,false,,,,,2026-11-05T00:00:00Z,Removed
International,Germany,Mobile,49153,,,,,false,0.024,0.0,1,1,2026-11-05T00:00:00Z,New Breakout
International,Germany,Mobile,49155,,,30,30,true,0.024,0.0,1,1,2026-11-05T00:00:00Z,New Breakout
Origin based,Germany,Fixed,4930,0.0012,0.0,1,1,false,,,,,,
```

## Request

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

HTTP Method: `GET` or `HEAD`

URI Path: `/v3/prices.csv.gz`

The access token must list `api-vout.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 `voice_out_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. 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/prices.csv.gz HTTP/1.1
2Host: api-vout.didww.com
3Authorization: Bearer [access token]
```

curl

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

response

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

[[DIDWW-API-EXAMPLE-END]]

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

```
curl -o voice_out_prices.csv.gz https://api-vout.didww.com/v3/prices.csv.gz -H "Authorization: Bearer [access token]"
```

[[DIDWW-API-EXAMPLE-START]]

http

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

curl

```
1curl -i -X GET https://api-vout.didww.com/v3/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="voice_out_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-vout.didww.com/v3/prices.csv.gz -H "Authorization: Bearer [access token]"
```

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


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

## 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 | No price plan is assigned to the account (`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. |
