Services

List your services

Parameters

Request example Try it in the Dashboard

curl -X GET "https://papaproxy.net/account_new/api/v1/customer/services" \
  -H "Authorization: Bearer $PAPAPROXY_API_KEY"

import os

import requests

resp = requests.get(
    "https://papaproxy.net/account_new/api/v1/customer/services",
    headers={"Authorization": f"Bearer {os.environ['PAPAPROXY_API_KEY']}"},
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

const resp = await fetch("https://papaproxy.net/account_new/api/v1/customer/services", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.PAPAPROXY_API_KEY}`,
  },
});
if (!resp.ok) throw new Error(`HTTP ${resp.status}`);
console.log(await resp.json());

<?php
$ch = curl_init('https://papaproxy.net/account_new/api/v1/customer/services');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('PAPAPROXY_API_KEY'),
    ],
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
var_dump($status, json_decode($response, true));

package main

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

func main() {
	req, err := http.NewRequest("GET", "https://papaproxy.net/account_new/api/v1/customer/services", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("PAPAPROXY_API_KEY"))
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	data, _ := io.ReadAll(resp.Body)
	fmt.Println(resp.Status, string(data))
}

Responses

• 200 Paginated service list. · 33 fields

  Example response · JSONCopy

  {
    "services": [
      {
        "id": "3bd2e419-2dc6-52bb-9d74-0a4560d55f53",
        "owner_type": "customer",
        "owner_id": "8218fbc6-d67b-52fd-a639-cca399215d31",
        "product_id": "5234db61-2f19-5aa0-8e64-faa72f7d4b76",
        "product_name": "Starter 2.5M",
        "product_kind": "proxy_rotating",
        "product_display_name": "Starter 2.5M",
        "display_name": "DC Rotating 2500k requests",
        "owner_email": null,
        "status": "active",
        "params": {
          "sticky": true,
          "username": "pp_user_3fa85f64",
          "pool_class": "datacenter",
          "quota_kind": "requests",
          "period_days": 30,
          "session_mode": "sticky"
        },
        "started_at": "2026-11-07T13:41:50.351104Z",
        "expires_at": "2027-01-06T13:41:50.369505Z",
        "grace_until": null,
        "cancelled_at": null,
        "usage_requests_cur": null,
        "usage_bytes_cur": null,
        "is_trial": false,
        "is_auto_renew": true,
        "customer_note": null,
        "created_at": "2026-11-07T13:41:50.327149Z",
        "price_cents": 4900,
        "price_unit": "period",
        "active_addon_types": [],
        "renewal_price_cents": 4900,
        "renewal_coverage": "not_covered",
        "suspend_reason": null,
        "next_quota_grant_at": "2026-12-07T13:41:50.369505Z",
        "renew_allowed": true
      },
      {
        "id": "cb532178-5b03-506a-84ea-0230ff28576b",
        "owner_type": "customer",
        "owner_id": "8218fbc6-d67b-52fd-a639-cca399215d31",
        "product_id": "50ef87c9-6dd6-50ae-b2e5-bef6da689911",
        "product_name": "Datacenter Proxy US 500 IPs",
        "product_kind": "proxy_datacenter",
        "product_display_name": "Datacenter Proxy US 500 IPs",
        "display_name": "Datacenter Proxy US 500 IPs",
        "owner_email": null,
        "status": "active",
        "params": {
          "geo": [
            "US"
          ],
          "segments": [
            {
              "count": 500,
              "country": 197148
            }
          ],
          "total_ip": 500,
          "composite": true,
          "whitelist_ips": [
            "203.0.113.10"
          ]
        },
        "started_at": "2026-11-07T13:41:00.208626Z",
        "expires_at": "2027-01-06T13:41:02.315398Z",
        "grace_until": null,
        "cancelled_at": null,
        "usage_requests_cur": null,
        "usage_bytes_cur": null,
        "is_trial": false,
        "is_auto_renew": true,
        "customer_note": null,
        "created_at": "2026-11-07T13:40:54.881463Z",
        "price_cents": 9500,
        "price_unit": "period",
        "active_addon_types": [],
        "renewal_price_cents": 9500,
        "renewal_coverage": "not_covered",
        "suspend_reason": null,
        "next_quota_grant_at": "2026-12-07T13:41:02.315398Z",
        "renew_allowed": true
      }
    ],
    "total": 16,
    "offset": 0,
    "limit": 2
  }

  Field	Type	Description
  services required	array of object
  services[].id required	string (uuid)	Unique ID.
  services[].owner_type required	string	Owner type (customer).
  services[].owner_id required	string (uuid)	ID of your account.
  services[].product_id required	string (uuid)	ID of the catalog product.
  services[].product_name	string	Catalog product name.Default: ""
  services[].product_kind	string	Product type: proxy_datacenter, proxy_isp, or proxy_rotating. Dedicated proxies report the underlying type and have params.dedicated = true.Default: ""
  services[].product_display_name	string	Product name shown in the Dashboard.Default: ""
  services[].display_name	string, nullable	Name shown in the Dashboard.
  services[].owner_email	string, nullable	Email of the owner, if set.
  services[].status required	string	Service status, for example active, pending (awaiting payment), or suspended.
  services[].params required	object, nullable	Service configuration: countries and IP counts for proxy packages; dedicated: true for dedicated proxies.
  services[].started_at required	string (date-time), nullable	When the service started (ISO 8601, UTC).
  services[].expires_at required	string (date-time), nullable	When the current term ends (ISO 8601, UTC).
  services[].grace_until	string (date-time), nullable	End of the grace period after expiration, if any.
  services[].cancelled_at required	string (date-time), nullable	When the service was canceled, if it was.
  services[].usage_requests_cur required	integer, nullable	Requests used in the current period (rotating proxies).
  services[].usage_bytes_cur required	integer, nullable	Bandwidth used in the current period, in bytes.
  services[].is_trial	boolean	Whether this is a trial service.Default: false
  services[].is_auto_renew required	boolean	Whether the service renews automatically.
  services[].customer_note	string, nullable	Your note on the service, if any.
  services[].created_at required	string (date-time)	When it was created (ISO 8601, UTC).
  services[].price_cents	integer, nullable	Price in cents.
  services[].price_unit	string, nullable	Billing unit of price_cents.
  services[].active_addon_types	array of string	Types of the add-ons that are active on this service.
  services[].renewal_price_cents	integer, nullable	Forecast charge at the next auto-renewal (base price + active add-ons), same resolution as the real renewal charge. None when not applicable (see renewal_coverage).
  services[].renewal_coverage	string	Whether the next renewal is covered: covered_by_balance, covered_by_card (an automatic top-up will charge the saved card), not_covered, or not_applicable.Default: "not_applicable"
  services[].suspend_reason	string, nullable	Why the service is suspended: quota_exhausted, expired, or other. Null when it isn't suspended.
  services[].next_quota_grant_at	string (date-time), nullable	When the next monthly request allowance is added (rotating services), if it falls within the paid term.
  services[].renew_allowed	boolean, nullable	Whether the service can be renewed right now.
  total required	integer	Total number of items across all pages.
  offset	integer	Number of items skipped.Default: 0
  limit	integer	Page size.Default: 50

• 401 The API key is missing, malformed, revoked, or expired, or the account is inactive.

  Example · JSONCopy

  {
    "detail": "Invalid or revoked API key."
  }

  Error format

• 403 The API key lacks scope services:read.

  Example · JSONCopy

  {
    "detail": "API key is missing required scope: services:read"
  }

  Error format

• 422 Validation error: a field is missing or has the wrong type or value.

  Example · JSONCopy

  {
    "detail": "Validation error"
  }

  Error format

• 429 Too many requests: the per-account limit is 60 requests per minute, shared by all keys and the MCP server. Retry with exponential backoff.

  Example · JSONCopy

  {
    "detail": "Too Many Requests"
  }

  Error format

Buy a service

Request body

Request example Try it in the Dashboard

curl -X POST "https://papaproxy.net/account_new/api/v1/customer/services" \
  -H "Authorization: Bearer $PAPAPROXY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"product_id": "5234db61-2f19-5aa0-8e64-faa72f7d4b76", "expected_price_cents": 4900}'

import os

import requests

resp = requests.post(
    "https://papaproxy.net/account_new/api/v1/customer/services",
    headers={"Authorization": f"Bearer {os.environ['PAPAPROXY_API_KEY']}"},
    json={
        "product_id": "5234db61-2f19-5aa0-8e64-faa72f7d4b76",
        "expected_price_cents": 4900
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

const resp = await fetch("https://papaproxy.net/account_new/api/v1/customer/services", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.PAPAPROXY_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "product_id": "5234db61-2f19-5aa0-8e64-faa72f7d4b76",
    "expected_price_cents": 4900
  }),
});
if (!resp.ok) throw new Error(`HTTP ${resp.status}`);
console.log(await resp.json());

<?php
$ch = curl_init('https://papaproxy.net/account_new/api/v1/customer/services');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('PAPAPROXY_API_KEY'),
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'product_id' => '5234db61-2f19-5aa0-8e64-faa72f7d4b76',
        'expected_price_cents' => 4900
    ]),
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
var_dump($status, json_decode($response, true));

package main

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

func main() {
	req, err := http.NewRequest("POST", "https://papaproxy.net/account_new/api/v1/customer/services", strings.NewReader(`{"product_id": "5234db61-2f19-5aa0-8e64-faa72f7d4b76", "expected_price_cents": 4900}`))
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("PAPAPROXY_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	data, _ := io.ReadAll(resp.Body)
	fmt.Println(resp.Status, string(data))
}

Responses

• 201 Result of service creation. · 31 fields

  Example response · JSONCopy

  {
    "service": {
      "id": "3bd2e419-2dc6-52bb-9d74-0a4560d55f53",
      "owner_type": "customer",
      "owner_id": "8218fbc6-d67b-52fd-a639-cca399215d31",
      "product_id": "5234db61-2f19-5aa0-8e64-faa72f7d4b76",
      "product_name": "Starter 2.5M",
      "product_kind": "proxy_rotating",
      "product_display_name": "Starter 2.5M",
      "display_name": "DC Rotating 2500k requests",
      "owner_email": null,
      "status": "active",
      "params": {
        "sticky": true,
        "username": "pp_user_3fa85f64",
        "pool_class": "datacenter",
        "quota_kind": "requests",
        "period_days": 30,
        "session_mode": "sticky"
      },
      "started_at": "2026-11-07T13:41:50.351104Z",
      "expires_at": "2027-01-06T13:41:50.369505Z",
      "grace_until": null,
      "cancelled_at": null,
      "usage_requests_cur": null,
      "usage_bytes_cur": null,
      "is_trial": false,
      "is_auto_renew": true,
      "customer_note": null,
      "created_at": "2026-11-07T13:41:50.327149Z",
      "price_cents": 4900,
      "price_unit": "period",
      "active_addon_types": [],
      "renewal_price_cents": null,
      "renewal_coverage": "not_applicable",
      "suspend_reason": null,
      "next_quota_grant_at": "2026-12-07T13:41:50.369505Z",
      "renew_allowed": true
    },
    "invoice_url": null
  }

  Field	Type	Description
  service required	object	A purchased service / subscription.
  service.id required	string (uuid)	Unique ID.
  service.owner_type required	string	Owner type (customer).
  service.owner_id required	string (uuid)	ID of your account.
  service.product_id required	string (uuid)	ID of the catalog product.
  service.product_name	string	Catalog product name.Default: ""
  service.product_kind	string	Product type: proxy_datacenter, proxy_isp, or proxy_rotating. Dedicated proxies report the underlying type and have params.dedicated = true.Default: ""
  service.product_display_name	string	Product name shown in the Dashboard.Default: ""
  service.display_name	string, nullable	Name shown in the Dashboard.
  service.owner_email	string, nullable	Email of the owner, if set.
  service.status required	string	Service status, for example active, pending (awaiting payment), or suspended.
  service.params required	object, nullable	Service configuration: countries and IP counts for proxy packages; dedicated: true for dedicated proxies.
  service.started_at required	string (date-time), nullable	When the service started (ISO 8601, UTC).
  service.expires_at required	string (date-time), nullable	When the current term ends (ISO 8601, UTC).
  service.grace_until	string (date-time), nullable	End of the grace period after expiration, if any.
  service.cancelled_at required	string (date-time), nullable	When the service was canceled, if it was.
  service.usage_requests_cur required	integer, nullable	Requests used in the current period (rotating proxies).
  service.usage_bytes_cur required	integer, nullable	Bandwidth used in the current period, in bytes.
  service.is_trial	boolean	Whether this is a trial service.Default: false
  service.is_auto_renew required	boolean	Whether the service renews automatically.
  service.customer_note	string, nullable	Your note on the service, if any.
  service.created_at required	string (date-time)	When it was created (ISO 8601, UTC).
  service.price_cents	integer, nullable	Price in cents.
  service.price_unit	string, nullable	Billing unit of price_cents.
  service.active_addon_types	array of string	Types of the add-ons that are active on this service.
  service.renewal_price_cents	integer, nullable	Forecast charge at the next auto-renewal (base price + active add-ons), same resolution as the real renewal charge. None when not applicable (see renewal_coverage).
  service.renewal_coverage	string	Whether the next renewal is covered: covered_by_balance, covered_by_card (an automatic top-up will charge the saved card), not_covered, or not_applicable.Default: "not_applicable"
  service.suspend_reason	string, nullable	Why the service is suspended: quota_exhausted, expired, or other. Null when it isn't suspended.
  service.next_quota_grant_at	string (date-time), nullable	When the next monthly request allowance is added (rotating services), if it falls within the paid term.
  service.renew_allowed	boolean, nullable	Whether the service can be renewed right now.
  invoice_url	string, nullable	Link to the invoice, if one was issued.

• 401 The API key is missing, malformed, revoked, or expired, or the account is inactive.

  Example · JSONCopy

  {
    "detail": "Invalid or revoked API key."
  }

  Error format

• 403 The API key lacks scope services:write.

  Example · JSONCopy

  {
    "detail": "API key is missing required scope: services:write"
  }

  Error format

• 422 Validation error: a field is missing or has the wrong type or value.

  Example · JSONCopy

  {
    "detail": "Validation error"
  }

  Error format

• 429 Too many requests: the per-account limit is 60 requests per minute, shared by all keys and the MCP server. Retry with exponential backoff.

  Example · JSONCopy

  {
    "detail": "Too Many Requests"
  }

  Error format

Get a service

Parameters

Request example Try it in the Dashboard

curl -X GET "https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer $PAPAPROXY_API_KEY"

import os

import requests

resp = requests.get(
    "https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6",
    headers={"Authorization": f"Bearer {os.environ['PAPAPROXY_API_KEY']}"},
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

const resp = await fetch("https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.PAPAPROXY_API_KEY}`,
  },
});
if (!resp.ok) throw new Error(`HTTP ${resp.status}`);
console.log(await resp.json());

