Do the most common tasks entirely through the API

Get an access token

curl -s -X POST https://hydra.ipxo.com/oauth2/token \
  -u "$CLIENT_ID:$CLIENT_SECRET" \
  -d "grant_type=client_credentials" \
  -d "scope=billing ecommerce credits nethub-data"

{
  "access_token": "eyJhbGciOiJSUzI1NiIs…",
  "token_type": "bearer",
  "expires_in": 3599,
  "scope": "billing ecommerce credits nethub-data"
}

# Then send it on every call:
curl -s https://apigw.ipxo.com/billing/v1/TENANT_UUID \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Know the three path shapes

Your API identity is a tenant (company). The Ecommerce and Credits systems call the same identifier user_id — it's typically the same UUID.

Search the marketplace

The primary discovery endpoint. Keep the pricing.uuid — you need it to reserve.

curl -s "https://apigw.ipxo.com/billing/v1/TENANT_UUID/market/search?prefix_length=24&geo_country_code=US&registrars%5B%5D=arin&sort%5B%5D=price&limit=100" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

{
  "data": [{
    "notation": "40.183.32.0/24",
    "address_string": "40.183.32.0",
    "prefix_length": 24,
    "registrar": "arin",
    "pricing": { "uuid": "9df98051-0e47-4be7-96c2-f73101b010a2", "price": 215.51, "negotiable": false },
    "geo_data": { "maxmind": { "country_code": "US" }, "ipinfo": { "city_name": "New York City" } },
    "capabilities": { "rpki": "manual", "whois": { "inetnum": "automated", "rdns": "unsupported" } }
  }]
}

Reserve the subnet

Holds the subnet so nobody else can lease it while you complete checkout.

curl -s -X POST "https://apigw.ipxo.com/billing/v1/TENANT_UUID/market/ipv4/services/reserve" \
  -H "Authorization: Bearer $ACCESS_TOKEN" -H "Content-Type: application/json" \
  -d '{ "pricing_uuid": "9df98051-0e47-4be7-96c2-f73101b010a2", "billing_cycle": 1 }'

{ "uuid": "RESERVATION_UUID", "address": "40.183.32.0", "cidr": 24,
  "price": 215.51, "commitment_period": 1, "created_at": 1769731200 }

Already reserved by someone else → 409 "Subnet is already reserved".

Create a billing address (first purchase only)

Stored once, reused on every later cart and order. List existing ones with GET on the same path.

curl -s -X POST "https://apigw.ipxo.com/ecommerce/public/TENANT_UUID/addresses" \
  -H "Authorization: Bearer $ACCESS_TOKEN" -H "Content-Type: application/json" \
  -d '{
    "company_name": "Acme Corp", "line_one": "123 Main St",
    "city": "New York", "province_code": "NY",
    "country_code": "US", "postcode": "10001",
    "contact_email": "[email protected]"
  }'

200Returns the created address including its uuid (from backend source). One billing address per customer — a second create fails; required flags above are from the backend validation.

Register a payment method (first purchase only)

List available gateways to get the gateway config UUID — for Stripe it includes the publishable key for client-side tokenisation.

curl -s "https://apigw.ipxo.com/ecommerce/public/TENANT_UUID/gateways" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

{
  "data": [
    { "uuid": "9e072516-8236-4fa7-be0c-9de0b1c47c67", "gateway": "stripe",
      "config": { "public_key": "pk_test_51IQTJqEZwbJqxJ4z…" } },
    { "uuid": "9e072516-8236-4fa7-be0c-9de0b1c47c68", "gateway": "paypal", "config": null }
  ],
  "meta": { "current_page": 1, "total": 2, "per_page": 10 }
}

curl -s -X POST "https://apigw.ipxo.com/ecommerce/public/TENANT_UUID/gateways/GATEWAY_CONFIG_UUID/card" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

204Payment method registered. No response body.

Build the cart

Get-or-create: returns the customer's active cart, creating one if none exists — this is where cart_uuid comes from. There is no explicit create-cart endpoint, by design.

