> Fetch clean Markdown by appending `.md` to any page URL under https://signalwire.com/docs or requesting it with the HTTP header `Accept: text/markdown`. The root index at https://signalwire.com/docs/llms.txt lists the available documentation indexes.

# Retrieve the billing profile

GET https://%7BYour_Space_Name%7D.signalwire.com/api/space/billing_profile

Returns the billing address and contacts for the space. A profile that has never been
configured is returned with `null` fields rather than a `404`.

The billing endpoints are available when billing is managed in the space itself, which
is the case for every ordinary space: if the Billing section appears in your Dashboard,
you can use them. A space purchased through a cloud marketplace, or a suspended or
deactivated space, receives `401`. A space deactivated for nonpayment keeps them so that
its outstanding balance can be settled.

#### Permissions

Authenticate with a [Personal access token](/docs/apis/authorization#personal-access-tokens) whose holder is an owner or admin of the space. A project API token is not accepted on this endpoint, and a Personal access token has no scopes: the holder's role in the space is the whole authorization decision.

Reference: https://signalwire.com/docs/apis/rest/space/billing/get-billing-profile

## Authentication

- `Authorization` header (basic auth, required) — Personal access token authentication for space-wide administration. Send HTTP Basic auth with an empty username and the Personal access token as the password. A Personal access token carries your own authority rather than a project's: it is created from your user menu in the Dashboard, is prefixed `pat_`, and has no scopes. The holder must be an owner or admin of the space named by the subdomain, and the token acts only on that space. Example: ``` Authorization: Basic base64(:pat_...) ```

## Response

### 200

The request has succeeded.

- `type` (enum, required) — The object type. Always `billing_profile`.
  - Allowed values: `billing_profile`
- `address_line1` (string, required, nullable) — The first line of the billing address.
- `address_line2` (string, required, nullable) — The second line of the billing address.
- `address_city` (string, required, nullable) — The city of the billing address.
- `address_state` (string, required, nullable) — The state, province, or region of the billing address.
- `address_zip` (string, required, nullable) — The postal code of the billing address.
- `address_country` (string, required, nullable) — The ISO 3166-1 alpha-2 country code of the billing address.
- `company_name` (string, required, nullable) — The company name that appears on statements.
- `contact_name` (string, required, nullable) — The name of the billing contact.
- `contact_email` (list of string, required, nullable) — The email addresses billing correspondence is sent to.
- `contact_phone` (string, required, nullable) — The phone number of the billing contact.
- `tax_id_number` (string, required, nullable) — The tax identification number that appears on statements.
- `monthly_invoices` (boolean, required) — Whether a monthly invoice is issued for the space.
- `tax_id_number_required` (boolean, required) — Whether `tax_id_number` is required when updating the profile. `true` on Enterprise spaces.
- `monthly_invoices_locked` (boolean, required) — Whether `monthly_invoices` is locked on. `true` on postpay spaces, where monthly invoices cannot be turned off.

## Errors

### 401 Unauthorized Error

The credential is missing, unknown, or revoked; its holder is not a member of the space in the subdomain; the member is not an owner or admin; or billing for this space is not managed in the space itself, which is the case for a space purchased through a cloud marketplace and for a suspended or deactivated space. A space deactivated for nonpayment keeps the billing endpoints so that its outstanding balance can be settled. The body is the plain text `Unauthorized`. An unverified space instead receives the JSON body `{"message": "Please validate a phone number to access your account."}` on every endpoint under `/api/space`.

- `message` (string, required) — States that a phone number must be validated for the space before it can use the API.

### 500 Internal Server Error

An internal server error occurred.

- `error` (enum, required)
  - Allowed values: `Internal Server Error`

## Examples

**Response**

```json
{
  "type": "billing_profile",
  "address_line1": "1234 Main St",
  "address_line2": "Suite 200",
  "address_city": "Austin",
  "address_state": "TX",
  "address_zip": "78701",
  "address_country": "US",
  "company_name": "Acme Inc",
  "contact_name": "Jane Doe",
  "contact_email": [
    "jane@example.com",
    "billing@example.com"
  ],
  "contact_phone": "+15125550100",
  "tax_id_number": "12-3456789",
  "monthly_invoices": false,
  "tax_id_number_required": false,
  "monthly_invoices_locked": false
}
```

**SDK Code**

```python
import requests

url = "https://{your_space_name}.signalwire.com/api/space/billing_profile"

response = requests.get(url, auth=("<username>", "<personal_access_token>"))

print(response.json())
```

```javascript
const url = 'https://{your_space_name}.signalwire.com/api/space/billing_profile';
const credentials = btoa("<username>:<personal_access_token>");

const options = {
  method: 'GET',
  headers: {Authorization: `Basic ${credentials}`}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{your_space_name}.signalwire.com/api/space/billing_profile"

	req, _ := http.NewRequest("GET", url, nil)

	req.SetBasicAuth("<username>", "<personal_access_token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://{your_space_name}.signalwire.com/api/space/billing_profile")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request.basic_auth("<username>", "<personal_access_token>")

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://{your_space_name}.signalwire.com/api/space/billing_profile")
  .basicAuth("<username>", "<personal_access_token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://{your_space_name}.signalwire.com/api/space/billing_profile', [
  'headers' => [
  ],
    'auth' => ['<username>', '<personal_access_token>'],
]);

echo $response->getBody();
```

```csharp
using RestSharp;
using RestSharp.Authenticators;

var client = new RestClient("https://{your_space_name}.signalwire.com/api/space/billing_profile");
client.Authenticator = new HttpBasicAuthenticator("<username>", "<personal_access_token>");
var request = new RestRequest(Method.GET);

IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let credentials = Data("<username>:<personal_access_token>".utf8).base64EncodedString()

let headers = ["Authorization": "Basic \(credentials)"]

let request = NSMutableURLRequest(url: NSURL(string: "https://{your_space_name}.signalwire.com/api/space/billing_profile")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```