<?php
$ch = curl_init('https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('PAPAPROXY_API_KEY'),
    ],
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
var_dump($status, json_decode($response, true));

package main

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

func main() {
	req, err := http.NewRequest("GET", "https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("PAPAPROXY_API_KEY"))
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	data, _ := io.ReadAll(resp.Body)
	fmt.Println(resp.Status, string(data))
}

Responses

• 200 A purchased service / subscription. · 29 fields

  Example response · JSONCopy

  {
    "id": "cb532178-5b03-506a-84ea-0230ff28576b",
    "owner_type": "customer",
    "owner_id": "8218fbc6-d67b-52fd-a639-cca399215d31",
    "product_id": "50ef87c9-6dd6-50ae-b2e5-bef6da689911",
    "product_name": "Datacenter Proxy US 500 IPs",
    "product_kind": "proxy_datacenter",
    "product_display_name": "Datacenter Proxy US 500 IPs",
    "display_name": "Datacenter Proxy US 500 IPs",
    "owner_email": null,
    "status": "active",
    "params": {
      "geo": [
        "US"
      ],
      "segments": [
        {
          "count": 500,
          "country": 197148
        }
      ],
      "total_ip": 500,
      "composite": true,
      "whitelist_ips": [
        "203.0.113.10"
      ]
    },
    "started_at": "2026-11-07T13:41:00.208626Z",
    "expires_at": "2027-01-06T13:41:02.315398Z",
    "grace_until": null,
    "cancelled_at": null,
    "usage_requests_cur": null,
    "usage_bytes_cur": null,
    "is_trial": false,
    "is_auto_renew": true,
    "customer_note": null,
    "created_at": "2026-11-07T13:40:54.881463Z",
    "price_cents": 9500,
    "price_unit": "period",
    "active_addon_types": [],
    "renewal_price_cents": 9500,
    "renewal_coverage": "not_covered",
    "suspend_reason": null,
    "next_quota_grant_at": "2026-12-07T13:41:02.315398Z",
    "renew_allowed": true
  }

  Field	Type	Description
  id required	string (uuid)	Unique ID.
  owner_type required	string	Owner type (customer).
  owner_id required	string (uuid)	ID of your account.
  product_id required	string (uuid)	ID of the catalog product.
  product_name	string	Catalog product name.Default: ""
  product_kind	string	Product type: proxy_datacenter, proxy_isp, or proxy_rotating. Dedicated proxies report the underlying type and have params.dedicated = true.Default: ""
  product_display_name	string	Product name shown in the Dashboard.Default: ""
  display_name	string, nullable	Name shown in the Dashboard.
  owner_email	string, nullable	Email of the owner, if set.
  status required	string	Service status, for example active, pending (awaiting payment), or suspended.
  params required	object, nullable	Service configuration: countries and IP counts for proxy packages; dedicated: true for dedicated proxies.
  started_at required	string (date-time), nullable	When the service started (ISO 8601, UTC).
  expires_at required	string (date-time), nullable	When the current term ends (ISO 8601, UTC).
  grace_until	string (date-time), nullable	End of the grace period after expiration, if any.
  cancelled_at required	string (date-time), nullable	When the service was canceled, if it was.
  usage_requests_cur required	integer, nullable	Requests used in the current period (rotating proxies).
  usage_bytes_cur required	integer, nullable	Bandwidth used in the current period, in bytes.
  is_trial	boolean	Whether this is a trial service.Default: false
  is_auto_renew required	boolean	Whether the service renews automatically.
  customer_note	string, nullable	Your note on the service, if any.
  created_at required	string (date-time)	When it was created (ISO 8601, UTC).
  price_cents	integer, nullable	Price in cents.
  price_unit	string, nullable	Billing unit of price_cents.
  active_addon_types	array of string	Types of the add-ons that are active on this service.
  renewal_price_cents	integer, nullable	Forecast charge at the next auto-renewal (base price + active add-ons), same resolution as the real renewal charge. None when not applicable (see renewal_coverage).
  renewal_coverage	string	Whether the next renewal is covered: covered_by_balance, covered_by_card (an automatic top-up will charge the saved card), not_covered, or not_applicable.Default: "not_applicable"
  suspend_reason	string, nullable	Why the service is suspended: quota_exhausted, expired, or other. Null when it isn't suspended.
  next_quota_grant_at	string (date-time), nullable	When the next monthly request allowance is added (rotating services), if it falls within the paid term.
  renew_allowed	boolean, nullable	Whether the service can be renewed right now.

• 401 The API key is missing, malformed, revoked, or expired, or the account is inactive.

  Example · JSONCopy

  {
    "detail": "Invalid or revoked API key."
  }

  Error format

• 403 The API key lacks scope services:read.

  Example · JSONCopy

  {
    "detail": "API key is missing required scope: services:read"
  }

  Error format

• 404 Service not found, or it doesn't belong to your account.

  Example · JSONCopy

  {
    "detail": "Service 3fa85f64-5717-4562-b3fc-2c963f66afa6 not found."
  }

  Error format

• 422 Validation error: a field is missing or has the wrong type or value.

  Example · JSONCopy

  {
    "detail": "Validation error"
  }

  Error format

• 429 Too many requests: the per-account limit is 60 requests per minute, shared by all keys and the MCP server. Retry with exponential backoff.

  Example · JSONCopy

  {
    "detail": "Too Many Requests"
  }

  Error format

Renew a service

Parameters

Request body

Request example Try it in the Dashboard

curl -X POST "https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/renew" \
  -H "Authorization: Bearer $PAPAPROXY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"period_months": 1, "idempotency_key": "renew-2026-001"}'

import os

import requests

resp = requests.post(
    "https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/renew",
    headers={"Authorization": f"Bearer {os.environ['PAPAPROXY_API_KEY']}"},
    json={
        "period_months": 1,
        "idempotency_key": "renew-2026-001"
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

const resp = await fetch("https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/renew", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.PAPAPROXY_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "period_months": 1,
    "idempotency_key": "renew-2026-001"
  }),
});
if (!resp.ok) throw new Error(`HTTP ${resp.status}`);
console.log(await resp.json());