curl -s "https://apigw.ipxo.com/ecommerce/public/TENANT_UUID/cart" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

{ "data": { "uuid": "CART_UUID", "total": { … }, "sub_total": { … }, "tax_total": { … },
            "credits_total": { … }, "discount_total": { … }, "remaining_total": { … },
            "tax_breakdown": [ … ], "discount_breakdown": [ … ], "expires_at": "…" } }

curl -s -X POST "https://apigw.ipxo.com/ecommerce/public/TENANT_UUID/cart/CART_UUID/lines" \
  -H "Authorization: Bearer $ACCESS_TOKEN" -H "Content-Type: application/json" \
  -d '{ "price_id": "PRICE_UUID", "quantity": 1 }'

200Returns the created cart line — uuid, title, quantity, unit_price, sub_total, tax_total, total, billing period (from backend source).

curl -s -X POST "https://apigw.ipxo.com/ecommerce/public/TENANT_UUID/cart/CART_UUID/addresses/ADDRESS_ID" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

200Returns the associated address (same AddressResource shape as step 3) — from backend source.

curl -s -X PATCH "https://apigw.ipxo.com/ecommerce/public/TENANT_UUID/cart/CART_UUID/payment-method/PAYMENT_METHOD_UUID" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

200Returns the updated cart with recalculated totals (from backend source).

Checkout

Charges the selected payment method, creates the order and invoice, and consumes the cart. Gateway processing fees appear as separate order lines.

curl -s -X POST "https://apigw.ipxo.com/ecommerce/public/TENANT_UUID/cart/CART_UUID/checkout" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

{ "data": {
    "order": { "uuid": "ORDER_UUID", "status": "…", "placed_at": "…", "expires_at": "…",
               "sub_total": { … }, "tax_total": { … }, "total": { … }, "remaining_total": { … } },
    "data": <payment-gateway response, null when fully covered by credits>
} }

The order.uuid here is what you use with the orders endpoints below.

Confirm the lease is active

Your new lease appears as a billing service with status: "active" and the serviceUUID you'll use for LOAs and termination.

curl -s "https://apigw.ipxo.com/billing/v1/TENANT_UUID/market/ipv4/services" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

{
  "data": [{
    "billing_service": {
      "address": "68.164.7.0", "cidr": 24,
      "recurring_amount": 115, "status": "active",
      "next_due_date": 1775088000,
      "uuid": "a0f616fb-e93c-4371-b75c-c16ad8483a44",
      "pricing": { "uuid": "a0222aaf-5e33-4903-bccd-80f171c81ba4", "wants_to_negotiate": false }
    },
    "loa": [{ "uuid": "a0fff148-29a1-4d52-9c2a-43a860bd9e2c", "asn": 213060,
              "as_name": "IPXO-Testing-ASN", "status": "Active" }],
    "market_service": { "expires_at": null, "registry": "arin",
                        "uuid": "a0222aaf-3da0-41a5-ac6f-15e256f3e2e0" }
  }]
}

Check the ASN is clean

curl -s "https://apigw.ipxo.com/billing/v1/common/asn/validate/13335" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

{
  "asn": 13335, "valid": true,
  "as_name": "CLOUDFLARENET - Cloudflare, Inc.",
  "uce3": false, "ofac": false, "spamhaus": false,
  "country": "US", "status": "active"
}

Validate the subnet–ASN pair

Checks route-origin authorization, RPKI validity, and registry records before an LOA is generated.

curl -s -X POST "https://apigw.ipxo.com/billing/v1/TENANT_UUID/asn/validate/213060" \
  -H "Authorization: Bearer $ACCESS_TOKEN" -H "Content-Type: application/json" \
  -d '{ "subnets": ["68.164.7.0/24"] }'

{ "asn": 213060, "valid": true, "as_name": "…", "country": "…",
  "ofac": false, "spamhaus": false, "uce3": false, "status": "active",
  "subnets": [ { "subnet": "68.164.7.0/24", "already_added": false } ] }

