Get Customer Overview - bunny.net Documentation

Get Customer Overview

curl --request GET \
  --url https://api.bunny.net/partner/customer/{customerUserId} \
  --header 'AccessKey: <api-key>'

const options = {method: 'GET', headers: {AccessKey: '<api-key>'}};

fetch('https://api.bunny.net/partner/customer/{customerUserId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bunny.net/partner/customer/{customerUserId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "AccessKey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.bunny.net/partner/customer/{customerUserId}"

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

	req.Header.Add("AccessKey", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.bunny.net/partner/customer/{customerUserId}")

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

request = Net::HTTP::Get.new(url)
request["AccessKey"] = '<api-key>'

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

{
  "MonthlyBandwidthUsedBytes": 123,
  "MonthlyRequestCount": 123,
  "TotalStorageUsedBytes": 123,
  "MonthlyCostUsd": 123,
  "ContractValue": 123,
  "BandwidthUsedChart": {},
  "Products": [
    {
      "IsEnabled": true,
      "ResourceCount": 123
    }
  ]
}

GET

/

partner

/

customer

/

{customerUserId}

Get Customer Overview

curl --request GET \
  --url https://api.bunny.net/partner/customer/{customerUserId} \
  --header 'AccessKey: <api-key>'

const options = {method: 'GET', headers: {AccessKey: '<api-key>'}};

fetch('https://api.bunny.net/partner/customer/{customerUserId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bunny.net/partner/customer/{customerUserId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "AccessKey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.bunny.net/partner/customer/{customerUserId}"

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

	req.Header.Add("AccessKey", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.bunny.net/partner/customer/{customerUserId}")

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

request = Net::HTTP::Get.new(url)
request["AccessKey"] = '<api-key>'

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

{
  "MonthlyBandwidthUsedBytes": 123,
  "MonthlyRequestCount": 123,
  "TotalStorageUsedBytes": 123,
  "MonthlyCostUsd": 123,
  "ContractValue": 123,
  "BandwidthUsedChart": {},
  "Products": [
    {
      "IsEnabled": true,
      "ResourceCount": 123
    }
  ]
}

Authorizations

AccessKey

string

header

required

API Access Key authorization header

Path Parameters

customerUserId

string

required

Response

Overview payload.

MonthlyBandwidthUsedBytes

integer<int64>

Bandwidth served to the customer in the current month

MonthlyRequestCount

integer<int64>

Total pull-zone requests served to the customer in the current month

TotalStorageUsedBytes

integer<int64>

Storage currently used across all of the customer's storage zones

MonthlyCostUsd

number<double>

Accrued cost for the current calendar month

ContractValue

number<decimal> | null

Contract value agreed with the partner.

ContractCurrency

enum<integer> | null

Currency of the contract value.

Available options:

0,

1

BandwidthUsedChart

object | null

Daily bandwidth used over the last 7 days

Show child attributes

Products

object[] | null

Enable/disable state and resource count for each product the customer can use

Show child attributes

Last modified on August 12, 2026