<?php
$ch = curl_init('https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/renew');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('PAPAPROXY_API_KEY'),
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'period_months' => 1,
        'idempotency_key' => 'renew-2026-001'
    ]),
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
var_dump($status, json_decode($response, true));

package main

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

func main() {
	req, err := http.NewRequest("POST", "https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/renew", strings.NewReader(`{"period_months": 1, "idempotency_key": "renew-2026-001"}`))
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("PAPAPROXY_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	data, _ := io.ReadAll(resp.Body)
	fmt.Println(resp.Status, string(data))
}

Responses

• 200 Simple status update response. · 8 fields

  Example response · JSONCopy

  {
    "service_id": "cb532178-5b03-506a-84ea-0230ff28576b",
    "status": "active",
    "message": "Service renewed for 1 month(s).",
    "refund_cents": null,
    "new_expires_at": "2027-01-06T13:41:02.315398Z",
    "charged_cents": 5700,
    "funding_source": null,
    "refund_base_cents": null
  }

  Field	Type	Description
  service_id required	string (uuid)	ID of the service.
  status required	string
  message required	string
  refund_cents	integer, nullable
  new_expires_at	string (date-time), nullable
  charged_cents	integer, nullable	Amount charged to your wallet, in cents.
  funding_source	string, nullable
  refund_base_cents	integer, nullable

• 400 Insufficient wallet balance. Nothing is charged.

  Example · JSONCopy

  {
    "detail": "Insufficient funds: need 9500 cents"
  }

  Error format

• 401 The API key is missing, malformed, revoked, or expired, or the account is inactive.

  Example · JSONCopy

  {
    "detail": "Invalid or revoked API key."
  }

  Error format

• 403 The API key lacks scope services:write.

  Example · JSONCopy

  {
    "detail": "API key is missing required scope: services:write"
  }

  Error format

• 404 Service not found, or it doesn't belong to your account.

  Example · JSONCopy

  {
    "detail": "Service 3fa85f64-5717-4562-b3fc-2c963f66afa6 not found."
  }

  Error format

• 422 Validation error: a field is missing or has the wrong type or value.

  Example · JSONCopy

  {
    "detail": "Validation error"
  }

  Error format

• 429 Too many requests: the per-account limit is 60 requests per minute, shared by all keys and the MCP server. Retry with exponential backoff.

  Example · JSONCopy

  {
    "detail": "Too Many Requests"
  }

  Error format

Cancel a service

Parameters

Request example Try it in the Dashboard

curl -X POST "https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/cancel" \
  -H "Authorization: Bearer $PAPAPROXY_API_KEY"

import os

import requests

resp = requests.post(
    "https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/cancel",
    headers={"Authorization": f"Bearer {os.environ['PAPAPROXY_API_KEY']}"},
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

const resp = await fetch("https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/cancel", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.PAPAPROXY_API_KEY}`,
  },
});
if (!resp.ok) throw new Error(`HTTP ${resp.status}`);
console.log(await resp.json());

<?php
$ch = curl_init('https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/cancel');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('PAPAPROXY_API_KEY'),
    ],
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
var_dump($status, json_decode($response, true));

package main

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

func main() {
	req, err := http.NewRequest("POST", "https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/cancel", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("PAPAPROXY_API_KEY"))
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	data, _ := io.ReadAll(resp.Body)
	fmt.Println(resp.Status, string(data))
}

Responses

• 200 Simple status update response. · 8 fields

  Field	Type	Description
  service_id required	string (uuid)	ID of the service.
  status required	string
  message required	string
  refund_cents	integer, nullable
  new_expires_at	string (date-time), nullable
  charged_cents	integer, nullable	Amount charged to your wallet, in cents.
  funding_source	string, nullable
  refund_base_cents	integer, nullable

• 401 The API key is missing, malformed, revoked, or expired, or the account is inactive.

  Example · JSONCopy

  {
    "detail": "Invalid or revoked API key."
  }

  Error format

• 403 The API key lacks scope services:write.

  Example · JSONCopy

  {
    "detail": "API key is missing required scope: services:write"
  }

  Error format

• 404 Service not found, or it doesn't belong to your account.

  Example · JSONCopy

  {
    "detail": "Service 3fa85f64-5717-4562-b3fc-2c963f66afa6 not found."
  }

  Error format

• 409 A cancellation cooldown is active for your account.

  Example · JSONCopy

  {
    "detail": {
      "error": "SERVICE_CANCEL_COOLDOWN",
      "support_required": true,
      "retry_at": "2026-11-10T13:41:08Z",
      "retry_after_seconds": 252708
    }
  }

  Error format

• 422 Validation error: a field is missing or has the wrong type or value.

  Example · JSONCopy

  {
    "detail": "Validation error"
  }

  Error format

• 429 Too many requests: the per-account limit is 60 requests per minute, shared by all keys and the MCP server. Retry with exponential backoff.

  Example · JSONCopy

  {
    "detail": "Too Many Requests"
  }

  Error format

Get usage statistics

Parameters

Request example Try it in the Dashboard

curl -X GET "https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/usage?start=2026-11-06T12:00:00Z&end=2026-11-06T12:00:00Z" \
  -H "Authorization: Bearer $PAPAPROXY_API_KEY"

import os

import requests

resp = requests.get(
    "https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/usage?start=2026-11-06T12:00:00Z&end=2026-11-06T12:00:00Z",
    headers={"Authorization": f"Bearer {os.environ['PAPAPROXY_API_KEY']}"},
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

const resp = await fetch("https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/usage?start=2026-11-06T12:00:00Z&end=2026-11-06T12:00:00Z", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.PAPAPROXY_API_KEY}`,
  },
});
if (!resp.ok) throw new Error(`HTTP ${resp.status}`);
console.log(await resp.json());