Unknown ASN → 404.

List and download LOAs

curl -s "https://apigw.ipxo.com/billing/v1/TENANT_UUID/market/ipv4/services/SERVICE_UUID/loa" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

{
  "data": [{
    "uuid": "a0fff148-29a1-4d52-9c2a-43a860bd9e2c",
    "asn": 213060,
    "as_name": "IPXO-Testing-ASN Internet Utilities Europe and Asia Limited",
    "status": "Active",
    "created_at": 1770211251
  }],
  "meta": { "current_page": 1, "from": 1, "last_page": 1, "per_page": 15, "to": 1, "total": 1 }
}

curl -s "https://apigw.ipxo.com/billing/v1/TENANT_UUID/market/ipv4/services/SERVICE_UUID/loa/download" \
  -H "Authorization: Bearer $ACCESS_TOKEN" -o loa-documents.zip

200Binary application/zip archive of LOA PDFs.

Revoke LOAs when re-homing (as needed)

Bulk-revokes LOAs across subnets. After revocation the previous ASN authorization is invalid — generate new LOAs before re-announcing.

curl -s -X POST "https://apigw.ipxo.com/billing/v1/TENANT_UUID/market/ipv4/services/loa/revoke" \
  -H "Authorization: Bearer $ACCESS_TOKEN" -H "Content-Type: application/json" \
  -d '{ "services_uuids": ["SERVICE_UUID"] }'

200Empty (null) body. The body field is services_uuids[] — the service UUIDs whose LOAs to revoke (from backend source).

Inspect a single lease

curl -s "https://apigw.ipxo.com/billing/v1/TENANT_UUID/market/ipv4/services/SERVICE_UUID" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

{
  "billing_service": {
    "address": "68.164.7.0", "cidr": 24,
    "recurring_amount": 115, "status": "active",
    "start_date": 1769731200,
    "uuid": "a0f616fb-e93c-4371-b75c-c16ad8483a44",
    "ecommerce_subscription_uuid": "a0f61706-f2a4-45d3-8fcb-842da1541566"
  },
  "commitment": null,
  "pending_commitment": null,
  "market_service": { "expires_at": null, "registry": "arin",
                      "uuid": "a0222aaf-3da0-41a5-ac6f-15e256f3e2e0" },
  "termination_request": null
}

Geolocation often differs by provider — check all six transparently:

curl -s "https://apigw.ipxo.com/billing/v1/TENANT_UUID/market/ipv4/services/SERVICE_UUID/geodata" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

{
  "data": {
    "maxmind":     { "country_code": "US", "country_name": "United States", "state": "", "city_name": "" },
    "ipinfo":      { "country_code": "US", "country_name": "United States", "state": "Illinois",   "city_name": "Chicago" },
    "ip2location": { "country_code": "US", "country_name": "United States of America", "state": "Virginia", "city_name": "McLean" },
    "dbip":        { "country_code": "US", "country_name": "United States", "state": "California", "city_name": "San Jose" }
  }
}

Export your portfolio to CSV

curl -s "https://apigw.ipxo.com/billing/v1/TENANT_UUID/market/ipv4/csv" \
  -H "Authorization: Bearer $ACCESS_TOKEN" -o leases.csv

200text/csv file: subnet address, CIDR, status, billing amounts, service dates.

Terminate at end of billing cycle (default)

End-of-cycle termination goes through the subscription, not the billing service. The lease stays active until the cycle ends, then terminates. Find the subscription first:

curl -s -X POST "https://apigw.ipxo.com/ecommerce/public/TENANT_UUID/subscriptions/search" \
  -H "Authorization: Bearer $ACCESS_TOKEN" -H "Content-Type: application/json" \
  -d '{ "filter": { "status": "active" }, "per_page": "100" }'

curl -s -X POST "https://apigw.ipxo.com/ecommerce/public/TENANT_UUID/subscriptions/SUBSCRIPTION_UUID/terminate" \
  -H "Authorization: Bearer $ACCESS_TOKEN" -H "Content-Type: application/json" \
  -d '{ "type": "end_of_period", "reason": "Pricing", "details": "Cancellation reason" }'

200Creates a pending termination request; cancellable via /subscriptions/termination-requests/{uuid}/cancel until the period ends. (The former …/services/{serviceUUID}/terminate_request endpoint was removed from the gateway.)

Terminate immediately (exceptional cases)

Immediate termination requires a valid reason UUID — fetch the list first.

curl -s "https://apigw.ipxo.com/billing/v1/common/termination-reasons" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

{
  "data": [
    { "uuid": "86ee68ff-bead-462f-ad51-8c38225c6f61", "title": "Unauthorized 3rd party announcement" },
    { "uuid": "6a5abe4a-d8ac-4398-94c8-d94ca3c72bc3", "title": "The Subnet has been added to significant blocklist databases, such as Barracuda, Spamhaus, Spamcop, etc." },
    { "uuid": "84a4e2b8-8708-4fea-9c57-1b157a121389", "title": "ROA (Route Origin Authorization) is not generated within 48 hours after the assignment date." }
  ]
}

curl -s -X POST "https://apigw.ipxo.com/billing/v1/TENANT_UUID/market/ipv4/services/SERVICE_UUID/immediate-termination" \
  -H "Authorization: Bearer $ACCESS_TOKEN" -H "Content-Type: application/json" \
  -d '{ "reason_uuid": "86ee68ff-bead-462f-ad51-8c38225c6f61" }'

200Returns { "status": "SUCCESS" }; the subnet enters quarantine (from backend source).

Check your credit balance

curl -s "https://apigw.ipxo.com/credits/public/TENANT_UUID/balances?filter%5Bcurrency%5D=USD" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

{
  "data": [{
    "available_balance": 9274.14,
    "total_balance": 9274.14,
    "currency": "USD",
    "updated_at": "2026-03-02T05:46:24+00:00"
  }]
}

Review orders and transactions

curl -s "https://apigw.ipxo.com/ecommerce/public/TENANT_UUID/orders?filter%5Bstatus%5D=completed" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

{
  "data": [{
    "uuid": "a0f616f9-6c9c-4d08-9176-3eae6a2a1d7e",
    "status": "completed",
    "placed_at": "2026-01-30T15:47:58+00:00",
    "sub_total": { "currency": "USD", "amount": "119.60", "amount_minor": 11960 },
    "total":     { "currency": "USD", "amount": "119.60", "amount_minor": 11960 },
    "remaining_total": { "currency": "USD", "amount": "0.00", "amount_minor": 0 }
  }]
}

Drill into a specific order — line items via …/orders/{uuid}/lines (gateway fees appear as separate lines), payments via:

curl -s "https://apigw.ipxo.com/ecommerce/public/TENANT_UUID/orders/ORDER_UUID/transactions" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

{
  "data": [{
    "uuid": "a0f616f9-bc48-4dd9-be48-dd76c8a9f067",
    "type": "charge", "status": "completed",
    "gateway_driver": "stripe",
    "amount": { "currency": "USD", "amount": "119.60", "amount_minor": 11960 },
    "reference": "pi_3SvJvPEZwbJqxJ4z1HprQUmp",
    "created_at": "2026-01-30T15:47:58+00:00"
  }],
  "meta": { "current_page": 1, "total": 1, "per_page": 10 }
}

Recover a failed payment

Swap the payment method on the pending order:

curl -s -X PATCH "https://apigw.ipxo.com/ecommerce/public/TENANT_UUID/orders/ORDER_UUID/payment-methods/PAYMENT_METHOD_UUID" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

204Payment method updated on the order. No response body.

Then re-run payment:

curl -s -X POST "https://apigw.ipxo.com/ecommerce/public/TENANT_UUID/orders/ORDER_UUID/checkout" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