<?php
$ch = curl_init('https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/usage?start=2026-11-06T12:00:00Z&end=2026-11-06T12:00:00Z');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('PAPAPROXY_API_KEY'),
    ],
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
var_dump($status, json_decode($response, true));

package main

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

func main() {
	req, err := http.NewRequest("GET", "https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/usage?start=2026-11-06T12:00:00Z&end=2026-11-06T12:00:00Z", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("PAPAPROXY_API_KEY"))
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	data, _ := io.ReadAll(resp.Body)
	fmt.Println(resp.Status, string(data))
}

Responses

• 200 Usage stats for a proxy service. · 5 fields

  Example response · JSONCopy

  {
    "connections": 0,
    "bytes_used": 0,
    "window": {
      "start": "2026-11-01T00:00:00Z",
      "end": "2026-11-07T23:59:59Z"
    }
  }

  Field	Type	Description
  connections	integer	Default: 0
  bytes_used	integer	Default: 0
  window required	object	Time window for usage stats.
  window.start required	string (date-time)
  window.end required	string (date-time)

• 401 The API key is missing, malformed, revoked, or expired, or the account is inactive.

  Example · JSONCopy

  {
    "detail": "Invalid or revoked API key."
  }

  Error format

• 403 The API key lacks scope usage:read.

  Example · JSONCopy

  {
    "detail": "API key is missing required scope: usage:read"
  }

  Error format

• 404 Service not found, or it doesn't belong to your account.

  Example · JSONCopy

  {
    "detail": "Service 3fa85f64-5717-4562-b3fc-2c963f66afa6 not found."
  }

  Error format

• 422 Validation error: a field is missing or has the wrong type or value.

  Example · JSONCopy

  {
    "detail": "Validation error"
  }

  Error format

• 429 Too many requests: the per-account limit is 60 requests per minute, shared by all keys and the MCP server. Retry with exponential backoff.

  Example · JSONCopy

  {
    "detail": "Too Many Requests"
  }

  Error format