200Same shape as cart checkout — { "data": { "order": { uuid, status, totals… } } } plus the payment-gateway response (from backend source).

Fetch invoices and PDFs — from both systems

curl -s "https://apigw.ipxo.com/ecommerce/public/TENANT_UUID/invoices?sort=-placed_at&filter%5Bstatus%5D=paid" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

{
  "data": [{
    "uuid": "a0f61705-0fad-4a80-b132-fe3554a6145a",
    "reference": "C4E00DCB-000001",
    "status": "paid",
    "placed_at": "2026-01-30T15:48:06+00:00",
    "sub_total": { "currency": "USD", "amount": "115.00", "amount_minor": 11500 },
    "total":     { "currency": "USD", "amount": "115.00", "amount_minor": 11500 },
    "invoicable_id": "a0f616f9-6c9c-4d08-9176-3eae6a2a1d7e",
    "invoicable_type": "order"
  }]
}

Line items via …/invoices/{uuid}/lines; the PDF via …/invoices/{uuid}/download. Billing-system invoices (marketplace charges) live separately:

# billing-system invoices: single PDF or all-in-one export
curl -s "https://apigw.ipxo.com/billing/v1/TENANT_UUID/invoices/INVOICE_UUID/pdf" \
  -H "Authorization: Bearer $ACCESS_TOKEN" -o billing-invoice.pdf
curl -s "https://apigw.ipxo.com/billing/v1/TENANT_UUID/invoices/export/pdf" \
  -H "Authorization: Bearer $ACCESS_TOKEN" -o all-invoices.pdf

200Binary application/pdf file(s).

Check the prefix is eligible

curl -s -X POST "https://apigw.ipxo.com/billing/v1/common/market/subnetValidity" \
  -H "Authorization: Bearer $ACCESS_TOKEN" -H "Content-Type: application/json" \
  -d '{ "prefixes": ["68.164.7.0/24"] }'

[{
  "address": "68.164.7.0", "cidr": 24,
  "status": true, "message": "",
  "minimum_split": 24, "maximum_split": 24,
  "registry": "arin"
}]

Understand commission before pricing

Minimum commission, minimum per-IP price, and commission factor per CIDR size — price the listing above the floor.

curl -s "https://apigw.ipxo.com/billing/v1/common/pricing/commissions" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

{
  "configuration": { "commission": {
    "24": { "min_commission": 9,    "min_ip_price": 0.035, "commission_factor": 0.15 },
    "23": { "min_commission": 18,   "min_ip_price": 0.035, "commission_factor": 0.15 },
    "16": { "min_commission": 2294, "min_ip_price": 0.035, "commission_factor": 0.15 }
  } }
}

Create the monetization service

Lists the prefix on the marketplace and triggers an ownership-verification email. Body recovered from the backend validation (AddToMarketRequest::rules), 2026-07-22:

curl -s -X POST "https://apigw.ipxo.com/billing/v1/TENANT_UUID/market/services" \
  -H "Authorization: Bearer $ACCESS_TOKEN" -H "Content-Type: application/json" \
  -d '{
    "subnets": [{
      "address": "68.164.7.0", "cidr": 24, "registry": "arin",
      "minimum_split": 24, "maximum_split": 24,
      "pricings": [{ "cidr": 24, "value": 115, "wants_to_negotiate": false }]
    }],
    "tos_accepted": true,
    "subnet_actions_accepted": true
  }'

201Created — returns the service collection; verification email sent.

Verify ownership

curl -s "https://apigw.ipxo.com/billing/v1/common/market_auth_verify/VERIFICATION_TOKEN" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

200Service verified and activated. Body not documented in the spec.

Didn't get the email? POST /billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/resend_verification (200 = resent; only valid while the service is pending verification).

Confirm the listing is healthy

One report covering operational state, ownership auth, WHOIS, BGP, DNS, IP reputation (blocklists), and the LOA-A. Note: despite the spec's description, there is no RPKI field in this response.

curl -s "https://apigw.ipxo.com/billing/v1/TENANT_UUID/market/services/MARKET_SERVICE_UUID/status" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

{ "abuse_email": "…", "registry": "arin", "status": "validity_active",
  "auth":  { "type": "…", "status": "…", "description": "…" },
  "whois": { "status": "…", "description": "…" },
  "bgp":   { "status": "…", "description": "…" },
  "dns":   { "status": "…", "description": "…" },
  "iprep": { "status": "…", "description": "…" },
  "loaa":  { "status": "…", "description": "…" } }

Top-level status values: auth_pending, auth_failed_verify(±email variants), validity_pending, validity_active, validity_invalid, validity_terminated, object_terminated.

Check what lessees will see with GET …/{ipmarketServiceUUID}/pricing (200; per-IP/per-subnet price, billing cycles, negotiability).

Update pricing or terms

Partial update — every field optional (from backend source): hidden, minimum_split/maximum_split (8–24), pricings[] (include a pricing's uuid to update it; each entry needs cidr + value, optional wants_to_negotiate + selected_commitment_periods[]), maintainer_id/maintainer_password. Only allowed while the service is in auth-pending or validity states. See lessee-facing pricing via GET …/pricing, and what active lessees currently pay via GET …/leased.

200Returns the updated service resource (from backend source).

Control child-subnet visibility

curl -s "https://apigw.ipxo.com/billing/v1/TENANT_UUID/market/ipv4/child/search?address=68.164.7.0&cidr=24&market_service_uuid=MARKET_SERVICE_UUID" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

200Available child sub-allocations. Body shape not documented in the spec.

curl -s -X POST "https://apigw.ipxo.com/billing/v1/TENANT_UUID/market/ipv4/child/toggle" \
  -H "Authorization: Bearer $ACCESS_TOKEN" -H "Content-Type: application/json" \
  -d '{ "market_service_uuid": "MARKET_SERVICE_UUID", "children": [ … ] }'

200Visibility toggled. Body not documented in the spec.

Audit what's hidden: GET …/market/services/{uuid}/ipv4/hidden/children?page=1&per_page=25 — page and per_page are both required query params.

Audit every change with event logs

Unified audit trail across all your listings — activations, terminations, pricing updates, lease assignments. Per-service logs at …/market/services/{uuid}/event_logs; full portfolio export at …/market/services/csv.

curl -s "https://apigw.ipxo.com/billing/v1/TENANT_UUID/market/services/event_logs" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

200Paginated { data, meta }; each entry (from backend source): label, type (pricing_updated | pricing_created | leased | released | created), data payload, created_at unix timestamp. No actor field.

Extend or retire a listing

Cancels a scheduled expiration so the listing keeps running.

200Expiration cancelled; service continues.

To take the prefix off the marketplace entirely, DELETE …/market/services/{ipmarketServiceUUID} (200 = cancellation initiated) — active leases may run until their cycle ends depending on the termination policy.

Set your payout method (once)

Bank transfer, PayPal, or platform credits. GET on the same path shows the current configuration — a 404 means none is configured yet.

curl -s -X PUT "https://apigw.ipxo.com/billing/v1/TENANT_UUID/market/payoutmethod" \
  -H "Authorization: Bearer $ACCESS_TOKEN" -H "Content-Type: application/json" \
  -d '{ "type": "paypal", "cycle": 1, "details": { "email": "[email protected]" } }'

200Returns the payout-method resource (from backend source).

Track earnings

Total sales, net payout after commission, and a per-period breakdown (prefer v2 over v1). CSV twin: GET …/stats/v2/export.

curl -s "https://apigw.ipxo.com/billing/v1/TENANT_UUID/market/payouts/stats/v2" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

{
  "period": { "from": null, "to": null },
  "total_sales": 0,
  "total_net_payout": 0,
  "data": []
}

Individual payouts with status and self-billing invoice reference: GET …/market/payouts (paginated { data, meta }); single payout detail at …/market/payouts/{payoutUuid}.

Pull self-billing invoices for accounting

IPXO issues these on your behalf each payout period.

curl -s "https://apigw.ipxo.com/billing/v1/TENANT_UUID/market/payouts_invoices" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

200Paginated envelope { "data": […], "meta": { current_page, last_page, per_page, total } }.

Payment receipts (issued when IPXO sends the money): GET …/market/payment_confirmations, each with a /pdf.

Reconcile commission deductions

Marketplace fees charged against earnings — amount, associated service, billing period.

curl -s "https://apigw.ipxo.com/billing/v1/TENANT_UUID/market/deductions" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

200Paginated envelope { "data": […], "meta": … }. Invoice PDFs at …/market/deductions/invoices/{invoiceUUID}/pdf.

Search prefixes with field selection

curl -s -X POST "https://apigw.ipxo.com/nethub-data/TENANT_UUID/prefixes/search" \
  -H "Authorization: Bearer $ACCESS_TOKEN" -H "Content-Type: application/json" \
  -d '{
    "fields": ["geodata", "whois.inetnum", "whois.organisation", "whois.country"],
    "geodata": { "field": "countryCode", "op": "eq", "vals": ["US"] },
    "limit": 50, "offset": 0
  }'

{
  "data": [{
    "notation": "185.139.0.0/22", "maskSize": 22,
    "internalMetadata": {
      "master": true,
      "holder": { "tenantUUID": "c4a84238-3a89-43f0-8a83-8d5edc9c8c65",
                  "organisation": "ORG-CAF4-RIPE" }
    },
    "geodata": [
      { "provider": "dbip",    "countryCode": "DE", "cityName": "Frankfurt am Main" },
      { "provider": "maxmind", "countryCode": "DE", "cityName": "Frankfurt am Main" }
    ],
    "whois": { "inetnum": "185.139.0.0/22", "registrar": "ripencc",
               "netname": "AE-CYBERASSETS-20160216", "country": "AE",
               "organisation": "ORG-CAF4-RIPE" }
  }],
  "metadata": { "limit": 50, "offset": 0 }
}

Tag a single prefix

curl -s -X PATCH "https://apigw.ipxo.com/nethub-data/TENANT_UUID/prefixes/185.139.0.0%2F22/metadata" \
  -H "Authorization: Bearer $ACCESS_TOKEN" -H "Content-Type: application/json" \
  -d '{ "projectID": "proj-12345", "label": "CDN Edge Range", "region": "EU-WEST" }'

200Metadata set on the prefix holder. No response body documented.

Bulk-tag by organisation, and manage list-valued tags

curl -s -X PATCH "https://apigw.ipxo.com/nethub-data/TENANT_UUID/prefixes/metadata" \
  -H "Authorization: Bearer $ACCESS_TOKEN" -H "Content-Type: application/json" \
  -d '[{ "organisation": "ORG-CAF4-RIPE",
         "metadata": { "projectID": "proj-12345", "label": "Production Ranges" } }]'

200Metadata set on the specified holders. No response body documented.

For multi-valued fields (tags, contacts), use the …/metadata/array endpoints — POST appends (field, value), PATCH replaces by value (old_value → new_value), DELETE removes:

curl -s -X POST "https://apigw.ipxo.com/nethub-data/TENANT_UUID/prefixes/metadata/array" \
  -H "Authorization: Bearer $ACCESS_TOKEN" -H "Content-Type: application/json" \
  -d '[{ "organisation": "ORG-CAF4-RIPE", "field": "tags", "value": "production" }]'

200Elements appended to the metadata arrays. Single-prefix variants exist at …/prefixes/{notation}/metadata/array.

Track bulk jobs and cloud integrations

Bulk imports and mass updates run asynchronously as batches with status and progress.

200Paginated envelope { "data": […], "meta": … } of batch operations.

AWS BYOIP connected accounts (for provisioning leased subnets into EC2/ELB): GET /billing/v1/{tenantUUID}/integrations/aws/connected-accounts → 200 with { "data": […] }, empty if none configured.

Review reputation scan history

Scan history against Spamhaus, Barracuda, and other blocklists / abuse databases — the deliverability health signal for monetized space.

curl -s "https://apigw.ipxo.com/billing/v1/TENANT_UUID/market/services/MARKET_SERVICE_UUID/reputations" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

{ "data": [ { "id": "…", "ip": "…", "ip_int": …, "country_code": "…",
    "detection_rate": …, "detections": …, "detections_engine_list": [ … ],
    "engines_count": …, "is_listed": false, "is_proxy": false, "is_tor": false,
    "is_vpn": false, "isp": "…", "session_id": "…", "created": 1769731200 } ],
  "meta": { … } }

Diagnose announcement issues

The same status report used at listing time doubles as the diagnostic when BGP, WHOIS, DNS, or reputation drift out of shape.

200Shape shown under List a prefix step 5 — auth / whois / bgp / dns / iprep / loaa sub-objects; no RPKI field (from backend source).

Read market supply and pricing

Free vs in-use counts and min/max/avg per-IP pricing by mask size — market intelligence for pricing decisions.

curl -s "https://apigw.ipxo.com/billing/v1/common/market/subnetUsage" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

[
  { "mask": 24, "free": 15430, "in_use": 1250,
    "price_min": 0.15, "price_max": 2.50, "price_avg": 0.45,
    "period": "2025-07-01 00:00:00" }
]

Supported registries with their UUIDs (used in search results): GET /billing/v1/common/market/registrars → 200, e.g. [{ "uuid": "6220a691…", "name": "arin" }, { "name": "ripencc" }, …].

Create and inspect the tenant

Creates the tenant and returns the UUID used in every subsequent call. Required fields (from backend source): title, email, address1, city, country (alpha-2), postcode, state, abuse_email, industry_uuid, and options.website (https URL). Optional: company_size, business_since, vat_number, options.social_network[], prorata settings.

201Created — returns the tenant resource including its uuid (from backend source).

curl -s "https://apigw.ipxo.com/billing/v1/TENANT_UUID" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

{
  "uuid": "a0f5bdf6-499d-4679-9831-a9677abeed5c",
  "title": "Acme Corp",
  "email": "[email protected]",
  "address1": "123 Main St", "city": "New York", "postcode": "10001",
  "country": "US", "state": "New York",
  "status": "active",
  "abuse_email": "[email protected]",
  "industry": { "uuid": "cac34d86-00c5-11ec-87f1-cc8741ada327", "name": "Cloud Provider" },
  "credit": { "amount": 9274.14, "auto_payment": true },
  "flags": [
    { "slug": "uses_ecommerce_for_market" },
    { "slug": "is_lessee" }
  ],
  "email_verified": true,
  "abuse_email_verified": true
}

Update profile fields with PATCH /billing/v1/{tenantUUID} — only provided fields change (200 on success).

Get the at-a-glance numbers

curl -s "https://apigw.ipxo.com/billing/v1/TENANT_UUID/details" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

{ "monetizing_ips_count": 0, "renting_ips_count": 768, "code": null }

Reference data for forms and validation

Countries with phone codes, tenant availability, and OFAC flags (Billing system, paginated).

curl -s "https://apigw.ipxo.com/billing/v1/common/countries" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

{
  "data": [{
    "uuid": "75645c44-0554-4627-a032-e58508c5163b",
    "alpha_2_code": "AL", "alpha_3_code": "ALB",
    "name": "Albania", "phone_code": "+355",
    "tenant_availability": 1, "ofac_listed": 0
  }],
  "meta": { "current_page": 1, "last_page": 17, "per_page": 15, "total": 251 }
}

For address forms, Ecommerce has its own pair: GET /ecommerce/public/common/countries (name + alpha-2 code) and GET /ecommerce/public/common/countries/{country_code}/provinces (country_code path, required). Industry list for registration: GET /billing/v1/common/industries → { "data": [{ "uuid", "name": "Cloud Provider" }, …] }.