Subnets & LOA
27 operations
The object
API.Pub.Resources.IPMarket.IPMarketServiceResourceDeclared in the spec. Shown from GET /v1/{tenantUUID}/market/services/{ipmarketServiceUUID}.
Attributes
uuidNo description in the spec
addressNo description in the spec
cidrNo description in the spec
startNo description in the spec
abuse_emailNo description in the spec
registryNo description in the spec
statusNo description in the spec
auth_pending auth_failed_verify auth_failed_verify_email_not_found auth_failed_verify_email_not_sent validity_pending validity_active validity_invalid validity_terminatedauthNo description in the spec
auth.typeNo description in the spec
auth.statusNo description in the spec
auth.descriptionNo description in the spec
whoisNo description in the spec
whois.statusNo description in the spec
whois.descriptionNo description in the spec
bgpNo description in the spec
bgp.statusNo description in the spec
bgp.descriptionNo description in the spec
dnsNo description in the spec
dns.statusNo description in the spec
dns.descriptionNo description in the spec
iprepNo description in the spec
iprep.statusNo description in the spec
iprep.descriptionNo description in the spec
loaaNo description in the spec
loaa.statusNo description in the spec
loaa.descriptionNo description in the spec
roaNo description in the spec
roa.statusNo description in the spec
roa.descriptionNo description in the spec
hiddenNo description in the spec
reservation_idNo description in the spec
minimum_splitNo description in the spec
maximum_splitNo description in the spec
loa-aNo description in the spec
loa-a.emailNo description in the spec
loa-a.statusNo description in the spec
loa-a.created_atNo description in the spec
ipsNo description in the spec
ips.run_rateNo description in the spec
ips.run_rate_ipNo description in the spec
ips.totalNo description in the spec
ips.usedNo description in the spec
ips.freeNo description in the spec
ips.utilisation_percentNo description in the spec
pricingsNo description in the spec
pricings.dataNo description in the spec
pricings.metaNo description in the spec
terminatedNo description in the spec
expires_atNo description in the spec
has_commitmentsNo description in the spec
can_initiate_expirationNo description in the spec
servicesNo description in the spec
services.uuidNo description in the spec
services.cidrNo description in the spec
services.addressNo description in the spec
services.statusNo description in the spec
services.pricingNo description in the spec
services.commitmentNo description in the spec
commitmentReservationsNo description in the spec
commitmentReservations.uuidNo description in the spec
commitmentReservations.addressNo description in the spec
commitmentReservations.cidrNo description in the spec
commitmentReservations.priceNo description in the spec
commitmentReservations.commitment_periodNo description in the spec
commitmentReservations.created_atNo description in the spec
commitmentReservations.tenantNo description in the spec
commitmentReservations.ipmarket_serviceNo description in the spec
commitmentReservations.commitmentNo description in the spec
serviceReservationsNo description in the spec
serviceReservations.addressNo description in the spec
serviceReservations.cidrNo description in the spec
serviceReservations.pricingNo description in the spec
Search available to buy subnets
GET
/v1/{tenantUUID}/market/ipv4Returns available to buy subnets by given filters
Path parameters
tenantUUIDTenant UUID
Query parameters
cidrCIDR
registrar_uuids[]Array of Registrar UUIDs
reservation_idCommitment Reservation ID
limitLimit results to this number
sortSort. If prefixed with a dash, sorts descending
priceLook for subnets with exact price
price_minLook for subnets above or equal this price. Cannot be used if 'price' parameter is given
price_maxLook for subnets below or equal this price. Cannot be used if 'price' parameter is given
geo_databasesSpecify which databases to check for city/country filters
geo_country_codeSearch subnets by country code
geo_city_nameSearch subnets by city name
octetsSearch subnets by octets
registryRegistrar Name. Optional registrar_uuids or registry.
wants_to_negotiateSearch subnets by wants to negotiate
addressAddress
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4?cidr=' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4?cidr="
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4?cidr=";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4?cidr=", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4?cidr=");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Successful operation
"string"401
Unauthorized
403
Forbidden
404
Not Found
Search subnet child
GET
/v1/{tenantUUID}/market/ipv4/child/searchSearch subnet child
Path parameters
tenantUUIDTenant UUID
Query parameters
addressIPV4 child address
cidrIPV4 child cidr
market_service_uuidParent IPV4 ip market service uuid
Request body
addressNo description in the spec
maskNo description in the spec
is_hiddenNo description in the spec
is_reservedNo description in the spec
is_leasedNo description in the spec
priceNo description in the spec
is_part_of_subnet_leased_or_reservedNo description in the spec
hiding_reasonNo description in the spec
Response 200
addressNo description in the spec
maskNo description in the spec
is_hiddenNo description in the spec
is_reservedNo description in the spec
is_leasedNo description in the spec
priceNo description in the spec
is_part_of_subnet_leased_or_reservedNo description in the spec
hiding_reasonNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/child/search?address=&cidr=' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"address": "string",
"mask": 1,
"is_hidden": true,
"is_reserved": true,
"is_leased": true,
"price": 1.0,
"is_part_of_subnet_leased_or_reserved": true,
"hiding_reason": "string"
}'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/child/search?address=&cidr="
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = {
"address": "string",
"mask": 1,
"is_hidden": true,
"is_reserved": true,
"is_leased": true,
"price": 1.0,
"is_part_of_subnet_leased_or_reserved": true,
"hiding_reason": "string"
}
r = requests.get(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/child/search?address=&cidr=";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify({
"address": "string",
"mask": 1,
"is_hidden": true,
"is_reserved": true,
"is_leased": true,
"price": 1.0,
"is_part_of_subnet_leased_or_reserved": true,
"hiding_reason": "string"
}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"address": "string",
"mask": 1,
"is_hidden": true,
"is_reserved": true,
"is_leased": true,
"price": 1.0,
"is_part_of_subnet_leased_or_reserved": true,
"hiding_reason": "string"
}`)
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/child/search?address=&cidr=", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/child/search?address=&cidr=");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"address" => "string",
"mask" => 1,
"is_hidden" => true,
"is_reserved" => true,
"is_leased" => true,
"price" => 1.0,
"is_part_of_subnet_leased_or_reserved" => true,
"hiding_reason" => "string"
]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Billing Service
{
"address": "string",
"mask": 1,
"is_hidden": true,
"is_reserved": true,
"is_leased": true,
"price": 1.0,
"is_part_of_subnet_leased_or_reserved": true,
"hiding_reason": "string"
}401
Unauthorized
403
Forbidden
404
Not Found
422
Unprocessable Entity
Hide or unhide child subnets
POST
/v1/{tenantUUID}/market/ipv4/child/toggleHide or unhide child subnets
Path parameters
tenantUUIDTenant UUID
Request body
childsNo description in the spec
childs.addressNo description in the spec
market_service_uuidNo description in the spec
cidrNo description in the spec
reasonNo description in the spec
Response 200
batchIdThe ID of the batch
Request
curl -X POST 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/child/toggle' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"childs": [
{
"address": "string"
}
],
"market_service_uuid": "00000000-0000-0000-0000-000000000000",
"cidr": 1,
"reason": "string"
}'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/child/toggle"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = {
"childs": [
{
"address": "string"
}
],
"market_service_uuid": "00000000-0000-0000-0000-000000000000",
"cidr": 1,
"reason": "string"
}
r = requests.post(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/child/toggle";
const res = await fetch(url, {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify({
"childs": [
{
"address": "string"
}
],
"market_service_uuid": "00000000-0000-0000-0000-000000000000",
"cidr": 1,
"reason": "string"
}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"childs": [
{
"address": "string"
}
],
"market_service_uuid": "00000000-0000-0000-0000-000000000000",
"cidr": 1,
"reason": "string"
}`)
req, _ := http.NewRequest("POST", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/child/toggle", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/child/toggle");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"childs" => [[
"address" => "string"
]],
"market_service_uuid" => "00000000-0000-0000-0000-000000000000",
"cidr" => 1,
"reason" => "string"
]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Batch id
{
"batchId": "string"
}401
Unauthorized
403
Forbidden
404
Not Found
422
Unprocessable Entity
Export to CSV Tenant IPv4 Services
GET
/v1/{tenantUUID}/market/ipv4/csvExport to CSV Tenant IPv4 Services
Path parameters
tenantUUIDTenant UUID
Query parameters
uuidFilter By IPv4 Service UUID
addressFilter By IPv4 Service Address
cidrFilter by IPv4 Service CIDR
registryFilter by IPv4 Service Registry
sortSort By Key
pageList Page
per_pageItems Per Page
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/csv' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/csv"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/csv";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/csv", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/csv");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
IPv4 Services Collection
400
Invalid Request
401
Unauthorized
403
Forbidden
List Tenant IPv4 Services
GET
/v1/{tenantUUID}/market/ipv4/servicesList Tenant IPv4 Services
Path parameters
tenantUUIDTenant UUID
Query parameters
uuidFilter By IPv4 Service UUID
addressFilter By IPv4 Service Address
cidrFilter by IPv4 Service CIDR
registryFilter by IPv4 Service Registry
statusSearch by Subnet status
displaySearch by Subnet Display status
sortSort By Key
directionSorting direction
asnFilter by asn
pageList Page
per_pageItems Per Page
Response 200
billing_serviceNo description in the spec
billing_service.addressNo description in the spec
billing_service.cidrNo description in the spec
billing_service.next_due_dateNo description in the spec
billing_service.recurring_amountNo description in the spec
billing_service.statusNo description in the spec
billing_service.pricingNo description in the spec
billing_service.pricing.typeNo description in the spec
billing_service.pricing.x-truncatedNo description in the spec
billing_service.uuidNo description in the spec
billing_service.ecommerce_subscription_uuidNo description in the spec
loalist of LOA documents
loa.dataNo description in the spec
market_serviceNo description in the spec
market_service.expires_atNo description in the spec
market_service.registryNo description in the spec
market_service.uuidNo description in the spec
ecommerce_subscription_uuidNo description in the spec
ecommerce_pending_orderNo description in the spec
ecommerce_pending_order.uuidNo description in the spec
ecommerce_pending_order.statusNo description in the spec
ecommerce_pending_order.expires_atNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/services' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/services"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/services";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/services", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/services");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
IPv4 Services Collection
{
"billing_service": {
"address": "string",
"cidr": 1,
"next_due_date": 1.0,
"recurring_amount": 1.0,
"status": {
"type": "object",
"x-truncated": true
},
"pricing": {
"type": "string",
"x-truncated": "string"
},
"uuid": "00000000-0000-0000-0000-000000000000",
"ecommerce_subscription_uuid": "00000000-0000-0000-0000-000000000000"
},
"loa": [
{
"data": "string"
}
],
"market_service": {
"expires_at": 1.0,
"registry": "string",
"uuid": "00000000-0000-0000-0000-000000000000"
},
"ecommerce_subscription_uuid": "00000000-0000-0000-0000-000000000000",
"ecommerce_pending_order": {
"uuid": {},
"status": {},
"expires_at": {}
}
}400
Invalid Request
401
Unauthorized
403
Forbidden
Revoke LOA documents for multiple subnets
POST
/v1/{tenantUUID}/market/ipv4/services/loa/revokeRevoke LOA documents for multiple subnets
Path parameters
tenantUUIDTenant UUID
Request
curl -X POST 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/services/loa/revoke' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/services/loa/revoke"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.post(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/services/loa/revoke";
const res = await fetch(url, {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("POST", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/services/loa/revoke", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/services/loa/revoke");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
OK
401
Unauthorized
403
Forbidden
404
Not Found
Reserve Subnet
POST
/v1/{tenantUUID}/market/ipv4/services/reserveReserve Subnet
Path parameters
tenantUUIDTenant UUID
Request body
pricing_uuidNo description in the spec
addressNo description in the spec
cidrNo description in the spec
ip_priceNo description in the spec
contract_lengthNo description in the spec
Request
curl -X POST 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/services/reserve' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"pricing_uuid": "00000000-0000-0000-0000-000000000000",
"address": "string",
"cidr": 1,
"ip_price": "string",
"contract_length": 1
}'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/services/reserve"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = {
"pricing_uuid": "00000000-0000-0000-0000-000000000000",
"address": "string",
"cidr": 1,
"ip_price": "string",
"contract_length": 1
}
r = requests.post(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/services/reserve";
const res = await fetch(url, {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify({
"pricing_uuid": "00000000-0000-0000-0000-000000000000",
"address": "string",
"cidr": 1,
"ip_price": "string",
"contract_length": 1
}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"pricing_uuid": "00000000-0000-0000-0000-000000000000",
"address": "string",
"cidr": 1,
"ip_price": "string",
"contract_length": 1
}`)
req, _ := http.NewRequest("POST", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/services/reserve", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/services/reserve");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"pricing_uuid" => "00000000-0000-0000-0000-000000000000",
"address" => "string",
"cidr" => 1,
"ip_price" => "string",
"contract_length" => 1
]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Success
400
Invalid Request
401
Unauthorized
403
Forbidden
404
Not Found
Billing Terminate Request
GET
/v1/{tenantUUID}/market/ipv4/services/{serviceUUID}Billing Terminate Request
Path parameters
tenantUUIDTenant UUID
serviceUUIDService UUID
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/services/{serviceUUID}' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/services/{serviceUUID}"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/services/{serviceUUID}";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/services/{serviceUUID}", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/services/{serviceUUID}");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Success
400
Invalid Request
401
Unauthorized
403
Forbidden
404
Not Found
IPv4 Service Geodata
GET
/v1/{tenantUUID}/market/ipv4/services/{serviceUUID}/geodataIPv4 Service Geodata
Path parameters
tenantUUIDTenant UUID
serviceUUIDService UUID
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/services/{serviceUUID}/geodata' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/services/{serviceUUID}/geodata"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/services/{serviceUUID}/geodata";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/services/{serviceUUID}/geodata", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/services/{serviceUUID}/geodata");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Success
400
Invalid Request
401
Unauthorized
403
Forbidden
404
Not Found
Immediate termination request for IPv4 Service
POST
/v1/{tenantUUID}/market/ipv4/services/{serviceUUID}/immediate-terminationImmediate termination request for IPv4 Service
Path parameters
tenantUUIDTenant UUID
serviceUUIDService UUID
Request body
descriptionTermination reason description
use_againNo description in the spec
reasonNo description in the spec
Request
curl -X POST 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/services/{serviceUUID}/immediate-termination' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"description": "string",
"use_again": true,
"reason": "00000000-0000-0000-0000-000000000000"
}'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/services/{serviceUUID}/immediate-termination"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = {
"description": "string",
"use_again": true,
"reason": "00000000-0000-0000-0000-000000000000"
}
r = requests.post(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/services/{serviceUUID}/immediate-termination";
const res = await fetch(url, {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify({
"description": "string",
"use_again": true,
"reason": "00000000-0000-0000-0000-000000000000"
}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"description": "string",
"use_again": true,
"reason": "00000000-0000-0000-0000-000000000000"
}`)
req, _ := http.NewRequest("POST", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/services/{serviceUUID}/immediate-termination", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/services/{serviceUUID}/immediate-termination");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"description" => "string",
"use_again" => true,
"reason" => "00000000-0000-0000-0000-000000000000"
]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Success
401
Unauthorized
403
Forbidden
404
Not Found
List of Billing Service LOA documents
GET
/v1/{tenantUUID}/market/ipv4/services/{serviceUUID}/loaList of Billing Service LOA documents
Path parameters
tenantUUIDTenant UUID
serviceUUIDService UUID
Query parameters
statusesFilter By LOA Document Statuses
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.asnNo description in the spec
data.as_nameNo description in the spec
data.statusNo description in the spec
data.created_atNo description in the spec
metaNo description in the spec
meta.current_pageNo description in the spec
meta.fromNo description in the spec
meta.last_pageNo description in the spec
meta.per_pageNo description in the spec
meta.toNo description in the spec
meta.totalNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/services/{serviceUUID}/loa' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/services/{serviceUUID}/loa"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/services/{serviceUUID}/loa";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/services/{serviceUUID}/loa", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/services/{serviceUUID}/loa");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
List of Billing Service LOA documents
{
"data": [
{
"uuid": "00000000-0000-0000-0000-000000000000",
"asn": 1.0,
"as_name": "string",
"status": "string",
"created_at": 1.0
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 1,
"to": 1,
"total": 1
}
}400
Invalid Request
401
Unauthorized
403
Forbidden
Get LOA documents Zip
GET
/v1/{tenantUUID}/market/ipv4/services/{serviceUUID}/loa/downloadGet LOA documents Zip
Path parameters
tenantUUIDTenant UUID
serviceUUIDService UUID
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/services/{serviceUUID}/loa/download' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/services/{serviceUUID}/loa/download"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/services/{serviceUUID}/loa/download";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/services/{serviceUUID}/loa/download", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/services/{serviceUUID}/loa/download");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
LOA Documents
204
No Content
401
Unauthorized
403
Forbidden
404
Not Found
Search available subnets
GET
/v1/{tenantUUID}/market/searchReturns available subnets by given filters
Path parameters
tenantUUIDTenant UUID
Query parameters
prefix_lengthPrefix Length
reservation_idCommitment Reservation ID
limitLimit results to this number
octetsSearch subnets by octets
addressAddress
registrarsRegistrar Name. Optional registrar_uuids or registry.
sortSort. If prefixed with a dash, sorts descending
geo_providersGeolocation providers to use for country/city filters
geo_country_codeGeolocation filter by country code
geo_city_nameGeolocation filter by city name
geo_provider_match_typeMatch type for geo filter
price_minPrice filter (min)
price_maxPrice filter (max)
price_negotiablePrice filter for if price is negotiable
capabilities_rpkiSubnet RPKI Capability status
capabilities_whois_inetnumSubnet WHOIS Inetnum Capability status
capabilities_whois_routesSubnet WHOIS Routes Capability status
capabilities_whois_rdnsSubnet WHOIS RDNS Capability status
promotionalFilter for promotional/featured subnets
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/search?prefix_length=' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/search?prefix_length="
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/search?prefix_length=";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/search?prefix_length=", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/search?prefix_length=");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Successful operation
"string"401
Unauthorized
403
Forbidden
404
Not Found
List IP Market Services
GET
/v1/{tenantUUID}/market/servicesList IP Market Services
Path parameters
tenantUUIDTenant UUID
Query parameters
includeNo description in the spec
sortSort
filterFilters
Request body
cidrCIDR
addressIP Address
hiddenShow only Subnets hidden from market
statusNo description in the spec
registryRegistry
sortNo description in the spec
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.addressNo description in the spec
data.cidrNo description in the spec
data.startNo description in the spec
data.abuse_emailNo description in the spec
data.registryNo description in the spec
data.statusNo description in the spec
data.authNo description in the spec
data.auth.typeNo description in the spec
data.auth.x-truncatedNo description in the spec
data.whoisNo description in the spec
data.whois.typeNo description in the spec
data.whois.x-truncatedNo description in the spec
data.bgpNo description in the spec
data.bgp.typeNo description in the spec
data.bgp.x-truncatedNo description in the spec
data.dnsNo description in the spec
data.dns.typeNo description in the spec
data.dns.x-truncatedNo description in the spec
data.iprepNo description in the spec
data.iprep.typeNo description in the spec
data.iprep.x-truncatedNo description in the spec
data.loaaNo description in the spec
data.loaa.typeNo description in the spec
data.loaa.x-truncatedNo description in the spec
data.roaNo description in the spec
data.roa.typeNo description in the spec
data.roa.x-truncatedNo description in the spec
data.hiddenNo description in the spec
data.reservation_idNo description in the spec
data.minimum_splitNo description in the spec
data.maximum_splitNo description in the spec
data.loa-aNo description in the spec
data.ipsNo description in the spec
data.pricingsNo description in the spec
data.terminatedNo description in the spec
data.expires_atNo description in the spec
data.has_commitmentsNo description in the spec
data.can_initiate_expirationNo description in the spec
data.servicesNo description in the spec
data.commitmentReservationsNo description in the spec
data.serviceReservationsNo description in the spec
metaNo description in the spec
meta.current_pageNo description in the spec
meta.fromNo description in the spec
meta.last_pageNo description in the spec
meta.per_pageNo description in the spec
meta.toNo description in the spec
meta.totalNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"cidr": 1,
"address": "string",
"hidden": true,
"status": [
"auth_pending"
],
"registry": "string",
"sort": [
"cidr"
]
}'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = {
"cidr": 1,
"address": "string",
"hidden": true,
"status": [
"auth_pending"
],
"registry": "string",
"sort": [
"cidr"
]
}
r = requests.get(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify({
"cidr": 1,
"address": "string",
"hidden": true,
"status": [
"auth_pending"
],
"registry": "string",
"sort": [
"cidr"
]
}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"cidr": 1,
"address": "string",
"hidden": true,
"status": [
"auth_pending"
],
"registry": "string",
"sort": [
"cidr"
]
}`)
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"cidr" => 1,
"address" => "string",
"hidden" => true,
"status" => ["auth_pending"],
"registry" => "string",
"sort" => ["cidr"]
]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
IP Market Service
{
"data": [
{
"uuid": "00000000-0000-0000-0000-000000000000",
"address": "string",
"cidr": "string",
"start": "string",
"abuse_email": "[email protected]",
"registry": "string",
"status": "string",
"auth": {
"type": "string",
"x-truncated": "string"
}
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 1,
"to": 1,
"total": 1
}
}400
Invalid Request
401
Unauthorized
403
Forbidden
Create IP Market Service
POST
/v1/{tenantUUID}/market/servicesCreates and returns IP Market Service
Path parameters
tenantUUIDTenant UUID
Request body
subnetsNo description in the spec
subnets.addressSubnet Address
subnets.cidrSubnet CIDR
subnets.minimum_splitNo description in the spec
subnets.maximum_splitNo description in the spec
subnets.pricingslist of allowed to purchase CIDR pricings. Example: {'/30': 3.21, '/32': 1.23}
subnets.pricings.cidrNo description in the spec
subnets.pricings.valueNo description in the spec
subnets.pricings.wants_to_negotiateNo description in the spec
subnets.pricings.selected_commitment_periodsNo description in the spec
subnets.hiddenNo description in the spec
subnets.maintainer_idAPNIC maintainer ID
subnets.maintainer_passwordAPNIC maintainer password
subnets.registryRegistry name, e.g. apnic
tos_acceptedNo description in the spec
subnet_actions_acceptedNo description in the spec
Response 201
dataNo description in the spec
data.uuidNo description in the spec
data.addressNo description in the spec
data.cidrNo description in the spec
data.startNo description in the spec
data.abuse_emailNo description in the spec
data.registryNo description in the spec
data.statusNo description in the spec
data.authNo description in the spec
data.auth.typeNo description in the spec
data.auth.x-truncatedNo description in the spec
data.whoisNo description in the spec
data.whois.typeNo description in the spec
data.whois.x-truncatedNo description in the spec
data.bgpNo description in the spec
data.bgp.typeNo description in the spec
data.bgp.x-truncatedNo description in the spec
data.dnsNo description in the spec
data.dns.typeNo description in the spec
data.dns.x-truncatedNo description in the spec
data.iprepNo description in the spec
data.iprep.typeNo description in the spec
data.iprep.x-truncatedNo description in the spec
data.loaaNo description in the spec
data.loaa.typeNo description in the spec
data.loaa.x-truncatedNo description in the spec
data.roaNo description in the spec
data.roa.typeNo description in the spec
data.roa.x-truncatedNo description in the spec
data.hiddenNo description in the spec
data.reservation_idNo description in the spec
data.minimum_splitNo description in the spec
data.maximum_splitNo description in the spec
data.loa-aNo description in the spec
data.ipsNo description in the spec
data.pricingsNo description in the spec
data.terminatedNo description in the spec
data.expires_atNo description in the spec
data.has_commitmentsNo description in the spec
data.can_initiate_expirationNo description in the spec
data.servicesNo description in the spec
data.commitmentReservationsNo description in the spec
data.serviceReservationsNo description in the spec
metaNo description in the spec
meta.current_pageNo description in the spec
meta.fromNo description in the spec
meta.last_pageNo description in the spec
meta.per_pageNo description in the spec
meta.toNo description in the spec
meta.totalNo description in the spec
Request
curl -X POST 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"subnets": [
{
"address": "string",
"cidr": 1,
"minimum_split": 1,
"maximum_split": 1,
"pricings": [
{
"cidr": "\u2026",
"value": "\u2026",
"wants_to_negotiate": "\u2026",
"selected_commitment_periods": "\u2026"
}
],
"hidden": true,
"maintainer_id": "string",
"maintainer_password": "string"
}
],
"tos_accepted": true,
"subnet_actions_accepted": true
}'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = {
"subnets": [
{
"address": "string",
"cidr": 1,
"minimum_split": 1,
"maximum_split": 1,
"pricings": [
{
"cidr": "\u2026",
"value": "\u2026",
"wants_to_negotiate": "\u2026",
"selected_commitment_periods": "\u2026"
}
],
"hidden": true,
"maintainer_id": "string",
"maintainer_password": "string"
}
],
"tos_accepted": true,
"subnet_actions_accepted": true
}
r = requests.post(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services";
const res = await fetch(url, {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify({
"subnets": [
{
"address": "string",
"cidr": 1,
"minimum_split": 1,
"maximum_split": 1,
"pricings": [
{
"cidr": "\u2026",
"value": "\u2026",
"wants_to_negotiate": "\u2026",
"selected_commitment_periods": "\u2026"
}
],
"hidden": true,
"maintainer_id": "string",
"maintainer_password": "string"
}
],
"tos_accepted": true,
"subnet_actions_accepted": true
}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"subnets": [
{
"address": "string",
"cidr": 1,
"minimum_split": 1,
"maximum_split": 1,
"pricings": [
{
"cidr": "\u2026",
"value": "\u2026",
"wants_to_negotiate": "\u2026",
"selected_commitment_periods": "\u2026"
}
],
"hidden": true,
"maintainer_id": "string",
"maintainer_password": "string"
}
],
"tos_accepted": true,
"subnet_actions_accepted": true
}`)
req, _ := http.NewRequest("POST", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"subnets" => [[
"address" => "string",
"cidr" => 1,
"minimum_split" => 1,
"maximum_split" => 1,
"pricings" => [[
"cidr" => "\u2026",
"value" => "\u2026",
"wants_to_negotiate" => "\u2026",
"selected_commitment_periods" => "\u2026"
]],
"hidden" => true,
"maintainer_id" => "string",
"maintainer_password" => "string"
]],
"tos_accepted" => true,
"subnet_actions_accepted" => true
]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
201
IP Market Service
{
"data": [
{
"uuid": "00000000-0000-0000-0000-000000000000",
"address": "string",
"cidr": "string",
"start": "string",
"abuse_email": "[email protected]",
"registry": "string",
"status": "string",
"auth": {
"type": "string",
"x-truncated": "string"
}
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 1,
"to": 1,
"total": 1
}
}400
Invalid Request
401
Unauthorized
403
Forbidden
Export CSV IP Market Services
GET
/v1/{tenantUUID}/market/services/csvExport CSV IP Market Services
Path parameters
tenantUUIDTenant UUID
Request body
cidrCIDR
addressIP Address
hiddenShow only Subnets hidden from market
statusNo description in the spec
registryRegistry
sortNo description in the spec
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.addressNo description in the spec
data.cidrNo description in the spec
data.startNo description in the spec
data.abuse_emailNo description in the spec
data.registryNo description in the spec
data.statusNo description in the spec
data.authNo description in the spec
data.auth.typeNo description in the spec
data.auth.x-truncatedNo description in the spec
data.whoisNo description in the spec
data.whois.typeNo description in the spec
data.whois.x-truncatedNo description in the spec
data.bgpNo description in the spec
data.bgp.typeNo description in the spec
data.bgp.x-truncatedNo description in the spec
data.dnsNo description in the spec
data.dns.typeNo description in the spec
data.dns.x-truncatedNo description in the spec
data.iprepNo description in the spec
data.iprep.typeNo description in the spec
data.iprep.x-truncatedNo description in the spec
data.loaaNo description in the spec
data.loaa.typeNo description in the spec
data.loaa.x-truncatedNo description in the spec
data.roaNo description in the spec
data.roa.typeNo description in the spec
data.roa.x-truncatedNo description in the spec
data.hiddenNo description in the spec
data.reservation_idNo description in the spec
data.minimum_splitNo description in the spec
data.maximum_splitNo description in the spec
data.loa-aNo description in the spec
data.ipsNo description in the spec
data.pricingsNo description in the spec
data.terminatedNo description in the spec
data.expires_atNo description in the spec
data.has_commitmentsNo description in the spec
data.can_initiate_expirationNo description in the spec
data.servicesNo description in the spec
data.commitmentReservationsNo description in the spec
data.serviceReservationsNo description in the spec
metaNo description in the spec
meta.current_pageNo description in the spec
meta.fromNo description in the spec
meta.last_pageNo description in the spec
meta.per_pageNo description in the spec
meta.toNo description in the spec
meta.totalNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/csv' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"cidr": 1,
"address": "string",
"hidden": true,
"status": [
"auth_pending"
],
"registry": "string",
"sort": [
"cidr"
]
}'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/csv"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = {
"cidr": 1,
"address": "string",
"hidden": true,
"status": [
"auth_pending"
],
"registry": "string",
"sort": [
"cidr"
]
}
r = requests.get(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/csv";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify({
"cidr": 1,
"address": "string",
"hidden": true,
"status": [
"auth_pending"
],
"registry": "string",
"sort": [
"cidr"
]
}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"cidr": 1,
"address": "string",
"hidden": true,
"status": [
"auth_pending"
],
"registry": "string",
"sort": [
"cidr"
]
}`)
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/csv", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/csv");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"cidr" => 1,
"address" => "string",
"hidden" => true,
"status" => ["auth_pending"],
"registry" => "string",
"sort" => ["cidr"]
]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
IP Market Service
{
"data": [
{
"uuid": "00000000-0000-0000-0000-000000000000",
"address": "string",
"cidr": "string",
"start": "string",
"abuse_email": "[email protected]",
"registry": "string",
"status": "string",
"auth": {
"type": "string",
"x-truncated": "string"
}
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 1,
"to": 1,
"total": 1
}
}400
Invalid Request
401
Unauthorized
403
Forbidden
Get IP Market Service
GET
/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}Get IP Market Service
Path parameters
tenantUUIDTenant UUID
ipmarketServiceUUIDIPMarket Service UUID
Query parameters
includeNo description in the spec
Response 200
uuidNo description in the spec
addressNo description in the spec
cidrNo description in the spec
startNo description in the spec
abuse_emailNo description in the spec
registryNo description in the spec
statusNo description in the spec
auth_pending auth_failed_verify auth_failed_verify_email_not_found auth_failed_verify_email_not_sent validity_pending validity_active validity_invalid validity_terminatedauthNo description in the spec
auth.typeNo description in the spec
auth.statusNo description in the spec
auth.descriptionNo description in the spec
whoisNo description in the spec
whois.statusNo description in the spec
whois.descriptionNo description in the spec
bgpNo description in the spec
bgp.statusNo description in the spec
bgp.descriptionNo description in the spec
dnsNo description in the spec
dns.statusNo description in the spec
dns.descriptionNo description in the spec
iprepNo description in the spec
iprep.statusNo description in the spec
iprep.descriptionNo description in the spec
loaaNo description in the spec
loaa.statusNo description in the spec
loaa.descriptionNo description in the spec
roaNo description in the spec
roa.statusNo description in the spec
roa.descriptionNo description in the spec
hiddenNo description in the spec
reservation_idNo description in the spec
minimum_splitNo description in the spec
maximum_splitNo description in the spec
loa-aNo description in the spec
loa-a.emailNo description in the spec
loa-a.statusNo description in the spec
loa-a.created_atNo description in the spec
ipsNo description in the spec
ips.run_rateNo description in the spec
ips.run_rate_ipNo description in the spec
ips.totalNo description in the spec
ips.usedNo description in the spec
ips.freeNo description in the spec
ips.utilisation_percentNo description in the spec
pricingsNo description in the spec
pricings.dataNo description in the spec
pricings.metaNo description in the spec
pricings.meta.typeNo description in the spec
pricings.meta.x-truncatedNo description in the spec
terminatedNo description in the spec
expires_atNo description in the spec
has_commitmentsNo description in the spec
can_initiate_expirationNo description in the spec
servicesNo description in the spec
services.uuidNo description in the spec
services.cidrNo description in the spec
services.addressNo description in the spec
services.statusNo description in the spec
services.pricingNo description in the spec
services.pricing.typeNo description in the spec
services.pricing.x-truncatedNo description in the spec
services.commitmentNo description in the spec
services.commitment.typeNo description in the spec
services.commitment.x-truncatedNo description in the spec
commitmentReservationsNo description in the spec
commitmentReservations.uuidNo description in the spec
commitmentReservations.addressNo description in the spec
commitmentReservations.cidrNo description in the spec
commitmentReservations.priceNo description in the spec
commitmentReservations.commitment_periodNo description in the spec
commitmentReservations.created_atNo description in the spec
commitmentReservations.tenantNo description in the spec
commitmentReservations.tenant.typeNo description in the spec
commitmentReservations.tenant.x-truncatedNo description in the spec
commitmentReservations.ipmarket_serviceNo description in the spec
commitmentReservations.ipmarket_service.typeNo description in the spec
commitmentReservations.ipmarket_service.x-truncatedNo description in the spec
commitmentReservations.commitmentNo description in the spec
commitmentReservations.commitment.typeNo description in the spec
commitmentReservations.commitment.x-truncatedNo description in the spec
serviceReservationsNo description in the spec
serviceReservations.addressNo description in the spec
serviceReservations.cidrNo description in the spec
serviceReservations.pricingNo description in the spec
serviceReservations.pricing.typeNo description in the spec
serviceReservations.pricing.x-truncatedNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
IP Market Service
{
"uuid": "00000000-0000-0000-0000-000000000000",
"address": "string",
"cidr": 1,
"start": "string",
"abuse_email": "[email protected]",
"registry": "string",
"status": "auth_pending",
"auth": {
"type": "string",
"status": "string",
"description": "string"
}
}401
Unauthorized
403
Forbidden
404
Not Found
Update IP Market Service
PATCH
/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}Updates and returns IP Market Service
Path parameters
tenantUUIDTenant UUID
ipmarketServiceUUIDIPMarket Service UUID
Query parameters
includeNo description in the spec
Request body
hiddenNo description in the spec
minimum_splitNo description in the spec
maximum_splitNo description in the spec
pricingslist of allowed to purchase CIDR pricings. Example: {'/30': 3.21, '/32': 1.23}
pricings.uuidNo description in the spec
pricings.cidrNo description in the spec
pricings.valueNo description in the spec
pricings.wants_to_negotiateNo description in the spec
pricings.selected_commitment_periodsCommitment period in months
maintainer_idAPNIC maintainer ID
maintainer_passwordAPNIC maintainer password
Response 200
uuidNo description in the spec
addressNo description in the spec
cidrNo description in the spec
startNo description in the spec
abuse_emailNo description in the spec
registryNo description in the spec
statusNo description in the spec
auth_pending auth_failed_verify auth_failed_verify_email_not_found auth_failed_verify_email_not_sent validity_pending validity_active validity_invalid validity_terminatedauthNo description in the spec
auth.typeNo description in the spec
auth.statusNo description in the spec
auth.descriptionNo description in the spec
whoisNo description in the spec
whois.statusNo description in the spec
whois.descriptionNo description in the spec
bgpNo description in the spec
bgp.statusNo description in the spec
bgp.descriptionNo description in the spec
dnsNo description in the spec
dns.statusNo description in the spec
dns.descriptionNo description in the spec
iprepNo description in the spec
iprep.statusNo description in the spec
iprep.descriptionNo description in the spec
loaaNo description in the spec
loaa.statusNo description in the spec
loaa.descriptionNo description in the spec
roaNo description in the spec
roa.statusNo description in the spec
roa.descriptionNo description in the spec
hiddenNo description in the spec
reservation_idNo description in the spec
minimum_splitNo description in the spec
maximum_splitNo description in the spec
loa-aNo description in the spec
loa-a.emailNo description in the spec
loa-a.statusNo description in the spec
loa-a.created_atNo description in the spec
ipsNo description in the spec
ips.run_rateNo description in the spec
ips.run_rate_ipNo description in the spec
ips.totalNo description in the spec
ips.usedNo description in the spec
ips.freeNo description in the spec
ips.utilisation_percentNo description in the spec
pricingsNo description in the spec
pricings.dataNo description in the spec
pricings.metaNo description in the spec
pricings.meta.typeNo description in the spec
pricings.meta.x-truncatedNo description in the spec
terminatedNo description in the spec
expires_atNo description in the spec
has_commitmentsNo description in the spec
can_initiate_expirationNo description in the spec
servicesNo description in the spec
services.uuidNo description in the spec
services.cidrNo description in the spec
services.addressNo description in the spec
services.statusNo description in the spec
services.pricingNo description in the spec
services.pricing.typeNo description in the spec
services.pricing.x-truncatedNo description in the spec
services.commitmentNo description in the spec
services.commitment.typeNo description in the spec
services.commitment.x-truncatedNo description in the spec
commitmentReservationsNo description in the spec
commitmentReservations.uuidNo description in the spec
commitmentReservations.addressNo description in the spec
commitmentReservations.cidrNo description in the spec
commitmentReservations.priceNo description in the spec
commitmentReservations.commitment_periodNo description in the spec
commitmentReservations.created_atNo description in the spec
commitmentReservations.tenantNo description in the spec
commitmentReservations.tenant.typeNo description in the spec
commitmentReservations.tenant.x-truncatedNo description in the spec
commitmentReservations.ipmarket_serviceNo description in the spec
commitmentReservations.ipmarket_service.typeNo description in the spec
commitmentReservations.ipmarket_service.x-truncatedNo description in the spec
commitmentReservations.commitmentNo description in the spec
commitmentReservations.commitment.typeNo description in the spec
commitmentReservations.commitment.x-truncatedNo description in the spec
serviceReservationsNo description in the spec
serviceReservations.addressNo description in the spec
serviceReservations.cidrNo description in the spec
serviceReservations.pricingNo description in the spec
serviceReservations.pricing.typeNo description in the spec
serviceReservations.pricing.x-truncatedNo description in the spec
Request
curl -X PATCH 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"hidden": true,
"minimum_split": 1,
"maximum_split": 1,
"pricings": [
{
"uuid": "00000000-0000-0000-0000-000000000000",
"cidr": 1,
"value": 1.0,
"wants_to_negotiate": true,
"selected_commitment_periods": [
{
"type": "object",
"x-truncated": true
}
]
}
],
"maintainer_id": "string",
"maintainer_password": "string"
}'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = {
"hidden": true,
"minimum_split": 1,
"maximum_split": 1,
"pricings": [
{
"uuid": "00000000-0000-0000-0000-000000000000",
"cidr": 1,
"value": 1.0,
"wants_to_negotiate": true,
"selected_commitment_periods": [
{
"type": "object",
"x-truncated": true
}
]
}
],
"maintainer_id": "string",
"maintainer_password": "string"
}
r = requests.patch(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}";
const res = await fetch(url, {
method: "PATCH",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify({
"hidden": true,
"minimum_split": 1,
"maximum_split": 1,
"pricings": [
{
"uuid": "00000000-0000-0000-0000-000000000000",
"cidr": 1,
"value": 1.0,
"wants_to_negotiate": true,
"selected_commitment_periods": [
{
"type": "object",
"x-truncated": true
}
]
}
],
"maintainer_id": "string",
"maintainer_password": "string"
}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"hidden": true,
"minimum_split": 1,
"maximum_split": 1,
"pricings": [
{
"uuid": "00000000-0000-0000-0000-000000000000",
"cidr": 1,
"value": 1.0,
"wants_to_negotiate": true,
"selected_commitment_periods": [
{
"type": "object",
"x-truncated": true
}
]
}
],
"maintainer_id": "string",
"maintainer_password": "string"
}`)
req, _ := http.NewRequest("PATCH", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"hidden" => true,
"minimum_split" => 1,
"maximum_split" => 1,
"pricings" => [[
"uuid" => "00000000-0000-0000-0000-000000000000",
"cidr" => 1,
"value" => 1.0,
"wants_to_negotiate" => true,
"selected_commitment_periods" => [[
"type" => "object",
"x-truncated" => true
]]
]],
"maintainer_id" => "string",
"maintainer_password" => "string"
]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
IP Market Service
{
"uuid": "00000000-0000-0000-0000-000000000000",
"address": "string",
"cidr": 1,
"start": "string",
"abuse_email": "[email protected]",
"registry": "string",
"status": "auth_pending",
"auth": {
"type": "string",
"status": "string",
"description": "string"
}
}401
Unauthorized
403
Forbidden
404
Not Found
422
Unprocessable Entity
Cancel IP Market Service
DELETE
/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}Cancel IP Market Service
Path parameters
tenantUUIDTenant UUID
ipmarketServiceUUIDIPMarket Service UUID
Response 200
uuidNo description in the spec
addressNo description in the spec
cidrNo description in the spec
startNo description in the spec
abuse_emailNo description in the spec
registryNo description in the spec
statusNo description in the spec
auth_pending auth_failed_verify auth_failed_verify_email_not_found auth_failed_verify_email_not_sent validity_pending validity_active validity_invalid validity_terminatedauthNo description in the spec
auth.typeNo description in the spec
auth.statusNo description in the spec
auth.descriptionNo description in the spec
whoisNo description in the spec
whois.statusNo description in the spec
whois.descriptionNo description in the spec
bgpNo description in the spec
bgp.statusNo description in the spec
bgp.descriptionNo description in the spec
dnsNo description in the spec
dns.statusNo description in the spec
dns.descriptionNo description in the spec
iprepNo description in the spec
iprep.statusNo description in the spec
iprep.descriptionNo description in the spec
loaaNo description in the spec
loaa.statusNo description in the spec
loaa.descriptionNo description in the spec
roaNo description in the spec
roa.statusNo description in the spec
roa.descriptionNo description in the spec
hiddenNo description in the spec
reservation_idNo description in the spec
minimum_splitNo description in the spec
maximum_splitNo description in the spec
loa-aNo description in the spec
loa-a.emailNo description in the spec
loa-a.statusNo description in the spec
loa-a.created_atNo description in the spec
ipsNo description in the spec
ips.run_rateNo description in the spec
ips.run_rate_ipNo description in the spec
ips.totalNo description in the spec
ips.usedNo description in the spec
ips.freeNo description in the spec
ips.utilisation_percentNo description in the spec
pricingsNo description in the spec
pricings.dataNo description in the spec
pricings.metaNo description in the spec
pricings.meta.typeNo description in the spec
pricings.meta.x-truncatedNo description in the spec
terminatedNo description in the spec
expires_atNo description in the spec
has_commitmentsNo description in the spec
can_initiate_expirationNo description in the spec
servicesNo description in the spec
services.uuidNo description in the spec
services.cidrNo description in the spec
services.addressNo description in the spec
services.statusNo description in the spec
services.pricingNo description in the spec
services.pricing.typeNo description in the spec
services.pricing.x-truncatedNo description in the spec
services.commitmentNo description in the spec
services.commitment.typeNo description in the spec
services.commitment.x-truncatedNo description in the spec
commitmentReservationsNo description in the spec
commitmentReservations.uuidNo description in the spec
commitmentReservations.addressNo description in the spec
commitmentReservations.cidrNo description in the spec
commitmentReservations.priceNo description in the spec
commitmentReservations.commitment_periodNo description in the spec
commitmentReservations.created_atNo description in the spec
commitmentReservations.tenantNo description in the spec
commitmentReservations.tenant.typeNo description in the spec
commitmentReservations.tenant.x-truncatedNo description in the spec
commitmentReservations.ipmarket_serviceNo description in the spec
commitmentReservations.ipmarket_service.typeNo description in the spec
commitmentReservations.ipmarket_service.x-truncatedNo description in the spec
commitmentReservations.commitmentNo description in the spec
commitmentReservations.commitment.typeNo description in the spec
commitmentReservations.commitment.x-truncatedNo description in the spec
serviceReservationsNo description in the spec
serviceReservations.addressNo description in the spec
serviceReservations.cidrNo description in the spec
serviceReservations.pricingNo description in the spec
serviceReservations.pricing.typeNo description in the spec
serviceReservations.pricing.x-truncatedNo description in the spec
Request
curl -X DELETE 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.delete(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}";
const res = await fetch(url, {
method: "DELETE",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("DELETE", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
IP Market Service
{
"uuid": "00000000-0000-0000-0000-000000000000",
"address": "string",
"cidr": 1,
"start": "string",
"abuse_email": "[email protected]",
"registry": "string",
"status": "auth_pending",
"auth": {
"type": "string",
"status": "string",
"description": "string"
}
}401
Unauthorized
403
Forbidden
404
Not Found
Get LOA-A document PDF
GET
/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/documents/downloadGet LOA-A document PDF
Path parameters
tenantUUIDTenant UUID
ipmarketServiceUUIDIPMarket Service UUID
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/documents/download' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/documents/download"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/documents/download";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/documents/download", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/documents/download");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
LOA-A Documents
401
Unauthorized
403
Forbidden
404
Not Found
Cancel IP Market Service expiration
DELETE
/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/expirationCancel IP Market Service expiration
Path parameters
tenantUUIDTenant UUID
ipmarketServiceUUIDIPMarket Service UUID
Response 200
uuidNo description in the spec
addressNo description in the spec
cidrNo description in the spec
startNo description in the spec
abuse_emailNo description in the spec
registryNo description in the spec
statusNo description in the spec
auth_pending auth_failed_verify auth_failed_verify_email_not_found auth_failed_verify_email_not_sent validity_pending validity_active validity_invalid validity_terminatedauthNo description in the spec
auth.typeNo description in the spec
auth.statusNo description in the spec
auth.descriptionNo description in the spec
whoisNo description in the spec
whois.statusNo description in the spec
whois.descriptionNo description in the spec
bgpNo description in the spec
bgp.statusNo description in the spec
bgp.descriptionNo description in the spec
dnsNo description in the spec
dns.statusNo description in the spec
dns.descriptionNo description in the spec
iprepNo description in the spec
iprep.statusNo description in the spec
iprep.descriptionNo description in the spec
loaaNo description in the spec
loaa.statusNo description in the spec
loaa.descriptionNo description in the spec
roaNo description in the spec
roa.statusNo description in the spec
roa.descriptionNo description in the spec
hiddenNo description in the spec
reservation_idNo description in the spec
minimum_splitNo description in the spec
maximum_splitNo description in the spec
loa-aNo description in the spec
loa-a.emailNo description in the spec
loa-a.statusNo description in the spec
loa-a.created_atNo description in the spec
ipsNo description in the spec
ips.run_rateNo description in the spec
ips.run_rate_ipNo description in the spec
ips.totalNo description in the spec
ips.usedNo description in the spec
ips.freeNo description in the spec
ips.utilisation_percentNo description in the spec
pricingsNo description in the spec
pricings.dataNo description in the spec
pricings.metaNo description in the spec
pricings.meta.typeNo description in the spec
pricings.meta.x-truncatedNo description in the spec
terminatedNo description in the spec
expires_atNo description in the spec
has_commitmentsNo description in the spec
can_initiate_expirationNo description in the spec
servicesNo description in the spec
services.uuidNo description in the spec
services.cidrNo description in the spec
services.addressNo description in the spec
services.statusNo description in the spec
services.pricingNo description in the spec
services.pricing.typeNo description in the spec
services.pricing.x-truncatedNo description in the spec
services.commitmentNo description in the spec
services.commitment.typeNo description in the spec
services.commitment.x-truncatedNo description in the spec
commitmentReservationsNo description in the spec
commitmentReservations.uuidNo description in the spec
commitmentReservations.addressNo description in the spec
commitmentReservations.cidrNo description in the spec
commitmentReservations.priceNo description in the spec
commitmentReservations.commitment_periodNo description in the spec
commitmentReservations.created_atNo description in the spec
commitmentReservations.tenantNo description in the spec
commitmentReservations.tenant.typeNo description in the spec
commitmentReservations.tenant.x-truncatedNo description in the spec
commitmentReservations.ipmarket_serviceNo description in the spec
commitmentReservations.ipmarket_service.typeNo description in the spec
commitmentReservations.ipmarket_service.x-truncatedNo description in the spec
commitmentReservations.commitmentNo description in the spec
commitmentReservations.commitment.typeNo description in the spec
commitmentReservations.commitment.x-truncatedNo description in the spec
serviceReservationsNo description in the spec
serviceReservations.addressNo description in the spec
serviceReservations.cidrNo description in the spec
serviceReservations.pricingNo description in the spec
serviceReservations.pricing.typeNo description in the spec
serviceReservations.pricing.x-truncatedNo description in the spec
Request
curl -X DELETE 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/expiration' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/expiration"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.delete(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/expiration";
const res = await fetch(url, {
method: "DELETE",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("DELETE", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/expiration", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/expiration");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
IP Market Service
{
"uuid": "00000000-0000-0000-0000-000000000000",
"address": "string",
"cidr": 1,
"start": "string",
"abuse_email": "[email protected]",
"registry": "string",
"status": "auth_pending",
"auth": {
"type": "string",
"status": "string",
"description": "string"
}
}401
Unauthorized
403
Forbidden
404
Not Found
List IP Market Service Pricing
GET
/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/pricingList IP Market Service Pricing
Path parameters
tenantUUIDTenant UUID
ipmarketServiceUUIDIPMarket Service UUID
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.subnet_sizeNo description in the spec
data.ip_countNo description in the spec
data.priceNo description in the spec
data.commissionNo description in the spec
data.wants_to_negotiateNo description in the spec
data.selected_commitment_periodsNo description in the spec
metaNo description in the spec
meta.current_pageNo description in the spec
meta.fromNo description in the spec
meta.last_pageNo description in the spec
meta.per_pageNo description in the spec
meta.toNo description in the spec
meta.totalNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/pricing' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/pricing"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/pricing";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/pricing", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/pricing");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
IP Market Service
{
"data": [
{
"uuid": "00000000-0000-0000-0000-000000000000",
"subnet_size": "string",
"ip_count": "string",
"price": "string",
"commission": "string",
"wants_to_negotiate": "string",
"selected_commitment_periods": "string"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 1,
"to": 1,
"total": 1
}
}400
Invalid Request
401
Unauthorized
403
Forbidden
Get IP Market service reputation scan result list
GET
/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/reputationsGet IP Market service reputation scan result list
Path parameters
tenantUUIDTenant UUID
ipmarketServiceUUIDIPMarket Service UUID
Response 200
dataNo description in the spec
data.idNo description in the spec
data.ipNo description in the spec
data.ip_intNo description in the spec
data.country_codeNo description in the spec
data.detection_rateNo description in the spec
data.detectionsNo description in the spec
data.detections_engine_listNo description in the spec
data.engines_countNo description in the spec
data.is_listedNo description in the spec
data.is_proxyNo description in the spec
data.is_torNo description in the spec
data.is_vpnNo description in the spec
data.session_idNo description in the spec
data.createdNo description in the spec
data.metaNo description in the spec
metaNo description in the spec
meta.limitNo description in the spec
meta.offsetNo description in the spec
meta.countNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/reputations' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/reputations"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/reputations";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/reputations", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/reputations");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
IP Market service reputation scan results list
{
"data": [
{
"id": "string",
"ip": "string",
"ip_int": "string",
"country_code": "string",
"detection_rate": "string",
"detections": "string",
"detections_engine_list": "string",
"engines_count": "string"
}
],
"meta": {
"limit": 1,
"offset": 1,
"count": 1
}
}401
Unauthorized
403
Forbidden
404
Not Found
Resend IP Market Service Verification Email
POST
/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/resend_verificationResend IP Market Service Verification Email
Path parameters
tenantUUIDTenant UUID
ipmarketServiceUUIDIPMarket Service UUID
Request
curl -X POST 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/resend_verification' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/resend_verification"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.post(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/resend_verification";
const res = await fetch(url, {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("POST", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/resend_verification", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/resend_verification");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
400
Invalid Request
401
Unauthorized
403
Forbidden
406
Service has no abuse email set!
Update The Commitment Reservation ID
POST
/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/reservation_idUpdate The Commitment Reservation ID
Path parameters
tenantUUIDTenant UUID
ipmarketServiceUUIDIPMarket Service UUID
Query parameters
removeRemove The Commitment Reservation Id
Request
curl -X POST 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/reservation_id' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/reservation_id"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.post(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/reservation_id";
const res = await fetch(url, {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("POST", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/reservation_id", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/reservation_id");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
400
Invalid Request
401
Unauthorized
403
Forbidden
Return the status report for service
GET
/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/statusReturn the status report for service
Path parameters
tenantUUIDTenant UUID
ipmarketServiceUUIDIPMarket Service UUID
Response 200
abuse_emailNo description in the spec
registryNo description in the spec
statusNo description in the spec
auth_pending auth_failed_verify auth_failed_verify_email_not_found auth_failed_verify_email_not_sent validity_pending validity_active validity_invalid validity_terminatedauthNo description in the spec
auth.typeNo description in the spec
auth.statusNo description in the spec
auth.descriptionNo description in the spec
whoisNo description in the spec
whois.statusNo description in the spec
whois.descriptionNo description in the spec
bgpNo description in the spec
bgp.statusNo description in the spec
bgp.descriptionNo description in the spec
dnsNo description in the spec
dns.statusNo description in the spec
dns.descriptionNo description in the spec
iprepNo description in the spec
iprep.statusNo description in the spec
iprep.descriptionNo description in the spec
loaaNo description in the spec
loaa.statusNo description in the spec
loaa.descriptionNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/status' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/status"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/status";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/status", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/status");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
IP Market Service Status Report
{
"abuse_email": "[email protected]",
"registry": "string",
"status": "auth_pending",
"auth": {
"type": "string",
"status": "string",
"description": "string"
},
"whois": {
"status": "string",
"description": "string"
},
"bgp": {
"status": "string",
"description": "string"
},
"dns": {
"status": "string",
"description": "string"
},
"iprep": {
"status": "string",
"description": "string"
}
}401
Unauthorized
403
Forbidden
404
Not Found
Cart & checkout
16 operations
The object synthesised
The spec declares no named object for this resource, so the renderer synthesised one from its richest response body (GET /public/{user_id}/cart). Fields no endpoint returns cannot appear here.
Attributes
dataNo description in the spec
data.uuidNo description in the spec
data.totalNo description in the spec
data.sub_totalNo description in the spec
data.tax_totalNo description in the spec
data.credits_totalNo description in the spec
data.discount_totalNo description in the spec
data.remaining_totalNo description in the spec
data.credits_eligible_amountNo description in the spec
data.total_before_taxNo description in the spec
data.tax_breakdownNo description in the spec
data.discount_breakdownNo description in the spec
data.expires_atNo description in the spec
Current Cart
GET
/public/{user_id}/cartShow the current Cart.
Path parameters
user_idThe ID of the user.
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.totalNo description in the spec
data.total.currencyNo description in the spec
data.total.amountNo description in the spec
data.total.amount_minorNo description in the spec
data.sub_totalNo description in the spec
data.sub_total.currencyNo description in the spec
data.sub_total.amountNo description in the spec
data.sub_total.amount_minorNo description in the spec
data.tax_totalNo description in the spec
data.tax_total.currencyNo description in the spec
data.tax_total.amountNo description in the spec
data.tax_total.amount_minorNo description in the spec
data.credits_totalNo description in the spec
data.credits_total.currencyNo description in the spec
data.credits_total.amountNo description in the spec
data.credits_total.amount_minorNo description in the spec
data.discount_totalNo description in the spec
data.discount_total.currencyNo description in the spec
data.discount_total.amountNo description in the spec
data.discount_total.amount_minorNo description in the spec
data.remaining_totalNo description in the spec
data.remaining_total.currencyNo description in the spec
data.remaining_total.amountNo description in the spec
data.remaining_total.amount_minorNo description in the spec
data.credits_eligible_amountNo description in the spec
data.credits_eligible_amount.currencyNo description in the spec
data.credits_eligible_amount.amountNo description in the spec
data.credits_eligible_amount.amount_minorNo description in the spec
data.total_before_taxNo description in the spec
data.total_before_tax.currencyNo description in the spec
data.total_before_tax.amountNo description in the spec
data.total_before_tax.amount_minorNo description in the spec
data.tax_breakdownNo description in the spec
data.tax_breakdown.amountNo description in the spec
data.tax_breakdown.amount.typeNo description in the spec
data.tax_breakdown.amount.x-truncatedNo description in the spec
data.tax_breakdown.codeNo description in the spec
data.tax_breakdown.nameNo description in the spec
data.tax_breakdown.rateNo description in the spec
data.tax_breakdown.calculator_typeNo description in the spec
data.tax_breakdown.noticeNo description in the spec
data.discount_breakdownNo description in the spec
data.discount_breakdown.amountNo description in the spec
data.discount_breakdown.amount.typeNo description in the spec
data.discount_breakdown.amount.x-truncatedNo description in the spec
data.discount_breakdown.codeNo description in the spec
data.discount_breakdown.nameNo description in the spec
data.discount_breakdown.rateNo description in the spec
data.discount_breakdown.calculator_typeNo description in the spec
data.discount_breakdown.noticeNo description in the spec
data.expires_atNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/ecommerce/public/{user_id}/cart' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/cart"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/cart";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/ecommerce/public/{user_id}/cart", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/cart");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": {
"uuid": "00000000-0000-0000-0000-000000000000",
"total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"sub_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"tax_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"credits_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"discount_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"remaining_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"credits_eligible_amount": {
"currency": "string",
"amount": "string",
"amount_minor": 1
}
}
}Show Cart
GET
/public/{user_id}/cart/{cart_uuid}Show the Cart.
Path parameters
user_idThe ID of the user.
cart_uuidNo description in the spec
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.totalNo description in the spec
data.total.currencyNo description in the spec
data.total.amountNo description in the spec
data.total.amount_minorNo description in the spec
data.sub_totalNo description in the spec
data.sub_total.currencyNo description in the spec
data.sub_total.amountNo description in the spec
data.sub_total.amount_minorNo description in the spec
data.tax_totalNo description in the spec
data.tax_total.currencyNo description in the spec
data.tax_total.amountNo description in the spec
data.tax_total.amount_minorNo description in the spec
data.credits_totalNo description in the spec
data.credits_total.currencyNo description in the spec
data.credits_total.amountNo description in the spec
data.credits_total.amount_minorNo description in the spec
data.discount_totalNo description in the spec
data.discount_total.currencyNo description in the spec
data.discount_total.amountNo description in the spec
data.discount_total.amount_minorNo description in the spec
data.remaining_totalNo description in the spec
data.remaining_total.currencyNo description in the spec
data.remaining_total.amountNo description in the spec
data.remaining_total.amount_minorNo description in the spec
data.credits_eligible_amountNo description in the spec
data.credits_eligible_amount.currencyNo description in the spec
data.credits_eligible_amount.amountNo description in the spec
data.credits_eligible_amount.amount_minorNo description in the spec
data.total_before_taxNo description in the spec
data.total_before_tax.currencyNo description in the spec
data.total_before_tax.amountNo description in the spec
data.total_before_tax.amount_minorNo description in the spec
data.tax_breakdownNo description in the spec
data.tax_breakdown.amountNo description in the spec
data.tax_breakdown.amount.typeNo description in the spec
data.tax_breakdown.amount.x-truncatedNo description in the spec
data.tax_breakdown.codeNo description in the spec
data.tax_breakdown.nameNo description in the spec
data.tax_breakdown.rateNo description in the spec
data.tax_breakdown.calculator_typeNo description in the spec
data.tax_breakdown.noticeNo description in the spec
data.discount_breakdownNo description in the spec
data.discount_breakdown.amountNo description in the spec
data.discount_breakdown.amount.typeNo description in the spec
data.discount_breakdown.amount.x-truncatedNo description in the spec
data.discount_breakdown.codeNo description in the spec
data.discount_breakdown.nameNo description in the spec
data.discount_breakdown.rateNo description in the spec
data.discount_breakdown.calculator_typeNo description in the spec
data.discount_breakdown.noticeNo description in the spec
data.expires_atNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": {
"uuid": "00000000-0000-0000-0000-000000000000",
"total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"sub_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"tax_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"credits_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"discount_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"remaining_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"credits_eligible_amount": {
"currency": "string",
"amount": "string",
"amount_minor": 1
}
}
}Create Cart Address
POST
/public/{user_id}/cart/{cart_uuid}/addresses/{customerAddress_id}Create a single Cart Address.
Path parameters
user_idThe ID of the user.
cart_uuidNo description in the spec
customerAddress_idThe ID of the customerAddress.
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.first_nameNo description in the spec
data.last_nameNo description in the spec
data.company_nameNo description in the spec
data.vat_numberNo description in the spec
data.vat_validation_statusNo description in the spec
data.vat_validated_atNo description in the spec
data.line_oneNo description in the spec
data.line_twoNo description in the spec
data.line_threeNo description in the spec
data.cityNo description in the spec
data.province_codeNo description in the spec
data.country_codeNo description in the spec
data.postcodeNo description in the spec
data.contact_emailNo description in the spec
data.contact_phoneNo description in the spec
data.company_codeNo description in the spec
Request
curl -X POST 'https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/addresses/{customerAddress_id}' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/addresses/{customerAddress_id}"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.post(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/addresses/{customerAddress_id}";
const res = await fetch(url, {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("POST", "https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/addresses/{customerAddress_id}", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/addresses/{customerAddress_id}");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": {
"uuid": "00000000-0000-0000-0000-000000000000",
"first_name": "string",
"last_name": "string",
"company_name": "string",
"vat_number": "string",
"vat_validation_status": "string",
"vat_validated_at": "string",
"line_one": "string"
}
}Update Cart Address
PATCH
/public/{user_id}/cart/{cart_uuid}/addresses/{customerAddress_id}Update a Cart Address.
Path parameters
user_idThe ID of the user.
cart_uuidNo description in the spec
customerAddress_idThe ID of the customerAddress.
Request body
line_oneMust not be greater than 255 characters.
line_twoMust not be greater than 255 characters.
cityMust not be greater than 255 characters.
postcodeMust not be greater than 20 characters.
province_codeMust not be greater than 10 characters.
contact_emailMust be a valid email address. Must not be greater than 255 characters.
vat_numberMust not be greater than 50 characters.
company_codeMust not be greater than 50 characters.
first_nameMust not be greater than 255 characters.
last_nameMust not be greater than 255 characters.
company_nameMust not be greater than 255 characters.
contact_phoneMust not be greater than 50 characters.
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.first_nameNo description in the spec
data.last_nameNo description in the spec
data.company_nameNo description in the spec
data.vat_numberNo description in the spec
data.vat_validation_statusNo description in the spec
data.vat_validated_atNo description in the spec
data.line_oneNo description in the spec
data.line_twoNo description in the spec
data.line_threeNo description in the spec
data.cityNo description in the spec
data.province_codeNo description in the spec
data.country_codeNo description in the spec
data.postcodeNo description in the spec
data.contact_emailNo description in the spec
data.contact_phoneNo description in the spec
data.company_codeNo description in the spec
Request
curl -X PATCH 'https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/addresses/{customerAddress_id}' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"line_one": "string",
"line_two": "string",
"city": "string",
"postcode": "string",
"province_code": "string",
"contact_email": "[email protected]",
"vat_number": "string",
"company_code": "string"
}'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/addresses/{customerAddress_id}"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = {
"line_one": "string",
"line_two": "string",
"city": "string",
"postcode": "string",
"province_code": "string",
"contact_email": "[email protected]",
"vat_number": "string",
"company_code": "string"
}
r = requests.patch(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/addresses/{customerAddress_id}";
const res = await fetch(url, {
method: "PATCH",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify({
"line_one": "string",
"line_two": "string",
"city": "string",
"postcode": "string",
"province_code": "string",
"contact_email": "[email protected]",
"vat_number": "string",
"company_code": "string"
}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"line_one": "string",
"line_two": "string",
"city": "string",
"postcode": "string",
"province_code": "string",
"contact_email": "[email protected]",
"vat_number": "string",
"company_code": "string"
}`)
req, _ := http.NewRequest("PATCH", "https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/addresses/{customerAddress_id}", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/addresses/{customerAddress_id}");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"line_one" => "string",
"line_two" => "string",
"city" => "string",
"postcode" => "string",
"province_code" => "string",
"contact_email" => "[email protected]",
"vat_number" => "string",
"company_code" => "string"
]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": {
"uuid": "00000000-0000-0000-0000-000000000000",
"first_name": "string",
"last_name": "string",
"company_name": "string",
"vat_number": "string",
"vat_validation_status": "string",
"vat_validated_at": "string",
"line_one": "string"
}
}Checkout Cart
POST
/public/{user_id}/cart/{cart_uuid}/checkoutCheckout the current Cart.
Path parameters
user_idThe ID of the user.
cart_uuidNo description in the spec
Response 200
dataNo description in the spec
data.orderNo description in the spec
data.order.uuidNo description in the spec
data.order.statusNo description in the spec
data.order.placed_atNo description in the spec
data.order.expires_atNo description in the spec
data.order.sub_totalNo description in the spec
data.order.sub_total.currencyNo description in the spec
data.order.sub_total.amountNo description in the spec
data.order.sub_total.amount_minorNo description in the spec
data.order.discount_totalNo description in the spec
data.order.discount_total.currencyNo description in the spec
data.order.discount_total.amountNo description in the spec
data.order.discount_total.amount_minorNo description in the spec
data.order.tax_totalNo description in the spec
data.order.tax_total.currencyNo description in the spec
data.order.tax_total.amountNo description in the spec
data.order.tax_total.amount_minorNo description in the spec
data.order.credits_totalNo description in the spec
data.order.credits_total.currencyNo description in the spec
data.order.credits_total.amountNo description in the spec
data.order.credits_total.amount_minorNo description in the spec
data.order.totalNo description in the spec
data.order.total.currencyNo description in the spec
data.order.total.amountNo description in the spec
data.order.total.amount_minorNo description in the spec
data.order.remaining_totalNo description in the spec
data.order.remaining_total.currencyNo description in the spec
data.order.remaining_total.amountNo description in the spec
data.order.remaining_total.amount_minorNo description in the spec
data.order.total_before_taxNo description in the spec
data.order.total_before_tax.currencyNo description in the spec
data.order.total_before_tax.amountNo description in the spec
data.order.total_before_tax.amount_minorNo description in the spec
data.order.tax_breakdownNo description in the spec
data.order.tax_breakdown.typeNo description in the spec
data.order.tax_breakdown.x-truncatedNo description in the spec
data.order.discount_breakdownNo description in the spec
data.order.discount_breakdown.typeNo description in the spec
data.order.discount_breakdown.x-truncatedNo description in the spec
Request
curl -X POST 'https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/checkout' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/checkout"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.post(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/checkout";
const res = await fetch(url, {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("POST", "https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/checkout", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/checkout");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": {
"order": {
"uuid": "00000000-0000-0000-0000-000000000000",
"status": "string",
"placed_at": "string",
"expires_at": "string",
"sub_total": {
"currency": {},
"amount": {},
"amount_minor": {}
},
"discount_total": {
"currency": {},
"amount": {},
"amount_minor": {}
},
"tax_total": {
"currency": {},
"amount": {},
"amount_minor": {}
},
"credits_total": {
"currency": {},
"amount": {},
"amount_minor": {}
}
}
}
}Remove Credits From Cart
DELETE
/public/{user_id}/cart/{cart_uuid}/creditsRemove Credits from Cart
Path parameters
user_idThe ID of the user.
cart_uuidNo description in the spec
Request body
amountNo description in the spec
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.totalNo description in the spec
data.total.currencyNo description in the spec
data.total.amountNo description in the spec
data.total.amount_minorNo description in the spec
data.sub_totalNo description in the spec
data.sub_total.currencyNo description in the spec
data.sub_total.amountNo description in the spec
data.sub_total.amount_minorNo description in the spec
data.tax_totalNo description in the spec
data.tax_total.currencyNo description in the spec
data.tax_total.amountNo description in the spec
data.tax_total.amount_minorNo description in the spec
data.credits_totalNo description in the spec
data.credits_total.currencyNo description in the spec
data.credits_total.amountNo description in the spec
data.credits_total.amount_minorNo description in the spec
data.discount_totalNo description in the spec
data.discount_total.currencyNo description in the spec
data.discount_total.amountNo description in the spec
data.discount_total.amount_minorNo description in the spec
data.remaining_totalNo description in the spec
data.remaining_total.currencyNo description in the spec
data.remaining_total.amountNo description in the spec
data.remaining_total.amount_minorNo description in the spec
data.credits_eligible_amountNo description in the spec
data.credits_eligible_amount.currencyNo description in the spec
data.credits_eligible_amount.amountNo description in the spec
data.credits_eligible_amount.amount_minorNo description in the spec
data.total_before_taxNo description in the spec
data.total_before_tax.currencyNo description in the spec
data.total_before_tax.amountNo description in the spec
data.total_before_tax.amount_minorNo description in the spec
data.tax_breakdownNo description in the spec
data.tax_breakdown.amountNo description in the spec
data.tax_breakdown.amount.typeNo description in the spec
data.tax_breakdown.amount.x-truncatedNo description in the spec
data.tax_breakdown.codeNo description in the spec
data.tax_breakdown.nameNo description in the spec
data.tax_breakdown.rateNo description in the spec
data.tax_breakdown.calculator_typeNo description in the spec
data.tax_breakdown.noticeNo description in the spec
data.discount_breakdownNo description in the spec
data.discount_breakdown.amountNo description in the spec
data.discount_breakdown.amount.typeNo description in the spec
data.discount_breakdown.amount.x-truncatedNo description in the spec
data.discount_breakdown.codeNo description in the spec
data.discount_breakdown.nameNo description in the spec
data.discount_breakdown.rateNo description in the spec
data.discount_breakdown.calculator_typeNo description in the spec
data.discount_breakdown.noticeNo description in the spec
data.expires_atNo description in the spec
Request
curl -X DELETE 'https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/credits' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"amount": 1.0
}'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/credits"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = {
"amount": 1.0
}
r = requests.delete(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/credits";
const res = await fetch(url, {
method: "DELETE",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify({
"amount": 1.0
}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"amount": 1.0
}`)
req, _ := http.NewRequest("DELETE", "https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/credits", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/credits");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"amount" => 1.0
]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": {
"uuid": "00000000-0000-0000-0000-000000000000",
"total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"sub_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"tax_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"credits_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"discount_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"remaining_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"credits_eligible_amount": {
"currency": "string",
"amount": "string",
"amount_minor": 1
}
}
}Apply Credits To Cart
POST
/public/{user_id}/cart/{cart_uuid}/credits/applyApply Credits to Cart
Path parameters
user_idThe ID of the user.
cart_uuidNo description in the spec
Request body
amountMust be at least 0.
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.totalNo description in the spec
data.total.currencyNo description in the spec
data.total.amountNo description in the spec
data.total.amount_minorNo description in the spec
data.sub_totalNo description in the spec
data.sub_total.currencyNo description in the spec
data.sub_total.amountNo description in the spec
data.sub_total.amount_minorNo description in the spec
data.tax_totalNo description in the spec
data.tax_total.currencyNo description in the spec
data.tax_total.amountNo description in the spec
data.tax_total.amount_minorNo description in the spec
data.credits_totalNo description in the spec
data.credits_total.currencyNo description in the spec
data.credits_total.amountNo description in the spec
data.credits_total.amount_minorNo description in the spec
data.discount_totalNo description in the spec
data.discount_total.currencyNo description in the spec
data.discount_total.amountNo description in the spec
data.discount_total.amount_minorNo description in the spec
data.remaining_totalNo description in the spec
data.remaining_total.currencyNo description in the spec
data.remaining_total.amountNo description in the spec
data.remaining_total.amount_minorNo description in the spec
data.credits_eligible_amountNo description in the spec
data.credits_eligible_amount.currencyNo description in the spec
data.credits_eligible_amount.amountNo description in the spec
data.credits_eligible_amount.amount_minorNo description in the spec
data.total_before_taxNo description in the spec
data.total_before_tax.currencyNo description in the spec
data.total_before_tax.amountNo description in the spec
data.total_before_tax.amount_minorNo description in the spec
data.tax_breakdownNo description in the spec
data.tax_breakdown.amountNo description in the spec
data.tax_breakdown.amount.typeNo description in the spec
data.tax_breakdown.amount.x-truncatedNo description in the spec
data.tax_breakdown.codeNo description in the spec
data.tax_breakdown.nameNo description in the spec
data.tax_breakdown.rateNo description in the spec
data.tax_breakdown.calculator_typeNo description in the spec
data.tax_breakdown.noticeNo description in the spec
data.discount_breakdownNo description in the spec
data.discount_breakdown.amountNo description in the spec
data.discount_breakdown.amount.typeNo description in the spec
data.discount_breakdown.amount.x-truncatedNo description in the spec
data.discount_breakdown.codeNo description in the spec
data.discount_breakdown.nameNo description in the spec
data.discount_breakdown.rateNo description in the spec
data.discount_breakdown.calculator_typeNo description in the spec
data.discount_breakdown.noticeNo description in the spec
data.expires_atNo description in the spec
Request
curl -X POST 'https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/credits/apply' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"amount": 1.0
}'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/credits/apply"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = {
"amount": 1.0
}
r = requests.post(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/credits/apply";
const res = await fetch(url, {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify({
"amount": 1.0
}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"amount": 1.0
}`)
req, _ := http.NewRequest("POST", "https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/credits/apply", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/credits/apply");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"amount" => 1.0
]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": {
"uuid": "00000000-0000-0000-0000-000000000000",
"total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"sub_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"tax_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"credits_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"discount_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"remaining_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"credits_eligible_amount": {
"currency": "string",
"amount": "string",
"amount_minor": 1
}
}
}Apply Discount Code
POST
/public/{user_id}/cart/{cart_uuid}/discount-code/{discountCode_code}Applies discount code to cart.
Path parameters
user_idThe ID of the user.
cart_uuidNo description in the spec
discountCode_codeNo description in the spec
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.totalNo description in the spec
data.total.currencyNo description in the spec
data.total.amountNo description in the spec
data.total.amount_minorNo description in the spec
data.sub_totalNo description in the spec
data.sub_total.currencyNo description in the spec
data.sub_total.amountNo description in the spec
data.sub_total.amount_minorNo description in the spec
data.tax_totalNo description in the spec
data.tax_total.currencyNo description in the spec
data.tax_total.amountNo description in the spec
data.tax_total.amount_minorNo description in the spec
data.credits_totalNo description in the spec
data.credits_total.currencyNo description in the spec
data.credits_total.amountNo description in the spec
data.credits_total.amount_minorNo description in the spec
data.discount_totalNo description in the spec
data.discount_total.currencyNo description in the spec
data.discount_total.amountNo description in the spec
data.discount_total.amount_minorNo description in the spec
data.remaining_totalNo description in the spec
data.remaining_total.currencyNo description in the spec
data.remaining_total.amountNo description in the spec
data.remaining_total.amount_minorNo description in the spec
data.credits_eligible_amountNo description in the spec
data.credits_eligible_amount.currencyNo description in the spec
data.credits_eligible_amount.amountNo description in the spec
data.credits_eligible_amount.amount_minorNo description in the spec
data.total_before_taxNo description in the spec
data.total_before_tax.currencyNo description in the spec
data.total_before_tax.amountNo description in the spec
data.total_before_tax.amount_minorNo description in the spec
data.tax_breakdownNo description in the spec
data.tax_breakdown.amountNo description in the spec
data.tax_breakdown.amount.typeNo description in the spec
data.tax_breakdown.amount.x-truncatedNo description in the spec
data.tax_breakdown.codeNo description in the spec
data.tax_breakdown.nameNo description in the spec
data.tax_breakdown.rateNo description in the spec
data.tax_breakdown.calculator_typeNo description in the spec
data.tax_breakdown.noticeNo description in the spec
data.discount_breakdownNo description in the spec
data.discount_breakdown.amountNo description in the spec
data.discount_breakdown.amount.typeNo description in the spec
data.discount_breakdown.amount.x-truncatedNo description in the spec
data.discount_breakdown.codeNo description in the spec
data.discount_breakdown.nameNo description in the spec
data.discount_breakdown.rateNo description in the spec
data.discount_breakdown.calculator_typeNo description in the spec
data.discount_breakdown.noticeNo description in the spec
data.expires_atNo description in the spec
Request
curl -X POST 'https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/discount-code/{discountCode_code}' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/discount-code/{discountCode_code}"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.post(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/discount-code/{discountCode_code}";
const res = await fetch(url, {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("POST", "https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/discount-code/{discountCode_code}", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/discount-code/{discountCode_code}");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": {
"uuid": "00000000-0000-0000-0000-000000000000",
"total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"sub_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"tax_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"credits_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"discount_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"remaining_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"credits_eligible_amount": {
"currency": "string",
"amount": "string",
"amount_minor": 1
}
}
}204
Successfully applied discount code to cart
{}Remove Discount Code from Cart
DELETE
/public/{user_id}/cart/{cart_uuid}/discount-code/{discountCode_code}Remove discount code from a cart.
Path parameters
user_idThe ID of the user.
cart_uuidNo description in the spec
discountCode_codeNo description in the spec
Request
curl -X DELETE 'https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/discount-code/{discountCode_code}' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/discount-code/{discountCode_code}"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.delete(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/discount-code/{discountCode_code}";
const res = await fetch(url, {
method: "DELETE",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("DELETE", "https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/discount-code/{discountCode_code}", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/discount-code/{discountCode_code}");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
204
Successfully removed discount code from cart
{}List Cart Lines
GET
/public/{user_id}/cart/{cart_uuid}/linesList the current Cart Lines.
Path parameters
user_idThe ID of the user.
cart_uuidNo description in the spec
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.reference_idNo description in the spec
data.titleNo description in the spec
data.descriptionNo description in the spec
data.quantityNo description in the spec
data.unit_quantityNo description in the spec
data.purchasable_typeNo description in the spec
data.purchasable_idNo description in the spec
data.unit_priceNo description in the spec
data.unit_price.currencyNo description in the spec
data.unit_price.amountNo description in the spec
data.unit_price.amount_minorNo description in the spec
data.sub_totalNo description in the spec
data.sub_total.currencyNo description in the spec
data.sub_total.amountNo description in the spec
data.sub_total.amount_minorNo description in the spec
data.discount_totalNo description in the spec
data.discount_total.currencyNo description in the spec
data.discount_total.amountNo description in the spec
data.discount_total.amount_minorNo description in the spec
data.tax_totalNo description in the spec
data.tax_total.currencyNo description in the spec
data.tax_total.amountNo description in the spec
data.tax_total.amount_minorNo description in the spec
data.totalNo description in the spec
data.total.currencyNo description in the spec
data.total.amountNo description in the spec
data.total.amount_minorNo description in the spec
data.total_before_taxNo description in the spec
data.total_before_tax.currencyNo description in the spec
data.total_before_tax.amountNo description in the spec
data.total_before_tax.amount_minorNo description in the spec
data.exchange_rateNo description in the spec
data.exchange_rate_fetched_atNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/lines' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/lines"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/lines";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/lines", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/lines");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": [
{
"uuid": "00000000-0000-0000-0000-000000000000",
"reference_id": "string",
"title": "string",
"description": "string",
"quantity": 1,
"unit_quantity": 1,
"purchasable_type": "string",
"purchasable_id": "string"
}
]
}Add To Cart
POST
/public/{user_id}/cart/{cart_uuid}/linesAdd a Purchasable to the Cart.
Path parameters
user_idThe ID of the user.
cart_uuidNo description in the spec
Request body
price_idMust be a valid UUID. The <code>uuid</code> of an existing record in the prices table.
quantityMust be at least 1.
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.reference_idNo description in the spec
data.titleNo description in the spec
data.descriptionNo description in the spec
data.quantityNo description in the spec
data.unit_quantityNo description in the spec
data.purchasable_typeNo description in the spec
data.purchasable_idNo description in the spec
data.unit_priceNo description in the spec
data.unit_price.currencyNo description in the spec
data.unit_price.amountNo description in the spec
data.unit_price.amount_minorNo description in the spec
data.sub_totalNo description in the spec
data.sub_total.currencyNo description in the spec
data.sub_total.amountNo description in the spec
data.sub_total.amount_minorNo description in the spec
data.discount_totalNo description in the spec
data.discount_total.currencyNo description in the spec
data.discount_total.amountNo description in the spec
data.discount_total.amount_minorNo description in the spec
data.tax_totalNo description in the spec
data.tax_total.currencyNo description in the spec
data.tax_total.amountNo description in the spec
data.tax_total.amount_minorNo description in the spec
data.totalNo description in the spec
data.total.currencyNo description in the spec
data.total.amountNo description in the spec
data.total.amount_minorNo description in the spec
data.total_before_taxNo description in the spec
data.total_before_tax.currencyNo description in the spec
data.total_before_tax.amountNo description in the spec
data.total_before_tax.amount_minorNo description in the spec
data.exchange_rateNo description in the spec
data.exchange_rate_fetched_atNo description in the spec
Request
curl -X POST 'https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/lines' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"price_id": "string",
"quantity": 1.0
}'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/lines"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = {
"price_id": "string",
"quantity": 1.0
}
r = requests.post(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/lines";
const res = await fetch(url, {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify({
"price_id": "string",
"quantity": 1.0
}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"price_id": "string",
"quantity": 1.0
}`)
req, _ := http.NewRequest("POST", "https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/lines", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/lines");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"price_id" => "string",
"quantity" => 1.0
]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": {
"uuid": "00000000-0000-0000-0000-000000000000",
"reference_id": "string",
"title": "string",
"description": "string",
"quantity": 1,
"unit_quantity": 1,
"purchasable_type": "string",
"purchasable_id": "string"
}
}Remove Line
DELETE
/public/{user_id}/cart/{cart_uuid}/lines/{cartLine_uuid}Remove a Cart Line.
Path parameters
user_idThe ID of the user.
cart_uuidNo description in the spec
cartLine_uuidNo description in the spec
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.totalNo description in the spec
data.total.currencyNo description in the spec
data.total.amountNo description in the spec
data.total.amount_minorNo description in the spec
data.sub_totalNo description in the spec
data.sub_total.currencyNo description in the spec
data.sub_total.amountNo description in the spec
data.sub_total.amount_minorNo description in the spec
data.tax_totalNo description in the spec
data.tax_total.currencyNo description in the spec
data.tax_total.amountNo description in the spec
data.tax_total.amount_minorNo description in the spec
data.credits_totalNo description in the spec
data.credits_total.currencyNo description in the spec
data.credits_total.amountNo description in the spec
data.credits_total.amount_minorNo description in the spec
data.discount_totalNo description in the spec
data.discount_total.currencyNo description in the spec
data.discount_total.amountNo description in the spec
data.discount_total.amount_minorNo description in the spec
data.remaining_totalNo description in the spec
data.remaining_total.currencyNo description in the spec
data.remaining_total.amountNo description in the spec
data.remaining_total.amount_minorNo description in the spec
data.credits_eligible_amountNo description in the spec
data.credits_eligible_amount.currencyNo description in the spec
data.credits_eligible_amount.amountNo description in the spec
data.credits_eligible_amount.amount_minorNo description in the spec
data.total_before_taxNo description in the spec
data.total_before_tax.currencyNo description in the spec
data.total_before_tax.amountNo description in the spec
data.total_before_tax.amount_minorNo description in the spec
data.tax_breakdownNo description in the spec
data.tax_breakdown.amountNo description in the spec
data.tax_breakdown.amount.typeNo description in the spec
data.tax_breakdown.amount.x-truncatedNo description in the spec
data.tax_breakdown.codeNo description in the spec
data.tax_breakdown.nameNo description in the spec
data.tax_breakdown.rateNo description in the spec
data.tax_breakdown.calculator_typeNo description in the spec
data.tax_breakdown.noticeNo description in the spec
data.discount_breakdownNo description in the spec
data.discount_breakdown.amountNo description in the spec
data.discount_breakdown.amount.typeNo description in the spec
data.discount_breakdown.amount.x-truncatedNo description in the spec
data.discount_breakdown.codeNo description in the spec
data.discount_breakdown.nameNo description in the spec
data.discount_breakdown.rateNo description in the spec
data.discount_breakdown.calculator_typeNo description in the spec
data.discount_breakdown.noticeNo description in the spec
data.expires_atNo description in the spec
Request
curl -X DELETE 'https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/lines/{cartLine_uuid}' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/lines/{cartLine_uuid}"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.delete(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/lines/{cartLine_uuid}";
const res = await fetch(url, {
method: "DELETE",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("DELETE", "https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/lines/{cartLine_uuid}", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/lines/{cartLine_uuid}");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": {
"uuid": "00000000-0000-0000-0000-000000000000",
"total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"sub_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"tax_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"credits_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"discount_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"remaining_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"credits_eligible_amount": {
"currency": "string",
"amount": "string",
"amount_minor": 1
}
}
}Show Cart Payment Method
GET
/public/{user_id}/cart/{cart_uuid}/payment-methodShow cart payment method.
Path parameters
user_idThe ID of the user.
cart_uuidNo description in the spec
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.typeNo description in the spec
data.is_defaultNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/payment-method' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/payment-method"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/payment-method";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/payment-method", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/payment-method");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": {
"uuid": "00000000-0000-0000-0000-000000000000",
"type": "string",
"is_default": true
}
}Update Cart Payment Method
PATCH
/public/{user_id}/cart/{cart_uuid}/payment-method/{paymentMethod_uuid}Update the Cart Payment Method.
Path parameters
user_idThe ID of the user.
cart_uuidNo description in the spec
paymentMethod_uuidNo description in the spec
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.totalNo description in the spec
data.total.currencyNo description in the spec
data.total.amountNo description in the spec
data.total.amount_minorNo description in the spec
data.sub_totalNo description in the spec
data.sub_total.currencyNo description in the spec
data.sub_total.amountNo description in the spec
data.sub_total.amount_minorNo description in the spec
data.tax_totalNo description in the spec
data.tax_total.currencyNo description in the spec
data.tax_total.amountNo description in the spec
data.tax_total.amount_minorNo description in the spec
data.credits_totalNo description in the spec
data.credits_total.currencyNo description in the spec
data.credits_total.amountNo description in the spec
data.credits_total.amount_minorNo description in the spec
data.discount_totalNo description in the spec
data.discount_total.currencyNo description in the spec
data.discount_total.amountNo description in the spec
data.discount_total.amount_minorNo description in the spec
data.remaining_totalNo description in the spec
data.remaining_total.currencyNo description in the spec
data.remaining_total.amountNo description in the spec
data.remaining_total.amount_minorNo description in the spec
data.credits_eligible_amountNo description in the spec
data.credits_eligible_amount.currencyNo description in the spec
data.credits_eligible_amount.amountNo description in the spec
data.credits_eligible_amount.amount_minorNo description in the spec
data.total_before_taxNo description in the spec
data.total_before_tax.currencyNo description in the spec
data.total_before_tax.amountNo description in the spec
data.total_before_tax.amount_minorNo description in the spec
data.tax_breakdownNo description in the spec
data.tax_breakdown.amountNo description in the spec
data.tax_breakdown.amount.typeNo description in the spec
data.tax_breakdown.amount.x-truncatedNo description in the spec
data.tax_breakdown.codeNo description in the spec
data.tax_breakdown.nameNo description in the spec
data.tax_breakdown.rateNo description in the spec
data.tax_breakdown.calculator_typeNo description in the spec
data.tax_breakdown.noticeNo description in the spec
data.discount_breakdownNo description in the spec
data.discount_breakdown.amountNo description in the spec
data.discount_breakdown.amount.typeNo description in the spec
data.discount_breakdown.amount.x-truncatedNo description in the spec
data.discount_breakdown.codeNo description in the spec
data.discount_breakdown.nameNo description in the spec
data.discount_breakdown.rateNo description in the spec
data.discount_breakdown.calculator_typeNo description in the spec
data.discount_breakdown.noticeNo description in the spec
data.expires_atNo description in the spec
Request
curl -X PATCH 'https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/payment-method/{paymentMethod_uuid}' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/payment-method/{paymentMethod_uuid}"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.patch(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/payment-method/{paymentMethod_uuid}";
const res = await fetch(url, {
method: "PATCH",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("PATCH", "https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/payment-method/{paymentMethod_uuid}", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/cart/{cart_uuid}/payment-method/{paymentMethod_uuid}");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": {
"uuid": "00000000-0000-0000-0000-000000000000",
"total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"sub_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"tax_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"credits_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"discount_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"remaining_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"credits_eligible_amount": {
"currency": "string",
"amount": "string",
"amount_minor": 1
}
}
}Add item to shopping cart
POST
/v1/{tenantUUID}/cart/itemsAdds new item to shopping cart. For LOA product type with AWS BYOIP provisioning, include aws_account_id, aws_service, and aws_region in product_fields.
Path parameters
tenantUUIDTenant UUID
Request body
product_typeProduct Type
ipv4 ipv6 loa asnbilling_cycleBilling Cycle
0 1 3 6 12 24labelService label
product_optionsProduct options are different per product.
Please lookup the options from the respective product endpoint
product_options.quantityNo description in the spec
product_options.quantity.<key1>No description in the spec
product_options.quantity.<key2>No description in the spec
product_options.quantity.<key..>No description in the spec
product_options.quantity.<keyN>No description in the spec
product_options.selectionNo description in the spec
product_options.selection.<key1>No description in the spec
product_options.selection.<key2>No description in the spec
product_options.selection.<key..>No description in the spec
product_options.selection.<keyN>No description in the spec
product_fieldsProduct fields are different per product, and requirements differ.
Please lookup the needed fields from the respective product endpoint
e.g. `/v1/{tenantUUID}/market/ipv4/product-info` for `ipv4`.
For LOA product type with AWS BYOIP, include aws_account_id, aws_service, and aws_region.
product_fields.<key1>No description in the spec
product_fields.<key2>No description in the spec
product_fields.<key..>No description in the spec
product_fields.<keyN>No description in the spec
product_fields.aws_account_idAWS account ID for BYOIP provisioning (LOA only)
product_fields.aws_serviceAWS service for BYOIP provisioning (LOA only)
product_fields.aws_regionAWS region for BYOIP provisioning (LOA only)
Request
curl -X POST 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/cart/items' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"product_type": "ipv4",
"billing_cycle": 0,
"label": "string",
"product_options": {
"quantity": {
"<key1>": 1,
"<key2>": 1,
"<key..>": 1,
"<keyN>": 1
},
"selection": {
"<key1>": "string",
"<key2>": "string",
"<key..>": "string",
"<keyN>": "string"
}
},
"product_fields": {
"<key1>": "string",
"<key2>": "string",
"<key..>": "string",
"<keyN>": "string",
"aws_account_id": "string",
"aws_service": "string",
"aws_region": "string"
}
}'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/cart/items"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = {
"product_type": "ipv4",
"billing_cycle": 0,
"label": "string",
"product_options": {
"quantity": {
"<key1>": 1,
"<key2>": 1,
"<key..>": 1,
"<keyN>": 1
},
"selection": {
"<key1>": "string",
"<key2>": "string",
"<key..>": "string",
"<keyN>": "string"
}
},
"product_fields": {
"<key1>": "string",
"<key2>": "string",
"<key..>": "string",
"<keyN>": "string",
"aws_account_id": "string",
"aws_service": "string",
"aws_region": "string"
}
}
r = requests.post(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/cart/items";
const res = await fetch(url, {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify({
"product_type": "ipv4",
"billing_cycle": 0,
"label": "string",
"product_options": {
"quantity": {
"<key1>": 1,
"<key2>": 1,
"<key..>": 1,
"<keyN>": 1
},
"selection": {
"<key1>": "string",
"<key2>": "string",
"<key..>": "string",
"<keyN>": "string"
}
},
"product_fields": {
"<key1>": "string",
"<key2>": "string",
"<key..>": "string",
"<keyN>": "string",
"aws_account_id": "string",
"aws_service": "string",
"aws_region": "string"
}
}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"product_type": "ipv4",
"billing_cycle": 0,
"label": "string",
"product_options": {
"quantity": {
"<key1>": 1,
"<key2>": 1,
"<key..>": 1,
"<keyN>": 1
},
"selection": {
"<key1>": "string",
"<key2>": "string",
"<key..>": "string",
"<keyN>": "string"
}
},
"product_fields": {
"<key1>": "string",
"<key2>": "string",
"<key..>": "string",
"<keyN>": "string",
"aws_account_id": "string",
"aws_service": "string",
"aws_region": "string"
}
}`)
req, _ := http.NewRequest("POST", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/cart/items", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/cart/items");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"product_type" => "ipv4",
"billing_cycle" => 0,
"label" => "string",
"product_options" => [
"quantity" => [
"<key1>" => 1,
"<key2>" => 1,
"<key..>" => 1,
"<keyN>" => 1
],
"selection" => [
"<key1>" => "string",
"<key2>" => "string",
"<key..>" => "string",
"<keyN>" => "string"
]
],
"product_fields" => [
"<key1>" => "string",
"<key2>" => "string",
"<key..>" => "string",
"<keyN>" => "string",
"aws_account_id" => "string",
"aws_service" => "string",
"aws_region" => "string"
]
]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
204
Successful operation
401
Unauthorized
403
Forbidden
404
Not Found
Get cart extra information
GET
/v1/{tenantUUID}/cart/{cartUUID}/extra-infoReturns extra information for all items in the specified cart
Path parameters
tenantUUIDTenant UUID
cartUUIDCart UUID
Response 200
dataNo description in the spec
data.cart_line_uuidCart line UUID
data.extraExtra information object
data.product_typeProduct type
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/cart/{cartUUID}/extra-info' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/cart/{cartUUID}/extra-info"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/cart/{cartUUID}/extra-info";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/cart/{cartUUID}/extra-info", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/cart/{cartUUID}/extra-info");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Cart items extra information collection
{
"data": [
{
"cart_line_uuid": "00000000-0000-0000-0000-000000000000",
"extra": {},
"product_type": "string"
}
]
}401
Unauthorized
403
Forbidden
404
Cart not found
Orders
15 operations
The object synthesised
The spec declares no named object for this resource, so the renderer synthesised one from its richest response body (POST /public/{user_id}/orders/{publicOrder}/discount-code/{discountCode_code}). Fields no endpoint returns cannot appear here.
Attributes
dataNo description in the spec
data.uuidNo description in the spec
data.statusNo description in the spec
data.placed_atNo description in the spec
data.expires_atNo description in the spec
data.sub_totalNo description in the spec
data.discount_totalNo description in the spec
data.tax_totalNo description in the spec
data.totalNo description in the spec
data.credits_totalNo description in the spec
data.remaining_totalNo description in the spec
data.total_before_taxNo description in the spec
data.tax_breakdownNo description in the spec
data.discount_breakdownNo description in the spec
data.enabled_free_checkoutNo description in the spec
data.auto_chargeNo description in the spec
List Orders
GET
/public/{user_id}/ordersReturns a list of Orders.
Path parameters
user_idThe ID of the user.
Query parameters
sortA comma-separated list of fields to sort. Multiple allowed. Prefix with `-` to sort descending.
filter[uuid]No description in the spec
filter[status]No description in the spec
filter[purchasable_uuid]No description in the spec
filter[purchasable_type]No description in the spec
filter[placed_at]No description in the spec
filter[reference_id]No description in the spec
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.statusNo description in the spec
data.placed_atNo description in the spec
data.expires_atNo description in the spec
data.sub_totalNo description in the spec
data.sub_total.currencyNo description in the spec
data.sub_total.amountNo description in the spec
data.sub_total.amount_minorNo description in the spec
data.discount_totalNo description in the spec
data.discount_total.currencyNo description in the spec
data.discount_total.amountNo description in the spec
data.discount_total.amount_minorNo description in the spec
data.tax_totalNo description in the spec
data.tax_total.currencyNo description in the spec
data.tax_total.amountNo description in the spec
data.tax_total.amount_minorNo description in the spec
data.credits_totalNo description in the spec
data.credits_total.currencyNo description in the spec
data.credits_total.amountNo description in the spec
data.credits_total.amount_minorNo description in the spec
data.totalNo description in the spec
data.total.currencyNo description in the spec
data.total.amountNo description in the spec
data.total.amount_minorNo description in the spec
data.remaining_totalNo description in the spec
data.remaining_total.currencyNo description in the spec
data.remaining_total.amountNo description in the spec
data.remaining_total.amount_minorNo description in the spec
data.total_before_taxNo description in the spec
data.total_before_tax.currencyNo description in the spec
data.total_before_tax.amountNo description in the spec
data.total_before_tax.amount_minorNo description in the spec
data.tax_breakdownNo description in the spec
data.tax_breakdown.amountNo description in the spec
data.tax_breakdown.codeNo description in the spec
data.tax_breakdown.nameNo description in the spec
data.tax_breakdown.rateNo description in the spec
data.tax_breakdown.calculator_typeNo description in the spec
data.tax_breakdown.noticeNo description in the spec
data.discount_breakdownNo description in the spec
data.discount_breakdown.amountNo description in the spec
data.discount_breakdown.codeNo description in the spec
data.discount_breakdown.nameNo description in the spec
data.discount_breakdown.rateNo description in the spec
data.discount_breakdown.calculator_typeNo description in the spec
data.discount_breakdown.noticeNo description in the spec
metaNo description in the spec
meta.current_pageNo description in the spec
meta.totalNo description in the spec
meta.per_pageNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/ecommerce/public/{user_id}/orders' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/orders");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": [
{
"uuid": "00000000-0000-0000-0000-000000000000",
"status": "string",
"placed_at": "string",
"expires_at": "string",
"sub_total": {
"currency": "string",
"amount": "string",
"amount_minor": "string"
},
"discount_total": {
"currency": "string",
"amount": "string",
"amount_minor": "string"
},
"tax_total": {
"currency": "string",
"amount": "string",
"amount_minor": "string"
},
"credits_total": {
"currency": "string",
"amount": "string",
"amount_minor": "string"
}
}
],
"meta": {
"current_page": 1,
"total": 1,
"per_page": 1
}
}Show Order
GET
/public/{user_id}/orders/{publicOrder_uuid}Returns a single Order extended information.
Path parameters
user_idThe ID of the user.
publicOrder_uuidNo description in the spec
Query parameters
includeA comma-separated list of relationships to include. Multiple parameters are allowed.
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.statusNo description in the spec
data.placed_atNo description in the spec
data.expires_atNo description in the spec
data.sub_totalNo description in the spec
data.sub_total.currencyNo description in the spec
data.sub_total.amountNo description in the spec
data.sub_total.amount_minorNo description in the spec
data.discount_totalNo description in the spec
data.discount_total.currencyNo description in the spec
data.discount_total.amountNo description in the spec
data.discount_total.amount_minorNo description in the spec
data.tax_totalNo description in the spec
data.tax_total.currencyNo description in the spec
data.tax_total.amountNo description in the spec
data.tax_total.amount_minorNo description in the spec
data.credits_totalNo description in the spec
data.credits_total.currencyNo description in the spec
data.credits_total.amountNo description in the spec
data.credits_total.amount_minorNo description in the spec
data.totalNo description in the spec
data.total.currencyNo description in the spec
data.total.amountNo description in the spec
data.total.amount_minorNo description in the spec
data.remaining_totalNo description in the spec
data.remaining_total.currencyNo description in the spec
data.remaining_total.amountNo description in the spec
data.remaining_total.amount_minorNo description in the spec
data.total_before_taxNo description in the spec
data.total_before_tax.currencyNo description in the spec
data.total_before_tax.amountNo description in the spec
data.total_before_tax.amount_minorNo description in the spec
data.tax_breakdownNo description in the spec
data.tax_breakdown.amountNo description in the spec
data.tax_breakdown.amount.typeNo description in the spec
data.tax_breakdown.amount.x-truncatedNo description in the spec
data.tax_breakdown.codeNo description in the spec
data.tax_breakdown.nameNo description in the spec
data.tax_breakdown.rateNo description in the spec
data.tax_breakdown.calculator_typeNo description in the spec
data.tax_breakdown.noticeNo description in the spec
data.discount_breakdownNo description in the spec
data.discount_breakdown.amountNo description in the spec
data.discount_breakdown.amount.typeNo description in the spec
data.discount_breakdown.amount.x-truncatedNo description in the spec
data.discount_breakdown.codeNo description in the spec
data.discount_breakdown.nameNo description in the spec
data.discount_breakdown.rateNo description in the spec
data.discount_breakdown.calculator_typeNo description in the spec
data.discount_breakdown.noticeNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder_uuid}' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder_uuid}"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder_uuid}";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder_uuid}", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder_uuid}");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": {
"uuid": "00000000-0000-0000-0000-000000000000",
"status": "string",
"placed_at": "string",
"expires_at": "string",
"sub_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"discount_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"tax_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"credits_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
}
}
}Create Order Address
POST
/public/{user_id}/orders/{publicOrder_uuid}/addresses/{customerAddress_id}Creates a new Order address.
Path parameters
user_idThe ID of the user.
publicOrder_uuidNo description in the spec
customerAddress_idThe ID of the customerAddress.
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.first_nameNo description in the spec
data.last_nameNo description in the spec
data.company_nameNo description in the spec
data.vat_numberNo description in the spec
data.vat_validation_statusNo description in the spec
data.vat_validated_atNo description in the spec
data.line_oneNo description in the spec
data.line_twoNo description in the spec
data.line_threeNo description in the spec
data.cityNo description in the spec
data.province_codeNo description in the spec
data.country_codeNo description in the spec
data.postcodeNo description in the spec
data.contact_emailNo description in the spec
data.contact_phoneNo description in the spec
data.company_codeNo description in the spec
Request
curl -X POST 'https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder_uuid}/addresses/{customerAddress_id}' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder_uuid}/addresses/{customerAddress_id}"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.post(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder_uuid}/addresses/{customerAddress_id}";
const res = await fetch(url, {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("POST", "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder_uuid}/addresses/{customerAddress_id}", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder_uuid}/addresses/{customerAddress_id}");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": {
"uuid": "00000000-0000-0000-0000-000000000000",
"first_name": "string",
"last_name": "string",
"company_name": "string",
"vat_number": "string",
"vat_validation_status": "string",
"vat_validated_at": "string",
"line_one": "string"
}
}Update Order Address
PATCH
/public/{user_id}/orders/{publicOrder_uuid}/addresses/{customerAddress_id}Updates an Order address.
Path parameters
user_idThe ID of the user.
publicOrder_uuidNo description in the spec
customerAddress_idThe ID of the customerAddress.
Request body
line_oneMust not be greater than 255 characters.
line_twoMust not be greater than 255 characters.
cityMust not be greater than 255 characters.
postcodeMust not be greater than 20 characters.
province_codeMust not be greater than 10 characters.
contact_emailMust be a valid email address. Must not be greater than 255 characters.
vat_numberMust not be greater than 50 characters.
company_codeMust not be greater than 50 characters.
first_nameMust not be greater than 255 characters.
last_nameMust not be greater than 255 characters.
company_nameMust not be greater than 255 characters.
contact_phoneMust not be greater than 50 characters.
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.first_nameNo description in the spec
data.last_nameNo description in the spec
data.company_nameNo description in the spec
data.vat_numberNo description in the spec
data.vat_validation_statusNo description in the spec
data.vat_validated_atNo description in the spec
data.line_oneNo description in the spec
data.line_twoNo description in the spec
data.line_threeNo description in the spec
data.cityNo description in the spec
data.province_codeNo description in the spec
data.country_codeNo description in the spec
data.postcodeNo description in the spec
data.contact_emailNo description in the spec
data.contact_phoneNo description in the spec
data.company_codeNo description in the spec
data.async_processing_requiredNo description in the spec
Request
curl -X PATCH 'https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder_uuid}/addresses/{customerAddress_id}' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"line_one": "string",
"line_two": "string",
"city": "string",
"postcode": "string",
"province_code": "string",
"contact_email": "[email protected]",
"vat_number": "string",
"company_code": "string"
}'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder_uuid}/addresses/{customerAddress_id}"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = {
"line_one": "string",
"line_two": "string",
"city": "string",
"postcode": "string",
"province_code": "string",
"contact_email": "[email protected]",
"vat_number": "string",
"company_code": "string"
}
r = requests.patch(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder_uuid}/addresses/{customerAddress_id}";
const res = await fetch(url, {
method: "PATCH",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify({
"line_one": "string",
"line_two": "string",
"city": "string",
"postcode": "string",
"province_code": "string",
"contact_email": "[email protected]",
"vat_number": "string",
"company_code": "string"
}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"line_one": "string",
"line_two": "string",
"city": "string",
"postcode": "string",
"province_code": "string",
"contact_email": "[email protected]",
"vat_number": "string",
"company_code": "string"
}`)
req, _ := http.NewRequest("PATCH", "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder_uuid}/addresses/{customerAddress_id}", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder_uuid}/addresses/{customerAddress_id}");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"line_one" => "string",
"line_two" => "string",
"city" => "string",
"postcode" => "string",
"province_code" => "string",
"contact_email" => "[email protected]",
"vat_number" => "string",
"company_code" => "string"
]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": {
"uuid": "00000000-0000-0000-0000-000000000000",
"first_name": "string",
"last_name": "string",
"company_name": "string",
"vat_number": "string",
"vat_validation_status": "string",
"vat_validated_at": "string",
"line_one": "string"
}
}Checkout Order
POST
/public/{user_id}/orders/{publicOrder_uuid}/checkoutCheckout the Order.
Path parameters
user_idThe ID of the user.
publicOrder_uuidNo description in the spec
Response 200
dataNo description in the spec
data.orderNo description in the spec
data.order.uuidNo description in the spec
data.order.statusNo description in the spec
data.order.placed_atNo description in the spec
data.order.expires_atNo description in the spec
data.order.sub_totalNo description in the spec
data.order.sub_total.currencyNo description in the spec
data.order.sub_total.amountNo description in the spec
data.order.sub_total.amount_minorNo description in the spec
data.order.discount_totalNo description in the spec
data.order.discount_total.currencyNo description in the spec
data.order.discount_total.amountNo description in the spec
data.order.discount_total.amount_minorNo description in the spec
data.order.tax_totalNo description in the spec
data.order.tax_total.currencyNo description in the spec
data.order.tax_total.amountNo description in the spec
data.order.tax_total.amount_minorNo description in the spec
data.order.credits_totalNo description in the spec
data.order.credits_total.currencyNo description in the spec
data.order.credits_total.amountNo description in the spec
data.order.credits_total.amount_minorNo description in the spec
data.order.totalNo description in the spec
data.order.total.currencyNo description in the spec
data.order.total.amountNo description in the spec
data.order.total.amount_minorNo description in the spec
data.order.remaining_totalNo description in the spec
data.order.remaining_total.currencyNo description in the spec
data.order.remaining_total.amountNo description in the spec
data.order.remaining_total.amount_minorNo description in the spec
data.order.total_before_taxNo description in the spec
data.order.total_before_tax.currencyNo description in the spec
data.order.total_before_tax.amountNo description in the spec
data.order.total_before_tax.amount_minorNo description in the spec
data.order.tax_breakdownNo description in the spec
data.order.tax_breakdown.typeNo description in the spec
data.order.tax_breakdown.x-truncatedNo description in the spec
data.order.discount_breakdownNo description in the spec
data.order.discount_breakdown.typeNo description in the spec
data.order.discount_breakdown.x-truncatedNo description in the spec
data.payment_responseNo description in the spec
data.payment_response.keyNo description in the spec
Request
curl -X POST 'https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder_uuid}/checkout' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder_uuid}/checkout"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.post(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder_uuid}/checkout";
const res = await fetch(url, {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("POST", "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder_uuid}/checkout", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder_uuid}/checkout");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": {
"order": {
"uuid": "00000000-0000-0000-0000-000000000000",
"status": "string",
"placed_at": "string",
"expires_at": "string",
"sub_total": {
"currency": {},
"amount": {},
"amount_minor": {}
},
"discount_total": {
"currency": {},
"amount": {},
"amount_minor": {}
},
"tax_total": {
"currency": {},
"amount": {},
"amount_minor": {}
},
"credits_total": {
"currency": {},
"amount": {},
"amount_minor": {}
}
},
"payment_response": {
"key": "string"
}
}
}Download Order
GET
/public/{user_id}/orders/{publicOrder_uuid}/downloadDownload an Order.
Path parameters
user_idThe ID of the user.
publicOrder_uuidNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder_uuid}/download' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder_uuid}/download"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder_uuid}/download";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder_uuid}/download", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder_uuid}/download");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Successfully generated and returned an Order file.
{}List Order Lines
GET
/public/{user_id}/orders/{publicOrder_uuid}/linesList the Order Lines.
Path parameters
user_idThe ID of the user.
publicOrder_uuidNo description in the spec
Query parameters
includeA comma-separated list of relationships to include. Multiple parameters are allowed.
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.titleNo description in the spec
data.descriptionNo description in the spec
data.quantityNo description in the spec
data.unit_quantityNo description in the spec
data.exchange_rateNo description in the spec
data.exchange_rate_fetched_atNo description in the spec
data.unit_priceNo description in the spec
data.unit_price.currencyNo description in the spec
data.unit_price.amountNo description in the spec
data.unit_price.amount_minorNo description in the spec
data.sub_totalNo description in the spec
data.sub_total.currencyNo description in the spec
data.sub_total.amountNo description in the spec
data.sub_total.amount_minorNo description in the spec
data.discount_totalNo description in the spec
data.discount_total.currencyNo description in the spec
data.discount_total.amountNo description in the spec
data.discount_total.amount_minorNo description in the spec
data.tax_totalNo description in the spec
data.tax_total.currencyNo description in the spec
data.tax_total.amountNo description in the spec
data.tax_total.amount_minorNo description in the spec
data.totalNo description in the spec
data.total.currencyNo description in the spec
data.total.amountNo description in the spec
data.total.amount_minorNo description in the spec
data.total_before_taxNo description in the spec
data.total_before_tax.currencyNo description in the spec
data.total_before_tax.amountNo description in the spec
data.total_before_tax.amount_minorNo description in the spec
data.notesNo description in the spec
metaNo description in the spec
meta.current_pageNo description in the spec
meta.totalNo description in the spec
meta.per_pageNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder_uuid}/lines' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder_uuid}/lines"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder_uuid}/lines";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder_uuid}/lines", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder_uuid}/lines");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": [
{
"uuid": "00000000-0000-0000-0000-000000000000",
"title": "string",
"description": "string",
"quantity": 1,
"unit_quantity": 1,
"exchange_rate": "string",
"exchange_rate_fetched_at": "string",
"unit_price": {
"currency": "string",
"amount": "string",
"amount_minor": "string"
}
}
],
"meta": {
"current_page": 1,
"total": 1,
"per_page": 1
}
}List Refunds for Order
GET
/public/{user_id}/orders/{publicOrder_uuid}/refundsList all Refunds for Order.
Path parameters
user_idThe ID of the user.
publicOrder_uuidNo description in the spec
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.invoice_idNo description in the spec
data.order_uuidNo description in the spec
data.reference_idNo description in the spec
data.refund_reasonNo description in the spec
data.refund_methodNo description in the spec
data.statusNo description in the spec
data.tax_totalNo description in the spec
data.tax_total.currencyNo description in the spec
data.tax_total.amountNo description in the spec
data.tax_total.amount_minorNo description in the spec
data.totalNo description in the spec
data.total.currencyNo description in the spec
data.total.amountNo description in the spec
data.total.amount_minorNo description in the spec
data.itemsNo description in the spec
data.items.dataNo description in the spec
metaNo description in the spec
meta.current_pageNo description in the spec
meta.totalNo description in the spec
meta.per_pageNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder_uuid}/refunds' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder_uuid}/refunds"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder_uuid}/refunds";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder_uuid}/refunds", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder_uuid}/refunds");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": [
{
"uuid": "00000000-0000-0000-0000-000000000000",
"invoice_id": "string",
"order_uuid": "00000000-0000-0000-0000-000000000000",
"reference_id": "string",
"refund_reason": "string",
"refund_method": "string",
"status": "string",
"tax_total": {
"currency": "string",
"amount": "string",
"amount_minor": "string"
}
}
],
"meta": {
"current_page": 1,
"total": 1,
"per_page": 1
}
}List Order Transactions
GET
/public/{user_id}/orders/{publicOrder_uuid}/transactionsList the Order Transactions.
Path parameters
user_idThe ID of the user.
publicOrder_uuidNo description in the spec
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.typeNo description in the spec
data.statusNo description in the spec
data.gateway_driverNo description in the spec
data.amountNo description in the spec
data.amount.currencyNo description in the spec
data.amount.amountNo description in the spec
data.amount.amount_minorNo description in the spec
data.referenceNo description in the spec
data.initiated_atNo description in the spec
data.created_atNo description in the spec
metaNo description in the spec
meta.current_pageNo description in the spec
meta.totalNo description in the spec
meta.per_pageNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder_uuid}/transactions' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder_uuid}/transactions"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder_uuid}/transactions";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder_uuid}/transactions", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder_uuid}/transactions");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": [
{
"uuid": "00000000-0000-0000-0000-000000000000",
"type": "string",
"status": "string",
"gateway_driver": "string",
"amount": {
"currency": "string",
"amount": "string",
"amount_minor": "string"
},
"reference": "string",
"initiated_at": "string",
"created_at": "string"
}
],
"meta": {
"current_page": 1,
"total": 1,
"per_page": 1
}
}Remove Credits From Order
DELETE
/public/{user_id}/orders/{publicOrder}/creditsRemove Credits from Order
Path parameters
user_idThe ID of the user.
publicOrderNo description in the spec
Request body
amountNo description in the spec
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.statusNo description in the spec
data.placed_atNo description in the spec
data.expires_atNo description in the spec
data.sub_totalNo description in the spec
data.sub_total.currencyNo description in the spec
data.sub_total.amountNo description in the spec
data.sub_total.amount_minorNo description in the spec
data.discount_totalNo description in the spec
data.discount_total.currencyNo description in the spec
data.discount_total.amountNo description in the spec
data.discount_total.amount_minorNo description in the spec
data.tax_totalNo description in the spec
data.tax_total.currencyNo description in the spec
data.tax_total.amountNo description in the spec
data.tax_total.amount_minorNo description in the spec
data.credits_totalNo description in the spec
data.credits_total.currencyNo description in the spec
data.credits_total.amountNo description in the spec
data.credits_total.amount_minorNo description in the spec
data.totalNo description in the spec
data.total.currencyNo description in the spec
data.total.amountNo description in the spec
data.total.amount_minorNo description in the spec
data.remaining_totalNo description in the spec
data.remaining_total.currencyNo description in the spec
data.remaining_total.amountNo description in the spec
data.remaining_total.amount_minorNo description in the spec
data.total_before_taxNo description in the spec
data.total_before_tax.currencyNo description in the spec
data.total_before_tax.amountNo description in the spec
data.total_before_tax.amount_minorNo description in the spec
data.tax_breakdownNo description in the spec
data.tax_breakdown.amountNo description in the spec
data.tax_breakdown.amount.typeNo description in the spec
data.tax_breakdown.amount.x-truncatedNo description in the spec
data.tax_breakdown.codeNo description in the spec
data.tax_breakdown.nameNo description in the spec
data.tax_breakdown.rateNo description in the spec
data.tax_breakdown.calculator_typeNo description in the spec
data.tax_breakdown.noticeNo description in the spec
data.discount_breakdownNo description in the spec
data.discount_breakdown.amountNo description in the spec
data.discount_breakdown.amount.typeNo description in the spec
data.discount_breakdown.amount.x-truncatedNo description in the spec
data.discount_breakdown.codeNo description in the spec
data.discount_breakdown.nameNo description in the spec
data.discount_breakdown.rateNo description in the spec
data.discount_breakdown.calculator_typeNo description in the spec
data.discount_breakdown.noticeNo description in the spec
Request
curl -X DELETE 'https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder}/credits' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"amount": 1.0
}'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder}/credits"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = {
"amount": 1.0
}
r = requests.delete(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder}/credits";
const res = await fetch(url, {
method: "DELETE",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify({
"amount": 1.0
}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"amount": 1.0
}`)
req, _ := http.NewRequest("DELETE", "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder}/credits", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder}/credits");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"amount" => 1.0
]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": {
"uuid": "00000000-0000-0000-0000-000000000000",
"status": "string",
"placed_at": "string",
"expires_at": "string",
"sub_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"discount_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"tax_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"credits_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
}
}
}Apply Credits To Order
POST
/public/{user_id}/orders/{publicOrder}/credits/applyApply Credits to Order
Path parameters
user_idThe ID of the user.
publicOrderNo description in the spec
Request body
amountMust be at least 0.
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.statusNo description in the spec
data.placed_atNo description in the spec
data.expires_atNo description in the spec
data.sub_totalNo description in the spec
data.sub_total.currencyNo description in the spec
data.sub_total.amountNo description in the spec
data.sub_total.amount_minorNo description in the spec
data.discount_totalNo description in the spec
data.discount_total.currencyNo description in the spec
data.discount_total.amountNo description in the spec
data.discount_total.amount_minorNo description in the spec
data.tax_totalNo description in the spec
data.tax_total.currencyNo description in the spec
data.tax_total.amountNo description in the spec
data.tax_total.amount_minorNo description in the spec
data.credits_totalNo description in the spec
data.credits_total.currencyNo description in the spec
data.credits_total.amountNo description in the spec
data.credits_total.amount_minorNo description in the spec
data.totalNo description in the spec
data.total.currencyNo description in the spec
data.total.amountNo description in the spec
data.total.amount_minorNo description in the spec
data.remaining_totalNo description in the spec
data.remaining_total.currencyNo description in the spec
data.remaining_total.amountNo description in the spec
data.remaining_total.amount_minorNo description in the spec
data.total_before_taxNo description in the spec
data.total_before_tax.currencyNo description in the spec
data.total_before_tax.amountNo description in the spec
data.total_before_tax.amount_minorNo description in the spec
data.tax_breakdownNo description in the spec
data.tax_breakdown.amountNo description in the spec
data.tax_breakdown.amount.typeNo description in the spec
data.tax_breakdown.amount.x-truncatedNo description in the spec
data.tax_breakdown.codeNo description in the spec
data.tax_breakdown.nameNo description in the spec
data.tax_breakdown.rateNo description in the spec
data.tax_breakdown.calculator_typeNo description in the spec
data.tax_breakdown.noticeNo description in the spec
data.discount_breakdownNo description in the spec
data.discount_breakdown.amountNo description in the spec
data.discount_breakdown.amount.typeNo description in the spec
data.discount_breakdown.amount.x-truncatedNo description in the spec
data.discount_breakdown.codeNo description in the spec
data.discount_breakdown.nameNo description in the spec
data.discount_breakdown.rateNo description in the spec
data.discount_breakdown.calculator_typeNo description in the spec
data.discount_breakdown.noticeNo description in the spec
Request
curl -X POST 'https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder}/credits/apply' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"amount": 1.0
}'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder}/credits/apply"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = {
"amount": 1.0
}
r = requests.post(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder}/credits/apply";
const res = await fetch(url, {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify({
"amount": 1.0
}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"amount": 1.0
}`)
req, _ := http.NewRequest("POST", "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder}/credits/apply", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder}/credits/apply");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"amount" => 1.0
]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": {
"uuid": "00000000-0000-0000-0000-000000000000",
"status": "string",
"placed_at": "string",
"expires_at": "string",
"sub_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"discount_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"tax_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"credits_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
}
}
}Apply Discount Code To Order
POST
/public/{user_id}/orders/{publicOrder}/discount-code/{discountCode_code}Apply Discount Code to Order
Path parameters
user_idThe ID of the user.
publicOrderNo description in the spec
discountCode_codeNo description in the spec
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.statusNo description in the spec
data.placed_atNo description in the spec
data.expires_atNo description in the spec
data.sub_totalNo description in the spec
data.sub_total.currencyNo description in the spec
data.sub_total.amountNo description in the spec
data.sub_total.amount_minorNo description in the spec
data.discount_totalNo description in the spec
data.discount_total.currencyNo description in the spec
data.discount_total.amountNo description in the spec
data.discount_total.amount_minorNo description in the spec
data.tax_totalNo description in the spec
data.tax_total.currencyNo description in the spec
data.tax_total.amountNo description in the spec
data.tax_total.amount_minorNo description in the spec
data.totalNo description in the spec
data.total.currencyNo description in the spec
data.total.amountNo description in the spec
data.total.amount_minorNo description in the spec
data.credits_totalNo description in the spec
data.credits_total.currencyNo description in the spec
data.credits_total.amountNo description in the spec
data.credits_total.amount_minorNo description in the spec
data.remaining_totalNo description in the spec
data.remaining_total.currencyNo description in the spec
data.remaining_total.amountNo description in the spec
data.remaining_total.amount_minorNo description in the spec
data.total_before_taxNo description in the spec
data.total_before_tax.currencyNo description in the spec
data.total_before_tax.amountNo description in the spec
data.total_before_tax.amount_minorNo description in the spec
data.tax_breakdownNo description in the spec
data.tax_breakdown.amountNo description in the spec
data.tax_breakdown.amount.typeNo description in the spec
data.tax_breakdown.amount.x-truncatedNo description in the spec
data.tax_breakdown.codeNo description in the spec
data.tax_breakdown.nameNo description in the spec
data.tax_breakdown.rateNo description in the spec
data.tax_breakdown.calculator_typeNo description in the spec
data.tax_breakdown.noticeNo description in the spec
data.discount_breakdownNo description in the spec
data.discount_breakdown.amountNo description in the spec
data.discount_breakdown.amount.typeNo description in the spec
data.discount_breakdown.amount.x-truncatedNo description in the spec
data.discount_breakdown.codeNo description in the spec
data.discount_breakdown.nameNo description in the spec
data.discount_breakdown.rateNo description in the spec
data.discount_breakdown.calculator_typeNo description in the spec
data.discount_breakdown.noticeNo description in the spec
data.enabled_free_checkoutNo description in the spec
data.auto_chargeNo description in the spec
Request
curl -X POST 'https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder}/discount-code/{discountCode_code}' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder}/discount-code/{discountCode_code}"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.post(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder}/discount-code/{discountCode_code}";
const res = await fetch(url, {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("POST", "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder}/discount-code/{discountCode_code}", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder}/discount-code/{discountCode_code}");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": {
"uuid": "00000000-0000-0000-0000-000000000000",
"status": "string",
"placed_at": "string",
"expires_at": "string",
"sub_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"discount_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"tax_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
}
}
}Remove Discount Code
DELETE
/public/{user_id}/orders/{publicOrder}/discount-code/{discountCode_code}Remove discount code from order.
Path parameters
user_idThe ID of the user.
publicOrderNo description in the spec
discountCode_codeNo description in the spec
Request
curl -X DELETE 'https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder}/discount-code/{discountCode_code}' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder}/discount-code/{discountCode_code}"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.delete(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder}/discount-code/{discountCode_code}";
const res = await fetch(url, {
method: "DELETE",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("DELETE", "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder}/discount-code/{discountCode_code}", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder}/discount-code/{discountCode_code}");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
204
Successfully removed discount code from order
{}Show Payment Method
GET
/public/{user_id}/orders/{publicOrder}/payment-methodShow Order payment method
Path parameters
user_idThe ID of the user.
publicOrderNo description in the spec
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.typeNo description in the spec
data.is_defaultNo description in the spec
data.detailsNo description in the spec
data.details.card_brandNo description in the spec
data.details.card_last_fourNo description in the spec
data.details.card_expiry_monthNo description in the spec
data.details.card_expiry_yearNo description in the spec
data.statusNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder}/payment-method' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder}/payment-method"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder}/payment-method";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder}/payment-method", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder}/payment-method");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": {
"uuid": "00000000-0000-0000-0000-000000000000",
"type": "string",
"is_default": true,
"details": {
"card_brand": "string",
"card_last_four": "string",
"card_expiry_month": 1,
"card_expiry_year": 1
},
"status": "string"
}
}Update Payment Method
PATCH
/public/{user_id}/orders/{publicOrder}/payment-methods/{paymentMethod_uuid}Update a Payment Method to Order
Path parameters
user_idThe ID of the user.
publicOrderNo description in the spec
paymentMethod_uuidNo description in the spec
Request
curl -X PATCH 'https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder}/payment-methods/{paymentMethod_uuid}' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder}/payment-methods/{paymentMethod_uuid}"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.patch(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder}/payment-methods/{paymentMethod_uuid}";
const res = await fetch(url, {
method: "PATCH",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("PATCH", "https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder}/payment-methods/{paymentMethod_uuid}", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/orders/{publicOrder}/payment-methods/{paymentMethod_uuid}");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
204
Successfully Updated Payment Method to Order
{}Subscriptions
12 operations
The object synthesised
The spec declares no named object for this resource, so the renderer synthesised one from its richest response body (GET /public/{user_id}/subscriptions). Fields no endpoint returns cannot appear here.
Attributes
dataNo description in the spec
data.uuidNo description in the spec
data.nameNo description in the spec
data.short_descriptionNo description in the spec
data.statusNo description in the spec
data.current_period_startNo description in the spec
data.current_period_endNo description in the spec
data.previous_period_startNo description in the spec
data.previous_period_endNo description in the spec
data.started_atNo description in the spec
data.terminated_atNo description in the spec
data.terminate_atNo description in the spec
data.terminate_at_period_endNo description in the spec
data.is_scheduled_for_terminationNo description in the spec
data.billing_anchor_dayNo description in the spec
data.customerNo description in the spec
data.totalNo description in the spec
data.sub_totalNo description in the spec
data.discount_totalNo description in the spec
data.current_phaseNo description in the spec
data.has_immediate_terminationNo description in the spec
data.is_in_grace_periodNo description in the spec
data.expires_atNo description in the spec
data.reference_idNo description in the spec
data.order_uuidNo description in the spec
metaNo description in the spec
meta.current_pageNo description in the spec
meta.totalNo description in the spec
meta.per_pageNo description in the spec
List Billing Settings
GET
/public/{user_id}/billing-settingsList all Billing Settings.
Path parameters
user_idThe ID of the user.
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.billing_anchor_dayNo description in the spec
data.payment_term_daysNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/ecommerce/public/{user_id}/billing-settings' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/billing-settings"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/billing-settings";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/ecommerce/public/{user_id}/billing-settings", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/billing-settings");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": {
"uuid": "00000000-0000-0000-0000-000000000000",
"billing_anchor_day": 1,
"payment_term_days": 1
}
}Update Billing Settings
PATCH
/public/{user_id}/billing-settingsUpdate Billing Settings
Path parameters
user_idThe ID of the user.
Request body
billing_anchor_dayNo description in the spec
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.billing_anchor_dayNo description in the spec
data.payment_term_daysNo description in the spec
Request
curl -X PATCH 'https://apigw.ipxo.com/ecommerce/public/{user_id}/billing-settings' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"billing_anchor_day": "string"
}'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/billing-settings"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = {
"billing_anchor_day": "string"
}
r = requests.patch(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/billing-settings";
const res = await fetch(url, {
method: "PATCH",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify({
"billing_anchor_day": "string"
}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"billing_anchor_day": "string"
}`)
req, _ := http.NewRequest("PATCH", "https://apigw.ipxo.com/ecommerce/public/{user_id}/billing-settings", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/billing-settings");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"billing_anchor_day" => "string"
]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": {
"uuid": "00000000-0000-0000-0000-000000000000",
"billing_anchor_day": 1,
"payment_term_days": 1
}
}201
Successfully created and updated
{}List Subscription Category Views
GET
/public/{user_id}/subscription-category-viewsReturns a list of subscription category views for the customer.
Path parameters
user_idThe ID of the user.
Query parameters
filter[category_id]No description in the spec
filter[status]No description in the spec
filter[statuses]No description in the spec
sortA comma-separated list of fields to sort. Multiple allowed. Prefix with `-` to sort descending.
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.subscription_idNo description in the spec
data.subscription_nameNo description in the spec
data.statusNo description in the spec
data.product_category_idNo description in the spec
data.product_category_nameNo description in the spec
data.purchasable_idNo description in the spec
data.purchasable_typeNo description in the spec
data.customer_idNo description in the spec
metaNo description in the spec
meta.current_pageNo description in the spec
meta.totalNo description in the spec
meta.per_pageNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/ecommerce/public/{user_id}/subscription-category-views' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/subscription-category-views"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/subscription-category-views";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/ecommerce/public/{user_id}/subscription-category-views", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/subscription-category-views");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": [
{
"uuid": "00000000-0000-0000-0000-000000000000",
"subscription_id": "string",
"subscription_name": "string",
"status": "string",
"product_category_id": "string",
"product_category_name": "string",
"purchasable_id": "string",
"purchasable_type": "string"
}
],
"meta": {
"current_page": 1,
"total": 1,
"per_page": 1
}
}List Subscriptions
GET
/public/{user_id}/subscriptionsList all Subscriptions.
Path parameters
user_idThe ID of the user.
Query parameters
filter[status]No description in the spec
filter[name]No description in the spec
filter[current_period_end]No description in the spec
includeA comma-separated list of relationships to include. Multiple parameters are allowed.
sortA comma-separated list of fields to sort. Multiple allowed. Prefix with `-` to sort descending.
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.nameNo description in the spec
data.short_descriptionNo description in the spec
data.statusNo description in the spec
data.current_period_startNo description in the spec
data.current_period_endNo description in the spec
data.previous_period_startNo description in the spec
data.previous_period_endNo description in the spec
data.started_atNo description in the spec
data.terminated_atNo description in the spec
data.terminate_atNo description in the spec
data.terminate_at_period_endNo description in the spec
data.is_scheduled_for_terminationNo description in the spec
data.billing_anchor_dayNo description in the spec
data.customerNo description in the spec
data.customer.uuidNo description in the spec
data.customer.auth_idNo description in the spec
data.customer.nameNo description in the spec
data.customer.business_entity_idNo description in the spec
data.customer.currencyNo description in the spec
data.totalNo description in the spec
data.total.currencyNo description in the spec
data.total.amountNo description in the spec
data.total.amount_minorNo description in the spec
data.sub_totalNo description in the spec
data.sub_total.currencyNo description in the spec
data.sub_total.amountNo description in the spec
data.sub_total.amount_minorNo description in the spec
data.discount_totalNo description in the spec
data.discount_total.currencyNo description in the spec
data.discount_total.amountNo description in the spec
data.discount_total.amount_minorNo description in the spec
data.current_phaseNo description in the spec
data.current_phase.uuidNo description in the spec
data.current_phase.nameNo description in the spec
data.current_phase.short_descriptionNo description in the spec
data.current_phase.start_atNo description in the spec
data.current_phase.occurrenceNo description in the spec
data.current_phase.periodNo description in the spec
data.current_phase.end_atNo description in the spec
data.current_phase.statusNo description in the spec
data.current_phase.created_atNo description in the spec
data.has_immediate_terminationNo description in the spec
data.is_in_grace_periodNo description in the spec
data.expires_atNo description in the spec
data.reference_idNo description in the spec
data.order_uuidNo description in the spec
metaNo description in the spec
meta.current_pageNo description in the spec
meta.totalNo description in the spec
meta.per_pageNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": [
{
"uuid": "00000000-0000-0000-0000-000000000000",
"name": "string",
"short_description": "string",
"status": "string",
"current_period_start": "string",
"current_period_end": "string",
"previous_period_start": "string",
"previous_period_end": "string"
}
],
"meta": {
"current_page": 1,
"total": 1,
"per_page": 1
}
}Search Subscriptions
POST
/public/{user_id}/subscriptions/searchSearch subscriptions with enhanced filtering capabilities including UUID arrays.
Path parameters
user_idThe ID of the user.
Request body
per_pageNumber of results per page. Must be at least 1. Must not be greater than 100.
pagePage number for pagination. Must be at least 1.
sortSort by field. Prefix with - for descending order.
includeComma-separated list of relationships to include.
filterObject containing filter criteria.
filter.statusNo description in the spec
filter.nameMust not be greater than 255 characters.
filter.current_period_endMust be a valid date.
filter.uuidsThis field is required when <code>filter.uuids</code> is present. Must be a valid UUID.
filter.customerNo description in the spec
filter.customer.user_idMust not be greater than 255 characters.
filter.customer.nameMust not be greater than 255 characters.
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.nameNo description in the spec
data.short_descriptionNo description in the spec
data.statusNo description in the spec
data.current_period_startNo description in the spec
data.current_period_endNo description in the spec
data.previous_period_startNo description in the spec
data.previous_period_endNo description in the spec
data.started_atNo description in the spec
data.terminated_atNo description in the spec
data.terminate_atNo description in the spec
data.terminate_at_period_endNo description in the spec
data.is_scheduled_for_terminationNo description in the spec
data.billing_anchor_dayNo description in the spec
data.customerNo description in the spec
data.customer.uuidNo description in the spec
data.customer.auth_idNo description in the spec
data.customer.nameNo description in the spec
data.customer.business_entity_idNo description in the spec
data.customer.currencyNo description in the spec
data.totalNo description in the spec
data.total.currencyNo description in the spec
data.total.amountNo description in the spec
data.total.amount_minorNo description in the spec
data.sub_totalNo description in the spec
data.sub_total.currencyNo description in the spec
data.sub_total.amountNo description in the spec
data.sub_total.amount_minorNo description in the spec
data.discount_totalNo description in the spec
data.discount_total.currencyNo description in the spec
data.discount_total.amountNo description in the spec
data.discount_total.amount_minorNo description in the spec
data.current_phaseNo description in the spec
data.current_phase.uuidNo description in the spec
data.current_phase.nameNo description in the spec
data.current_phase.short_descriptionNo description in the spec
data.current_phase.start_atNo description in the spec
data.current_phase.occurrenceNo description in the spec
data.current_phase.periodNo description in the spec
data.current_phase.end_atNo description in the spec
data.current_phase.statusNo description in the spec
data.current_phase.created_atNo description in the spec
data.has_immediate_terminationNo description in the spec
data.is_in_grace_periodNo description in the spec
data.expires_atNo description in the spec
data.reference_idNo description in the spec
data.order_uuidNo description in the spec
metaNo description in the spec
meta.current_pageNo description in the spec
meta.totalNo description in the spec
meta.per_pageNo description in the spec
Request
curl -X POST 'https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions/search' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"per_page": 1,
"page": 1,
"sort": "string",
"include": "string",
"filter": {
"status": "string",
"name": "string",
"current_period_end": "string",
"uuids": [
"00000000-0000-0000-0000-000000000000"
],
"customer": {
"user_id": "string",
"name": "string"
}
}
}'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions/search"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = {
"per_page": 1,
"page": 1,
"sort": "string",
"include": "string",
"filter": {
"status": "string",
"name": "string",
"current_period_end": "string",
"uuids": [
"00000000-0000-0000-0000-000000000000"
],
"customer": {
"user_id": "string",
"name": "string"
}
}
}
r = requests.post(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions/search";
const res = await fetch(url, {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify({
"per_page": 1,
"page": 1,
"sort": "string",
"include": "string",
"filter": {
"status": "string",
"name": "string",
"current_period_end": "string",
"uuids": [
"00000000-0000-0000-0000-000000000000"
],
"customer": {
"user_id": "string",
"name": "string"
}
}
}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"per_page": 1,
"page": 1,
"sort": "string",
"include": "string",
"filter": {
"status": "string",
"name": "string",
"current_period_end": "string",
"uuids": [
"00000000-0000-0000-0000-000000000000"
],
"customer": {
"user_id": "string",
"name": "string"
}
}
}`)
req, _ := http.NewRequest("POST", "https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions/search", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions/search");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"per_page" => 1,
"page" => 1,
"sort" => "string",
"include" => "string",
"filter" => [
"status" => "string",
"name" => "string",
"current_period_end" => "string",
"uuids" => ["00000000-0000-0000-0000-000000000000"],
"customer" => [
"user_id" => "string",
"name" => "string"
]
]
]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": [
{
"uuid": "00000000-0000-0000-0000-000000000000",
"name": "string",
"short_description": "string",
"status": "string",
"current_period_start": "string",
"current_period_end": "string",
"previous_period_start": "string",
"previous_period_end": "string"
}
],
"meta": {
"current_page": 1,
"total": 1,
"per_page": 1
}
}List Customer Termination Requests
GET
/public/{user_id}/subscriptions/termination-requestsReturns a list of Termination Requests for the authenticated customer
Path parameters
user_idThe ID of the user.
Query parameters
filter[subscription_id]No description in the spec
filter[status]No description in the spec
sortA comma-separated list of fields to sort. Multiple allowed. Prefix with `-` to sort descending.
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.typeNo description in the spec
data.statusNo description in the spec
data.reasonNo description in the spec
data.detailsNo description in the spec
data.metaNo description in the spec
data.meta.use_againNo description in the spec
data.requested_atNo description in the spec
data.terminated_atNo description in the spec
metaNo description in the spec
meta.current_pageNo description in the spec
meta.totalNo description in the spec
meta.per_pageNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions/termination-requests' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions/termination-requests"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions/termination-requests";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions/termination-requests", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions/termination-requests");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": [
{
"uuid": "00000000-0000-0000-0000-000000000000",
"type": "string",
"status": "string",
"reason": "string",
"details": "string",
"meta": {
"use_again": "string"
},
"requested_at": "string",
"terminated_at": "string"
}
],
"meta": {
"current_page": 1,
"total": 1,
"per_page": 1
}
}Show Termination Request
GET
/public/{user_id}/subscriptions/termination-requests/{terminationRequest_uuid}Returns a single Termination Request extended information.
Path parameters
user_idThe ID of the user.
terminationRequest_uuidNo description in the spec
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.typeNo description in the spec
data.statusNo description in the spec
data.reasonNo description in the spec
data.detailsNo description in the spec
data.metaNo description in the spec
data.meta.use_againNo description in the spec
data.requested_atNo description in the spec
data.terminated_atNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions/termination-requests/{terminationRequest_uuid}' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions/termination-requests/{terminationRequest_uuid}"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions/termination-requests/{terminationRequest_uuid}";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions/termination-requests/{terminationRequest_uuid}", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions/termination-requests/{terminationRequest_uuid}");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": {
"uuid": "00000000-0000-0000-0000-000000000000",
"type": "string",
"status": "string",
"reason": "string",
"details": "string",
"meta": {
"use_again": true
},
"requested_at": "string",
"terminated_at": "string"
}
}Cancel Termination Request
POST
/public/{user_id}/subscriptions/termination-requests/{terminationRequest_uuid}/cancelCancel a pending termination request.
Path parameters
user_idThe ID of the user.
terminationRequest_uuidNo description in the spec
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.typeNo description in the spec
data.statusNo description in the spec
data.reasonNo description in the spec
data.detailsNo description in the spec
data.metaNo description in the spec
data.meta.use_againNo description in the spec
data.requested_atNo description in the spec
data.terminated_atNo description in the spec
Request
curl -X POST 'https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions/termination-requests/{terminationRequest_uuid}/cancel' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions/termination-requests/{terminationRequest_uuid}/cancel"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.post(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions/termination-requests/{terminationRequest_uuid}/cancel";
const res = await fetch(url, {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("POST", "https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions/termination-requests/{terminationRequest_uuid}/cancel", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions/termination-requests/{terminationRequest_uuid}/cancel");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": {
"uuid": "00000000-0000-0000-0000-000000000000",
"type": "string",
"status": "string",
"reason": "string",
"details": "string",
"meta": {
"use_again": true
},
"requested_at": "string",
"terminated_at": "string"
}
}Show Customer Subscription
GET
/public/{user_id}/subscriptions/{subscription_uuid}Returns a single Customer Subscription extended information.
Path parameters
user_idThe ID of the user.
subscription_uuidNo description in the spec
Query parameters
includeA comma-separated list of relationships to include. Multiple parameters are allowed.
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.nameNo description in the spec
data.short_descriptionNo description in the spec
data.statusNo description in the spec
data.current_period_startNo description in the spec
data.current_period_endNo description in the spec
data.previous_period_startNo description in the spec
data.previous_period_endNo description in the spec
data.started_atNo description in the spec
data.terminated_atNo description in the spec
data.terminate_atNo description in the spec
data.terminate_at_period_endNo description in the spec
data.is_scheduled_for_terminationNo description in the spec
data.billing_anchor_dayNo description in the spec
data.customerNo description in the spec
data.customer.uuidNo description in the spec
data.customer.auth_idNo description in the spec
data.customer.nameNo description in the spec
data.customer.business_entity_idNo description in the spec
data.customer.currencyNo description in the spec
data.totalNo description in the spec
data.total.currencyNo description in the spec
data.total.amountNo description in the spec
data.total.amount_minorNo description in the spec
data.sub_totalNo description in the spec
data.sub_total.currencyNo description in the spec
data.sub_total.amountNo description in the spec
data.sub_total.amount_minorNo description in the spec
data.discount_totalNo description in the spec
data.discount_total.currencyNo description in the spec
data.discount_total.amountNo description in the spec
data.discount_total.amount_minorNo description in the spec
data.current_phaseNo description in the spec
data.current_phase.uuidNo description in the spec
data.current_phase.nameNo description in the spec
data.current_phase.short_descriptionNo description in the spec
data.current_phase.start_atNo description in the spec
data.current_phase.occurrenceNo description in the spec
data.current_phase.periodNo description in the spec
data.current_phase.end_atNo description in the spec
data.current_phase.statusNo description in the spec
data.current_phase.created_atNo description in the spec
data.has_immediate_terminationNo description in the spec
data.is_in_grace_periodNo description in the spec
data.expires_atNo description in the spec
data.reference_idNo description in the spec
data.order_uuidNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions/{subscription_uuid}' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions/{subscription_uuid}"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions/{subscription_uuid}";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions/{subscription_uuid}", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions/{subscription_uuid}");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": {
"uuid": "00000000-0000-0000-0000-000000000000",
"name": "string",
"short_description": "string",
"status": "string",
"current_period_start": "string",
"current_period_end": "string",
"previous_period_start": "string",
"previous_period_end": "string"
}
}Update Subscription
PATCH
/public/{user_id}/subscriptions/{subscription_uuid}Update Single Subscription
Path parameters
user_idThe ID of the user.
subscription_uuidNo description in the spec
Request body
billing_anchor_dayNo description in the spec
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.nameNo description in the spec
data.short_descriptionNo description in the spec
data.statusNo description in the spec
data.current_period_startNo description in the spec
data.current_period_endNo description in the spec
data.previous_period_startNo description in the spec
data.previous_period_endNo description in the spec
data.started_atNo description in the spec
data.terminated_atNo description in the spec
data.terminate_atNo description in the spec
data.terminate_at_period_endNo description in the spec
data.is_scheduled_for_terminationNo description in the spec
data.billing_anchor_dayNo description in the spec
data.customerNo description in the spec
data.customer.uuidNo description in the spec
data.customer.auth_idNo description in the spec
data.customer.nameNo description in the spec
data.customer.business_entity_idNo description in the spec
data.customer.currencyNo description in the spec
data.totalNo description in the spec
data.total.currencyNo description in the spec
data.total.amountNo description in the spec
data.total.amount_minorNo description in the spec
data.sub_totalNo description in the spec
data.sub_total.currencyNo description in the spec
data.sub_total.amountNo description in the spec
data.sub_total.amount_minorNo description in the spec
data.discount_totalNo description in the spec
data.discount_total.currencyNo description in the spec
data.discount_total.amountNo description in the spec
data.discount_total.amount_minorNo description in the spec
data.current_phaseNo description in the spec
data.current_phase.uuidNo description in the spec
data.current_phase.nameNo description in the spec
data.current_phase.short_descriptionNo description in the spec
data.current_phase.start_atNo description in the spec
data.current_phase.occurrenceNo description in the spec
data.current_phase.periodNo description in the spec
data.current_phase.end_atNo description in the spec
data.current_phase.statusNo description in the spec
data.current_phase.created_atNo description in the spec
data.has_immediate_terminationNo description in the spec
data.is_in_grace_periodNo description in the spec
data.expires_atNo description in the spec
data.reference_idNo description in the spec
data.order_uuidNo description in the spec
Request
curl -X PATCH 'https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions/{subscription_uuid}' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"billing_anchor_day": "string"
}'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions/{subscription_uuid}"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = {
"billing_anchor_day": "string"
}
r = requests.patch(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions/{subscription_uuid}";
const res = await fetch(url, {
method: "PATCH",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify({
"billing_anchor_day": "string"
}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"billing_anchor_day": "string"
}`)
req, _ := http.NewRequest("PATCH", "https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions/{subscription_uuid}", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions/{subscription_uuid}");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"billing_anchor_day" => "string"
]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": {
"uuid": "00000000-0000-0000-0000-000000000000",
"name": "string",
"short_description": "string",
"status": "string",
"current_period_start": "string",
"current_period_end": "string",
"previous_period_start": "string",
"previous_period_end": "string"
}
}List Subscription Phases
GET
/public/{user_id}/subscriptions/{subscription_uuid}/phasesReturn a list of Subscription Phases.
Path parameters
user_idThe ID of the user.
subscription_uuidNo description in the spec
Query parameters
sortA comma-separated list of fields to sort. Multiple allowed. Prefix with `-` to sort descending.
filter[start_at]No description in the spec
filter[end_at]No description in the spec
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.nameNo description in the spec
data.short_descriptionNo description in the spec
data.start_atNo description in the spec
data.occurrenceNo description in the spec
data.periodNo description in the spec
data.end_atNo description in the spec
data.statusNo description in the spec
data.created_atNo description in the spec
metaNo description in the spec
meta.current_pageNo description in the spec
meta.totalNo description in the spec
meta.per_pageNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions/{subscription_uuid}/phases' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions/{subscription_uuid}/phases"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions/{subscription_uuid}/phases";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions/{subscription_uuid}/phases", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions/{subscription_uuid}/phases");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": [
{
"uuid": "00000000-0000-0000-0000-000000000000",
"name": "string",
"short_description": "string",
"start_at": "string",
"occurrence": "string",
"period": 1,
"end_at": "string",
"status": "string"
}
],
"meta": {
"current_page": 1,
"total": 1,
"per_page": 1
}
}Terminate Subscription
POST
/public/{user_id}/subscriptions/{subscription_uuid}/terminateCreates termination request for customer subscription.
Path parameters
user_idThe ID of the user.
subscription_uuidNo description in the spec
Request body
typeNo description in the spec
end_of_periodreasonMust not be greater than 255 characters.
detailsMust not be greater than 600 characters.
metaThe meta data of the termination request.
meta.use_againNo description in the spec
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.typeNo description in the spec
data.statusNo description in the spec
data.reasonNo description in the spec
data.detailsNo description in the spec
data.metaNo description in the spec
data.meta.use_againNo description in the spec
data.requested_atNo description in the spec
data.terminated_atNo description in the spec
Request
curl -X POST 'https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions/{subscription_uuid}/terminate' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"type": "end_of_period",
"reason": "string",
"details": "string",
"meta": {
"use_again": true
}
}'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions/{subscription_uuid}/terminate"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = {
"type": "end_of_period",
"reason": "string",
"details": "string",
"meta": {
"use_again": true
}
}
r = requests.post(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions/{subscription_uuid}/terminate";
const res = await fetch(url, {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify({
"type": "end_of_period",
"reason": "string",
"details": "string",
"meta": {
"use_again": true
}
}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"type": "end_of_period",
"reason": "string",
"details": "string",
"meta": {
"use_again": true
}
}`)
req, _ := http.NewRequest("POST", "https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions/{subscription_uuid}/terminate", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions/{subscription_uuid}/terminate");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"type" => "end_of_period",
"reason" => "string",
"details" => "string",
"meta" => [
"use_again" => true
]
]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": {
"uuid": "00000000-0000-0000-0000-000000000000",
"type": "string",
"status": "string",
"reason": "string",
"details": "string",
"meta": {
"use_again": true
},
"requested_at": "string",
"terminated_at": "string"
}
}Invoices
8 operations
The object
API.Pub.Resources.Invoices.InvoiceResourceDeclared in the spec. Shown from GET /v1/{tenantUUID}/invoices/{invoiceUUID}.
Attributes
uuidNo description in the spec
tenant_uuidNo description in the spec
invoice_numberNo description in the spec
dateNo description in the spec
date_dueNo description in the spec
date_paidNo description in the spec
subtotalNo description in the spec
subtotal_with_taxesNo description in the spec
totalNo description in the spec
total_left_to_payNo description in the spec
total_paidNo description in the spec
total_taxNo description in the spec
statusNo description in the spec
items_countNo description in the spec
itemsNo description in the spec
items.invoice_uuidNo description in the spec
items.service_uuidNo description in the spec
items.descriptionNo description in the spec
items.amountNo description in the spec
items.taxedNo description in the spec
items.period_startNo description in the spec
items.period_endNo description in the spec
items.typeNo description in the spec
items.metadataNo description in the spec
taxesNo description in the spec
taxes.descriptionNo description in the spec
taxes.percentageNo description in the spec
taxes.amountNo description in the spec
taxes.orderNo description in the spec
taxes.stacksNo description in the spec
transactionsNo description in the spec
transactions.invoice_uuidNo description in the spec
transactions.service_uuidNo description in the spec
transactions.descriptionNo description in the spec
transactions.amountNo description in the spec
transactions.taxedNo description in the spec
transactions.period_startNo description in the spec
transactions.period_endNo description in the spec
transactions.typeNo description in the spec
transactions.metadataNo description in the spec
List Invoices
GET
/public/{user_id}/invoicesList the current User's Invoices.
Path parameters
user_idThe ID of the user.
Query parameters
sortA comma-separated list of fields to sort. Multiple allowed. Prefix with `-` to sort descending.
filter[invoicable_id]No description in the spec
filter[invoicable_type]No description in the spec
filter[uuid]No description in the spec
filter[status]No description in the spec
filter[placed_at]No description in the spec
filter[type]No description in the spec
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.referenceNo description in the spec
data.statusNo description in the spec
data.typeNo description in the spec
data.placed_atNo description in the spec
data.due_dateNo description in the spec
data.sub_totalNo description in the spec
data.sub_total.currencyNo description in the spec
data.sub_total.amountNo description in the spec
data.sub_total.amount_minorNo description in the spec
data.discount_totalNo description in the spec
data.discount_total.currencyNo description in the spec
data.discount_total.amountNo description in the spec
data.discount_total.amount_minorNo description in the spec
data.tax_totalNo description in the spec
data.tax_total.currencyNo description in the spec
data.tax_total.amountNo description in the spec
data.tax_total.amount_minorNo description in the spec
data.credits_totalNo description in the spec
data.credits_total.currencyNo description in the spec
data.credits_total.amountNo description in the spec
data.credits_total.amount_minorNo description in the spec
data.totalNo description in the spec
data.total.currencyNo description in the spec
data.total.amountNo description in the spec
data.total.amount_minorNo description in the spec
data.total_before_taxNo description in the spec
data.total_before_tax.currencyNo description in the spec
data.total_before_tax.amountNo description in the spec
data.total_before_tax.amount_minorNo description in the spec
data.invoicable_idNo description in the spec
data.invoicable_typeNo description in the spec
metaNo description in the spec
meta.current_pageNo description in the spec
meta.totalNo description in the spec
meta.per_pageNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/ecommerce/public/{user_id}/invoices' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/invoices"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/invoices";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/ecommerce/public/{user_id}/invoices", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/invoices");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": [
{
"uuid": "00000000-0000-0000-0000-000000000000",
"reference": "string",
"status": "string",
"type": "string",
"placed_at": "string",
"due_date": "string",
"sub_total": {
"currency": "string",
"amount": "string",
"amount_minor": "string"
},
"discount_total": {
"currency": "string",
"amount": "string",
"amount_minor": "string"
}
}
],
"meta": {
"current_page": 1,
"total": 1,
"per_page": 1
}
}Show Invoice
GET
/public/{user_id}/invoices/{invoice_uuid}Returns a single Invoice extended information.
Path parameters
user_idThe ID of the user.
invoice_uuidNo description in the spec
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.referenceNo description in the spec
data.statusNo description in the spec
data.typeNo description in the spec
data.placed_atNo description in the spec
data.due_dateNo description in the spec
data.sub_totalNo description in the spec
data.sub_total.currencyNo description in the spec
data.sub_total.amountNo description in the spec
data.sub_total.amount_minorNo description in the spec
data.discount_totalNo description in the spec
data.discount_total.currencyNo description in the spec
data.discount_total.amountNo description in the spec
data.discount_total.amount_minorNo description in the spec
data.tax_totalNo description in the spec
data.tax_total.currencyNo description in the spec
data.tax_total.amountNo description in the spec
data.tax_total.amount_minorNo description in the spec
data.credits_totalNo description in the spec
data.credits_total.currencyNo description in the spec
data.credits_total.amountNo description in the spec
data.credits_total.amount_minorNo description in the spec
data.totalNo description in the spec
data.total.currencyNo description in the spec
data.total.amountNo description in the spec
data.total.amount_minorNo description in the spec
data.total_before_taxNo description in the spec
data.total_before_tax.currencyNo description in the spec
data.total_before_tax.amountNo description in the spec
data.total_before_tax.amount_minorNo description in the spec
data.invoicable_idNo description in the spec
data.invoicable_typeNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/ecommerce/public/{user_id}/invoices/{invoice_uuid}' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/invoices/{invoice_uuid}"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/invoices/{invoice_uuid}";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/ecommerce/public/{user_id}/invoices/{invoice_uuid}", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/invoices/{invoice_uuid}");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": {
"uuid": "00000000-0000-0000-0000-000000000000",
"reference": "string",
"status": "string",
"type": "string",
"placed_at": "string",
"due_date": "string",
"sub_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
},
"discount_total": {
"currency": "string",
"amount": "string",
"amount_minor": 1
}
}
}Download Invoice
GET
/public/{user_id}/invoices/{invoice_uuid}/downloadDownload an Invoice.
Path parameters
user_idThe ID of the user.
invoice_uuidNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/ecommerce/public/{user_id}/invoices/{invoice_uuid}/download' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/invoices/{invoice_uuid}/download"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/invoices/{invoice_uuid}/download";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/ecommerce/public/{user_id}/invoices/{invoice_uuid}/download", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/invoices/{invoice_uuid}/download");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Successfully generated and returned an Invoice file.
{}List Invoice Lines
GET
/public/{user_id}/invoices/{invoice_uuid}/linesList the Invoice Lines.
Path parameters
user_idThe ID of the user.
invoice_uuidNo description in the spec
Query parameters
includeA comma-separated list of relationships to include. Multiple parameters are allowed.
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.titleNo description in the spec
data.descriptionNo description in the spec
data.unit_quantityNo description in the spec
data.quantityNo description in the spec
data.subtotalNo description in the spec
data.subtotal.currencyNo description in the spec
data.subtotal.amountNo description in the spec
data.subtotal.amount_minorNo description in the spec
data.unit_priceNo description in the spec
data.unit_price.currencyNo description in the spec
data.unit_price.amountNo description in the spec
data.unit_price.amount_minorNo description in the spec
data.tax_totalNo description in the spec
data.tax_total.currencyNo description in the spec
data.tax_total.amountNo description in the spec
data.tax_total.amount_minorNo description in the spec
data.discount_totalNo description in the spec
data.discount_total.currencyNo description in the spec
data.discount_total.amountNo description in the spec
data.discount_total.amount_minorNo description in the spec
data.totalNo description in the spec
data.total.currencyNo description in the spec
data.total.amountNo description in the spec
data.total.amount_minorNo description in the spec
data.total_before_taxNo description in the spec
data.total_before_tax.currencyNo description in the spec
data.total_before_tax.amountNo description in the spec
data.total_before_tax.amount_minorNo description in the spec
data.exchange_rateNo description in the spec
data.exchange_rate_fetched_atNo description in the spec
data.notesNo description in the spec
metaNo description in the spec
meta.current_pageNo description in the spec
meta.totalNo description in the spec
meta.per_pageNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/ecommerce/public/{user_id}/invoices/{invoice_uuid}/lines' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/invoices/{invoice_uuid}/lines"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/invoices/{invoice_uuid}/lines";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/ecommerce/public/{user_id}/invoices/{invoice_uuid}/lines", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/invoices/{invoice_uuid}/lines");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": [
{
"uuid": "00000000-0000-0000-0000-000000000000",
"title": "string",
"description": "string",
"unit_quantity": 1,
"quantity": 1,
"subtotal": {
"currency": "string",
"amount": "string",
"amount_minor": "string"
},
"unit_price": {
"currency": "string",
"amount": "string",
"amount_minor": "string"
},
"tax_total": {
"currency": "string",
"amount": "string",
"amount_minor": "string"
}
}
],
"meta": {
"current_page": 1,
"total": 1,
"per_page": 1
}
}List Tenant Invoices
GET
/v1/{tenantUUID}/invoicesList Tenant Invoices
Path parameters
tenantUUIDTenant UUID
Query parameters
invoice_numberFilter By Invoice Number (ID)
invoice_number_bulkFilter By Invoice Numbers Bulk
period_startFilter by Period Start Date Timestamp
period_endFilter by Period End Date Timestamp
statusesFilter by Invoice Statuses
sortSort By Key
directionSort Direction
per_pageItems Per Page
Response 200
uuidNo description in the spec
invoice_numberNo description in the spec
dateNo description in the spec
date_dueNo description in the spec
subtotal_with_taxesNo description in the spec
statusNo description in the spec
items_countNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/invoices' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/invoices"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/invoices";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/invoices", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/invoices");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Invoices Collection
{
"uuid": "00000000-0000-0000-0000-000000000000",
"invoice_number": "string",
"date": 1,
"date_due": 1,
"subtotal_with_taxes": 1.0,
"status": "string",
"items_count": 1
}400
Invalid Request
401
Unauthorized
403
Forbidden
Get multi invoices PDF
GET
/v1/{tenantUUID}/invoices/export/pdfExport multi invoices PDF
Path parameters
tenantUUIDTenant UUID
Request body
invoice_uuidsThe invoices uuid of which PDF files you want download.
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/invoices/export/pdf' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"invoice_uuids": [
"00000000-0000-0000-0000-000000000000"
]
}'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/invoices/export/pdf"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = {
"invoice_uuids": [
"00000000-0000-0000-0000-000000000000"
]
}
r = requests.get(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/invoices/export/pdf";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify({
"invoice_uuids": [
"00000000-0000-0000-0000-000000000000"
]
}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"invoice_uuids": [
"00000000-0000-0000-0000-000000000000"
]
}`)
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/invoices/export/pdf", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/invoices/export/pdf");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"invoice_uuids" => ["00000000-0000-0000-0000-000000000000"]
]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Invoice
401
Unauthorized
403
Forbidden
Get invoice
GET
/v1/{tenantUUID}/invoices/{invoiceUUID}Returns invoice
Path parameters
tenantUUIDTenant UUID
invoiceUUIDInvoice UUID
Response 200
uuidNo description in the spec
tenant_uuidNo description in the spec
invoice_numberNo description in the spec
dateNo description in the spec
date_dueNo description in the spec
date_paidNo description in the spec
subtotalNo description in the spec
subtotal_with_taxesNo description in the spec
totalNo description in the spec
total_left_to_payNo description in the spec
total_paidNo description in the spec
total_taxNo description in the spec
statusNo description in the spec
items_countNo description in the spec
itemsNo description in the spec
items.invoice_uuidNo description in the spec
items.service_uuidNo description in the spec
items.descriptionNo description in the spec
items.amountNo description in the spec
items.taxedNo description in the spec
items.period_startNo description in the spec
items.period_endNo description in the spec
items.typeNo description in the spec
items.metadataNo description in the spec
taxesNo description in the spec
taxes.descriptionNo description in the spec
taxes.percentageNo description in the spec
taxes.amountNo description in the spec
taxes.orderNo description in the spec
taxes.stacksNo description in the spec
transactionsNo description in the spec
transactions.invoice_uuidNo description in the spec
transactions.service_uuidNo description in the spec
transactions.descriptionNo description in the spec
transactions.amountNo description in the spec
transactions.taxedNo description in the spec
transactions.period_startNo description in the spec
transactions.period_endNo description in the spec
transactions.typeNo description in the spec
transactions.metadataNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/invoices/{invoiceUUID}' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/invoices/{invoiceUUID}"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/invoices/{invoiceUUID}";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/invoices/{invoiceUUID}", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/invoices/{invoiceUUID}");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Invoice
{
"uuid": "00000000-0000-0000-0000-000000000000",
"tenant_uuid": "00000000-0000-0000-0000-000000000000",
"invoice_number": "string",
"date": 1,
"date_due": 1,
"date_paid": 1,
"subtotal": 1.0,
"subtotal_with_taxes": 1.0
}401
Unauthorized
403
Forbidden
Get invoices PDF
GET
/v1/{tenantUUID}/invoices/{invoiceUUID}/pdfReturns invoice pdf
Path parameters
tenantUUIDTenant UUID
invoiceUUIDInvoice UUID
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/invoices/{invoiceUUID}/pdf' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/invoices/{invoiceUUID}/pdf"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/invoices/{invoiceUUID}/pdf";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/invoices/{invoiceUUID}/pdf", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/invoices/{invoiceUUID}/pdf");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Invoice
401
Unauthorized
403
Forbidden
Payouts
18 operations
The object
API.Pub.Resources.IPMarket.PayoutInvoiceStatsResourceDeclared in the spec. Shown from GET /v1/{tenantUUID}/market/payouts/stats/v2.
Attributes
periodStatistics period
period.fromstarting date in YYYY-MM-DD format
period.toending date in YYYY-MM-DD format
dataNo description in the spec
data.invoice_uuidInvoice UUID
data.invoice_numberInvoice number
data.periodPeriod in Y-m-d format
data.payout_datePayout date timestamp
data.payout_statusPayout status
data.ips_countNumber of IPs leased
data.total_salesTotal sales (gross)
data.average_net_per_ipAverage net payout per IP
data.transaction_feeTransaction fee
data.holder_fee5% holder fee
data.deductionsOther deductions
data.net_payoutNet payout amount
data.payment_confirmation_uuidPayment confirmation UUID
data.payment_confirmation_numberPayment confirmation invoice number
data.holder_fee_invoice_uuidInvoice UUID for holder fee deduction PDF
metaPagination metadata (only present when pagination is requested)
meta.current_pageNo description in the spec
meta.per_pageNo description in the spec
meta.totalNo description in the spec
meta.last_pageNo description in the spec
meta.fromNo description in the spec
meta.toNo description in the spec
total_salesTotal sales (for all filtered data, not just current page when paginated)
total_net_payoutTotal net payout (for all filtered data, not just current page when paginated)
List Deductions
GET
/v1/{tenantUUID}/market/deductionsList IP Market Deductions
Path parameters
tenantUUIDTenant UUID
Request body
subnetFilter by IP
statusFilter by status
completed cancelled pendingcreated_atFilter by created_at date
sortSort by date field
directionSort direction
asc descpayout_uuidFilter by payout invoice UUID
invoice_uuidFilter by deduction invoice UUID
Response 200
uuidNo description in the spec
tenant_uuidNo description in the spec
ipmarket_service_uuidNo description in the spec
subnetNo description in the spec
amountNo description in the spec
statusNo description in the spec
pending completed cancelledcommentNo description in the spec
evidenceNo description in the spec
all_sumNo description in the spec
lease_periodNo description in the spec
deduction_invoice_uuidNo description in the spec
created_atNo description in the spec
updated_atNo description in the spec
typeNo description in the spec
service ip_holder_feeRequest
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/deductions' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"subnet": "string",
"status": "completed",
"created_at": 1,
"sort": "string",
"direction": "asc",
"payout_uuid": "00000000-0000-0000-0000-000000000000",
"invoice_uuid": "00000000-0000-0000-0000-000000000000"
}'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/deductions"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = {
"subnet": "string",
"status": "completed",
"created_at": 1,
"sort": "string",
"direction": "asc",
"payout_uuid": "00000000-0000-0000-0000-000000000000",
"invoice_uuid": "00000000-0000-0000-0000-000000000000"
}
r = requests.get(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/deductions";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify({
"subnet": "string",
"status": "completed",
"created_at": 1,
"sort": "string",
"direction": "asc",
"payout_uuid": "00000000-0000-0000-0000-000000000000",
"invoice_uuid": "00000000-0000-0000-0000-000000000000"
}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"subnet": "string",
"status": "completed",
"created_at": 1,
"sort": "string",
"direction": "asc",
"payout_uuid": "00000000-0000-0000-0000-000000000000",
"invoice_uuid": "00000000-0000-0000-0000-000000000000"
}`)
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/deductions", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/deductions");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"subnet" => "string",
"status" => "completed",
"created_at" => 1,
"sort" => "string",
"direction" => "asc",
"payout_uuid" => "00000000-0000-0000-0000-000000000000",
"invoice_uuid" => "00000000-0000-0000-0000-000000000000"
]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
IP Market Deductions Collection
{
"uuid": "00000000-0000-0000-0000-000000000000",
"tenant_uuid": "00000000-0000-0000-0000-000000000000",
"ipmarket_service_uuid": "00000000-0000-0000-0000-000000000000",
"subnet": "string",
"amount": 1.0,
"status": "pending",
"comment": "string",
"evidence": "string"
}400
Invalid Request
401
Unauthorized
403
Forbidden
Get deduction invoice as PDF
GET
/v1/{tenantUUID}/market/deductions/invoices/{invoiceUUID}/pdfReturns deduction invoice as pdf
Path parameters
tenantUUIDTenant UUID
invoiceUUIDInvoice UUID
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/deductions/invoices/{invoiceUUID}/pdf' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/deductions/invoices/{invoiceUUID}/pdf"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/deductions/invoices/{invoiceUUID}/pdf";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/deductions/invoices/{invoiceUUID}/pdf", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/deductions/invoices/{invoiceUUID}/pdf");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Deduction Invoice
400
Invalid Request
401
Unauthorized
403
Forbidden
404
Not Found
List Payment Confirmations
GET
/v1/{tenantUUID}/market/payment_confirmationsList Payment Confirmations
Path parameters
tenantUUIDTenant UUID
Query parameters
pageList Page
per_pageItems Per Page
confirmation_numberConfirmation Number
methodMethod
transaction_idTransaction Id
from_dateFrom Date
to_dateTo Date
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.confirmation_numberNo description in the spec
data.methodNo description in the spec
data.method_detailsNo description in the spec
data.dateNo description in the spec
data.transaction_idNo description in the spec
data.amountNo description in the spec
data.feeNo description in the spec
metaNo description in the spec
meta.current_pageNo description in the spec
meta.fromNo description in the spec
meta.last_pageNo description in the spec
meta.per_pageNo description in the spec
meta.toNo description in the spec
meta.totalNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payment_confirmations' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payment_confirmations"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payment_confirmations";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payment_confirmations", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payment_confirmations");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Confirmation Invoices Collection
{
"data": [
{
"uuid": "00000000-0000-0000-0000-000000000000",
"confirmation_number": "string",
"method": {
"type": "object",
"x-truncated": true
},
"method_details": "string",
"date": 1,
"transaction_id": "string",
"amount": 1.0,
"fee": 1.0
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 1,
"to": 1,
"total": 1
}
}400
Invalid Request
401
Unauthorized
403
Forbidden
Get single payment confirmation
GET
/v1/{tenantUUID}/market/payment_confirmations/{paymentConfirmationUuid}Returns single payment confirmation
Path parameters
tenantUUIDTenant UUID
paymentConfirmationUuidPayment Confirmation UUID
Response 200
uuidNo description in the spec
confirmation_numberNo description in the spec
methodNo description in the spec
banktransfer paypal creditmethod_detailsNo description in the spec
dateNo description in the spec
transaction_idNo description in the spec
amountNo description in the spec
feeNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payment_confirmations/{paymentConfirmationUuid}' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payment_confirmations/{paymentConfirmationUuid}"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payment_confirmations/{paymentConfirmationUuid}";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payment_confirmations/{paymentConfirmationUuid}", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payment_confirmations/{paymentConfirmationUuid}");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Payment Confirmation
{
"uuid": "00000000-0000-0000-0000-000000000000",
"confirmation_number": "string",
"method": "banktransfer",
"method_details": "string",
"date": 1,
"transaction_id": "string",
"amount": 1.0,
"fee": 1.0
}400
Invalid Request
401
Unauthorized
403
Forbidden
Get payment confirmation as PDF
GET
/v1/{tenantUUID}/market/payment_confirmations/{paymentConfirmationUuid}/pdfReturns payment confirmation as pdf
Path parameters
tenantUUIDTenant UUID
paymentConfirmationUuidPayment Confirmation UUID
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payment_confirmations/{paymentConfirmationUuid}/pdf' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payment_confirmations/{paymentConfirmationUuid}/pdf"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payment_confirmations/{paymentConfirmationUuid}/pdf";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payment_confirmations/{paymentConfirmationUuid}/pdf", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payment_confirmations/{paymentConfirmationUuid}/pdf");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Payment Confirmation
401
Unauthorized
403
Forbidden
Get Current Payout Method
GET
/v1/{tenantUUID}/market/payoutmethodGet Current Payout Method
Path parameters
tenantUUIDTenant UUID
Response 200
typeNo description in the spec
detailsNo description in the spec
cycleNo description in the spec
minimal_amountNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payoutmethod' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payoutmethod"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payoutmethod";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payoutmethod", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payoutmethod");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Payout Method
{
"type": "string",
"details": [
"string"
],
"cycle": 1,
"minimal_amount": 1.0
}401
Unauthorized
403
Forbidden
404
Not Found
Set Payout Method
PUT
/v1/{tenantUUID}/market/payoutmethodSet Payout Method
Path parameters
tenantUUIDTenant UUID
Request body
detailsDetails
details.beneficiaryNo description in the spec
details.addressNo description in the spec
details.bicNo description in the spec
details.ibanNo description in the spec
details.bank_nameNo description in the spec
details.emailNo description in the spec
details.noteNo description in the spec
typeNo description in the spec
banktransfer credit paypalcycleNo description in the spec
0 1 3 6 12minimal_amountNo description in the spec
Response 200
typeNo description in the spec
detailsNo description in the spec
cycleNo description in the spec
minimal_amountNo description in the spec
Request
curl -X PUT 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payoutmethod' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"details": {
"beneficiary": "string",
"address": "string",
"bic": "string",
"iban": "string",
"bank_name": "string",
"email": "[email protected]",
"note": "string"
},
"type": "banktransfer",
"cycle": 0,
"minimal_amount": 1.0
}'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payoutmethod"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = {
"details": {
"beneficiary": "string",
"address": "string",
"bic": "string",
"iban": "string",
"bank_name": "string",
"email": "[email protected]",
"note": "string"
},
"type": "banktransfer",
"cycle": 0,
"minimal_amount": 1.0
}
r = requests.put(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payoutmethod";
const res = await fetch(url, {
method: "PUT",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify({
"details": {
"beneficiary": "string",
"address": "string",
"bic": "string",
"iban": "string",
"bank_name": "string",
"email": "[email protected]",
"note": "string"
},
"type": "banktransfer",
"cycle": 0,
"minimal_amount": 1.0
}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"details": {
"beneficiary": "string",
"address": "string",
"bic": "string",
"iban": "string",
"bank_name": "string",
"email": "[email protected]",
"note": "string"
},
"type": "banktransfer",
"cycle": 0,
"minimal_amount": 1.0
}`)
req, _ := http.NewRequest("PUT", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payoutmethod", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payoutmethod");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"details" => [
"beneficiary" => "string",
"address" => "string",
"bic" => "string",
"iban" => "string",
"bank_name" => "string",
"email" => "[email protected]",
"note" => "string"
],
"type" => "banktransfer",
"cycle" => 0,
"minimal_amount" => 1.0
]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Payout Method
{
"type": "string",
"details": [
"string"
],
"cycle": 1,
"minimal_amount": 1.0
}401
Unauthorized
403
Forbidden
404
Not Found
List Payouts
GET
/v1/{tenantUUID}/market/payoutsList IP Market Payouts
Path parameters
tenantUUIDTenant UUID
Query parameters
uuidFilter By Payout UUID
service_uuidFilter By Service UUID
addressFilter By IPv4 Address
cidrFilter By CIDR
amountFilter By Amount
totalFilter By Total
lease_countFilter By Lease Count
statusFilter by Status
methodFilter By Method
startFilter By Start period date in unix timestamp format
endFilter By End period date in unix timestamp format
fromFilter by Start period date in unix timestamp format which is greater or equal to input
toFilter By End period date in unix timestamp format which is lower or equal to input
status_dateFilter By Status change date in unix timestamp format
created_atFilter By Created date in unix timestamp format
sortSort By Key
pageList Page
per_pageItems Per Page
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.tenant_uuidNo description in the spec
data.service_uuidNo description in the spec
data.addressNo description in the spec
data.cidrNo description in the spec
data.amountNo description in the spec
data.totalNo description in the spec
data.lease_countNo description in the spec
data.statusNo description in the spec
data.status_detailsNo description in the spec
data.methodNo description in the spec
data.transaction_idNo description in the spec
data.startNo description in the spec
data.endNo description in the spec
data.status_dateNo description in the spec
data.created_atNo description in the spec
data.earningsNo description in the spec
metaNo description in the spec
meta.current_pageNo description in the spec
meta.fromNo description in the spec
meta.last_pageNo description in the spec
meta.per_pageNo description in the spec
meta.toNo description in the spec
meta.totalNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Payout Collection
{
"data": [
{
"uuid": "00000000-0000-0000-0000-000000000000",
"tenant_uuid": "00000000-0000-0000-0000-000000000000",
"service_uuid": "00000000-0000-0000-0000-000000000000",
"address": "string",
"cidr": "string",
"amount": "string",
"total": "string",
"lease_count": "string"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 1,
"to": 1,
"total": 1
}
}400
Invalid Request
401
Unauthorized
403
Forbidden
Get Payouts Statistics
GET
/v1/{tenantUUID}/market/payouts/statsIP Market Payouts Statistics
Path parameters
tenantUUIDTenant UUID
Query parameters
service_uuidFilter By Service UUID
addressFilter By IPv4 Address
cidrFilter By CIDR
status_date_fromFilter by Start period date in unix timestamp format which is greater or equal to input
status_date_toFilter By End period date in unix timestamp format which is lower or equal to input
Response 200
periodStatistics period
period.fromstarting date
period.toending date
dataNo description in the spec
data.dateNo description in the spec
data.amountNo description in the spec
data.subnetNo description in the spec
data.service_uuidNo description in the spec
totalTotal amount for period
last_payout_dateLast payout date
next_payout_dateNext payout date
min_amount_reachedMin amount reached
unpaidUnpaid amount
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts/stats' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts/stats"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts/stats";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts/stats", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts/stats");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Payouts Statistics
{
"period": {
"from": 1,
"to": 1
},
"data": [
{
"date": 1,
"amount": 1.0,
"subnet": "string",
"service_uuid": "00000000-0000-0000-0000-000000000000"
}
],
"total": 1.0,
"last_payout_date": 1.0,
"next_payout_date": 1.0,
"min_amount_reached": true,
"unpaid": 1.0
}400
Invalid Request
401
Unauthorized
403
Forbidden
Get Payout Invoice Statistics (v2)
GET
/v1/{tenantUUID}/market/payouts/stats/v2IP Market Payout Invoice Statistics with detailed breakdown. Add pagination params for table view.
Path parameters
tenantUUIDTenant UUID
Query parameters
period_start_dateFilter by start period in YYYY-MM-DD format (e.g., 2025-01-15)
period_end_dateFilter by end period in YYYY-MM-DD format (e.g., 2025-03-31)
statusFilter by payout invoice status
sortSort field (prefix with - for descending, e.g., -date_paid). Optional, only used with pagination.
pagePage number for pagination. When provided, response will be paginated.
per_pageItems per page (default: 15, max: 100). Only used when page is provided.
Response 200
periodStatistics period
period.fromstarting date in YYYY-MM-DD format
period.toending date in YYYY-MM-DD format
dataNo description in the spec
data.invoice_uuidInvoice UUID
data.invoice_numberInvoice number
data.periodPeriod in Y-m-d format
data.payout_datePayout date timestamp
data.payout_statusPayout status
data.ips_countNumber of IPs leased
data.total_salesTotal sales (gross)
data.average_net_per_ipAverage net payout per IP
data.transaction_feeTransaction fee
data.holder_fee5% holder fee
data.deductionsOther deductions
data.net_payoutNet payout amount
data.payment_confirmation_uuidPayment confirmation UUID
data.payment_confirmation_numberPayment confirmation invoice number
data.holder_fee_invoice_uuidInvoice UUID for holder fee deduction PDF
metaPagination metadata (only present when pagination is requested)
meta.current_pageNo description in the spec
meta.per_pageNo description in the spec
meta.totalNo description in the spec
meta.last_pageNo description in the spec
meta.fromNo description in the spec
meta.toNo description in the spec
total_salesTotal sales (for all filtered data, not just current page when paginated)
total_net_payoutTotal net payout (for all filtered data, not just current page when paginated)
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts/stats/v2' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts/stats/v2"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts/stats/v2";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts/stats/v2", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts/stats/v2");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Payout Invoice Statistics
{
"period": {
"from": "string",
"to": "string"
},
"data": [
{
"invoice_uuid": "00000000-0000-0000-0000-000000000000",
"invoice_number": "string",
"period": "string",
"payout_date": 1,
"payout_status": {
"type": "object",
"x-truncated": true
},
"ips_count": 1,
"total_sales": 1.0,
"average_net_per_ip": 1.0
}
],
"meta": {
"current_page": 1,
"per_page": 1,
"total": 1,
"last_page": 1,
"from": 1,
"to": 1
},
"total_sales": 1.0,
"total_net_payout": 1.0
}400
Invalid Request
401
Unauthorized
403
Forbidden
Export Payout Invoice Statistics to CSV
GET
/v1/{tenantUUID}/market/payouts/stats/v2/exportExport IP Market Payout Invoice Statistics with detailed breakdown as CSV file
Path parameters
tenantUUIDTenant UUID
Query parameters
period_start_dateFilter by start period in YYYY-MM-DD format (e.g., 2025-01-15)
period_end_dateFilter by end period in YYYY-MM-DD format (e.g., 2025-03-31)
statusFilter by payout invoice status
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts/stats/v2/export' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts/stats/v2/export"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts/stats/v2/export";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts/stats/v2/export", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts/stats/v2/export");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
CSV file with payout invoice statistics
400
Invalid Request
401
Unauthorized
403
Forbidden
Get single payout
GET
/v1/{tenantUUID}/market/payouts/{payoutUuid}Returns single payout identified by target UUID
Path parameters
tenantUUIDTenant UUID
payoutUuidPayout UUID
Response 200
uuidNo description in the spec
tenant_uuidNo description in the spec
service_uuidNo description in the spec
addressNo description in the spec
cidrNo description in the spec
amountNo description in the spec
totalNo description in the spec
lease_countNo description in the spec
statusNo description in the spec
pending completed rejected graphstatus_detailsNo description in the spec
methodNo description in the spec
transaction_idNo description in the spec
startNo description in the spec
endNo description in the spec
status_dateNo description in the spec
created_atNo description in the spec
earningslist of Service Lease Earnings
earnings.service_uuidNo description in the spec
earnings.payout_uuidNo description in the spec
earnings.amountNo description in the spec
earnings.startNo description in the spec
earnings.endNo description in the spec
earnings.created_atNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts/{payoutUuid}' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts/{payoutUuid}"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts/{payoutUuid}";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts/{payoutUuid}", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts/{payoutUuid}");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Payout
{
"uuid": "00000000-0000-0000-0000-000000000000",
"tenant_uuid": "00000000-0000-0000-0000-000000000000",
"service_uuid": "00000000-0000-0000-0000-000000000000",
"address": "string",
"cidr": 1,
"amount": 1.0,
"total": 1.0,
"lease_count": 1
}400
Invalid Request
401
Unauthorized
403
Forbidden
List Payouts Invoices
GET
/v1/{tenantUUID}/market/payouts_invoicesList IP Market Payouts Invoices
Path parameters
tenantUUIDTenant UUID
Query parameters
uuidFilter By Payout Invoice UUID
invoice_numberFilter By Payout Invoice Number
service_uuidFilter By Service UUID
subnetFilter By Subnet
totalFilter By Total
statusFilter by Status
startFilter by Start period date in unix timestamp format which is greater or equal to input
endFilter By End period date in unix timestamp format which is lower or equal to input
sortSort By Key
pageList Page
per_pageItems Per Page
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.invoice_numberNo description in the spec
data.tenant_uuidNo description in the spec
data.totalNo description in the spec
data.feesNo description in the spec
data.statusNo description in the spec
data.dateNo description in the spec
data.date_paidNo description in the spec
data.payment_confirmation_uuidNo description in the spec
data.itemsNo description in the spec
metaNo description in the spec
meta.current_pageNo description in the spec
meta.fromNo description in the spec
meta.last_pageNo description in the spec
meta.per_pageNo description in the spec
meta.toNo description in the spec
meta.totalNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts_invoices' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts_invoices"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts_invoices";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts_invoices", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts_invoices");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Payout Invoices Collection
{
"data": [
{
"uuid": "00000000-0000-0000-0000-000000000000",
"invoice_number": "string",
"tenant_uuid": "00000000-0000-0000-0000-000000000000",
"total": 1.0,
"fees": 1.0,
"status": {
"type": "object",
"x-truncated": true
},
"date": 1,
"date_paid": 1
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 1,
"to": 1,
"total": 1
}
}400
Invalid Request
401
Unauthorized
403
Forbidden
Export payout invoices CSV
GET
/v1/{tenantUUID}/market/payouts_invoices/export/csvExport payout invoices CSV
Path parameters
tenantUUIDTenant UUID
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts_invoices/export/csv' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts_invoices/export/csv"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts_invoices/export/csv";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts_invoices/export/csv", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts_invoices/export/csv");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Invoice
401
Unauthorized
403
Forbidden
Get single payout invoice
GET
/v1/{tenantUUID}/market/payouts_invoices/{payoutInvoiceUuid}Returns single payout invoice
Path parameters
tenantUUIDTenant UUID
payoutInvoiceUuidPayout Invoice UUID
Response 200
uuidNo description in the spec
invoice_numberNo description in the spec
tenant_uuidNo description in the spec
totalNo description in the spec
feesNo description in the spec
statusNo description in the spec
paid unpaiddateNo description in the spec
date_paidNo description in the spec
payment_confirmation_uuidNo description in the spec
itemsNo description in the spec
items.uuidNo description in the spec
items.typeNo description in the spec
items.descriptionNo description in the spec
items.period_startNo description in the spec
items.period_endNo description in the spec
items.amountNo description in the spec
items.cidrNo description in the spec
items.addressNo description in the spec
items.service_uuidNo description in the spec
items.startNo description in the spec
items.endNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts_invoices/{payoutInvoiceUuid}' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts_invoices/{payoutInvoiceUuid}"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts_invoices/{payoutInvoiceUuid}";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts_invoices/{payoutInvoiceUuid}", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts_invoices/{payoutInvoiceUuid}");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Payout
{
"uuid": "00000000-0000-0000-0000-000000000000",
"invoice_number": "string",
"tenant_uuid": "00000000-0000-0000-0000-000000000000",
"total": 1.0,
"fees": 1.0,
"status": "paid",
"date": 1,
"date_paid": 1
}400
Invalid Request
401
Unauthorized
403
Forbidden
Get Self-Billing Invoice Lease Items
GET
/v1/{tenantUUID}/market/payouts_invoices/{payoutInvoiceUuid}/itemsGet detailed breakdown of individual lease items within a self-billing (payout) invoice
Path parameters
tenantUUIDTenant UUID
payoutInvoiceUuidPayout Invoice UUID
Query parameters
sortSort field (prefix with - for descending)
pagePage number for pagination
per_pageItems per page (default: 15, max: 100)
Response 200
dataNo description in the spec
data.subnetSubnet that was leased (e.g., 10.0.0.0/24)
data.lease_period_fromLease period start in Y-m-d H:i:s format
data.lease_period_toLease period end in Y-m-d H:i:s format
data.salesAmount IP Holder initially set
data.holder_fee5% holder fee
data.deductionsOther deductions
data.net_earningsNet earnings after fees and deductions
metaPagination metadata
meta.current_pageNo description in the spec
meta.per_pageNo description in the spec
meta.totalNo description in the spec
meta.last_pageNo description in the spec
meta.fromNo description in the spec
meta.toNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts_invoices/{payoutInvoiceUuid}/items' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts_invoices/{payoutInvoiceUuid}/items"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts_invoices/{payoutInvoiceUuid}/items";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts_invoices/{payoutInvoiceUuid}/items", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts_invoices/{payoutInvoiceUuid}/items");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Self-Billing Invoice Lease Items
{
"data": [
{
"subnet": "string",
"lease_period_from": "string",
"lease_period_to": "string",
"sales": 1.0,
"holder_fee": 1.0,
"deductions": 1.0,
"net_earnings": 1.0
}
],
"meta": {
"current_page": 1,
"per_page": 1,
"total": 1,
"last_page": 1,
"from": 1,
"to": 1
}
}400
Invalid Request
401
Unauthorized
403
Forbidden
Get payout invoice as PDF
GET
/v1/{tenantUUID}/market/payouts_invoices/{payoutInvoiceUuid}/pdfReturns payout invoice as pdf
Path parameters
tenantUUIDTenant UUID
payoutInvoiceUuidPayout Invoice UUID
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts_invoices/{payoutInvoiceUuid}/pdf' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts_invoices/{payoutInvoiceUuid}/pdf"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts_invoices/{payoutInvoiceUuid}/pdf";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts_invoices/{payoutInvoiceUuid}/pdf", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts_invoices/{payoutInvoiceUuid}/pdf");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Payout Invoice
401
Unauthorized
403
Forbidden
Get Self-Billing Invoice Statistics
GET
/v1/{tenantUUID}/market/payouts_invoices/{payoutInvoiceUuid}/statsGet detailed statistics for a specific self-billing (payout) invoice
Path parameters
tenantUUIDTenant UUID
payoutInvoiceUuidPayout Invoice UUID
Response 200
periodStatistics period
period.fromstarting date in YYYY-MM-DD format
period.toending date in YYYY-MM-DD format
dataNo description in the spec
data.invoice_uuidInvoice UUID
data.invoice_numberInvoice number
data.periodPeriod in Y-m-d format
data.payout_datePayout date timestamp
data.payout_statusPayout status
data.ips_countNumber of IPs leased
data.total_salesTotal sales (gross)
data.average_net_per_ipAverage net payout per IP
data.transaction_feeTransaction fee
data.holder_fee5% holder fee
data.deductionsOther deductions
data.net_payoutNet payout amount
data.payment_confirmation_uuidPayment confirmation UUID
data.payment_confirmation_numberPayment confirmation invoice number
data.holder_fee_invoice_uuidInvoice UUID for holder fee deduction PDF
metaPagination metadata (only present when pagination is requested)
meta.current_pageNo description in the spec
meta.per_pageNo description in the spec
meta.totalNo description in the spec
meta.last_pageNo description in the spec
meta.fromNo description in the spec
meta.toNo description in the spec
total_salesTotal sales (for all filtered data, not just current page when paginated)
total_net_payoutTotal net payout (for all filtered data, not just current page when paginated)
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts_invoices/{payoutInvoiceUuid}/stats' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts_invoices/{payoutInvoiceUuid}/stats"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts_invoices/{payoutInvoiceUuid}/stats";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts_invoices/{payoutInvoiceUuid}/stats", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/payouts_invoices/{payoutInvoiceUuid}/stats");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Self-Billing Invoice Statistics
{
"period": {
"from": "string",
"to": "string"
},
"data": [
{
"invoice_uuid": "00000000-0000-0000-0000-000000000000",
"invoice_number": "string",
"period": "string",
"payout_date": 1,
"payout_status": {
"type": "object",
"x-truncated": true
},
"ips_count": 1,
"total_sales": 1.0,
"average_net_per_ip": 1.0
}
],
"meta": {
"current_page": 1,
"per_page": 1,
"total": 1,
"last_page": 1,
"from": 1,
"to": 1
},
"total_sales": 1.0,
"total_net_payout": 1.0
}400
Invalid Request
401
Unauthorized
403
Forbidden
Credits
1 operations
The object synthesised
The spec declares no named object for this resource, so the renderer synthesised one from its richest response body (GET /public/{user_id}/balances). Fields no endpoint returns cannot appear here.
Attributes
dataNo description in the spec
data.available_balanceNo description in the spec
data.total_balanceNo description in the spec
data.currencyNo description in the spec
data.updated_atNo description in the spec
Show Balance
GET
/public/{user_id}/balancesShow customer Balance
Path parameters
user_idThe ID of the user.
Query parameters
filter[currency]No description in the spec
Response 200
dataNo description in the spec
data.available_balanceNo description in the spec
data.total_balanceNo description in the spec
data.currencyNo description in the spec
data.updated_atNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/credits/public/{user_id}/balances' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/credits/public/{user_id}/balances"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/credits/public/{user_id}/balances";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/credits/public/{user_id}/balances", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/credits/public/{user_id}/balances");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": {
"available_balance": 1.0,
"total_balance": 1.0,
"currency": "string",
"updated_at": "string"
}
}Prefixes
14 operations
The object
PrefixHolderDeclared in the spec. Shown from PATCH /{tenantUUID}/prefixes/{notation}/metadata.
Attributes
notationNo description in the spec
ipNetNo description in the spec
ipNet.ipNo description in the spec
ipNet.maskNo description in the spec
internalMetadataNo description in the spec
internalMetadata.internalNo description in the spec
internalMetadata.readOnlyNo description in the spec
internalMetadata.masterNo description in the spec
internalMetadata.prefixLengthLimitsNo description in the spec
internalMetadata.holdersNo description in the spec
externalMetadataNo description in the spec
holderMetadataNo description in the spec
geodataNo description in the spec
geodata.providerNo description in the spec
geodata.countryNameNo description in the spec
geodata.countryCodeNo description in the spec
geodata.cityNameNo description in the spec
geodata.dateNo description in the spec
geodata.stateNo description in the spec
whoisNo description in the spec
whois.inetnumNo description in the spec
whois.registrarNo description in the spec
whois.sourceNo description in the spec
whois.recordActiveNo description in the spec
whois.netsNo description in the spec
whois.domainsNo description in the spec
bgpNo description in the spec
bgp.peerCountNo description in the spec
bgp.asOriginsNo description in the spec
bgp.asSetOriginsNo description in the spec
rpkiNo description in the spec
rpki.roasNo description in the spec
rpki.suggestionsNo description in the spec
routesNo description in the spec
routes.routeNo description in the spec
routes.originNo description in the spec
routes.descrNo description in the spec
routes.mnt_byNo description in the spec
routes.changedNo description in the spec
routes.sourceNo description in the spec
routingHealthNo description in the spec
routingHealth.criticalityStatusNo description in the spec
routingHealth.bgpStatusNo description in the spec
routingHealth.bgpActionsNo description in the spec
routingHealth.rpkiStatusNo description in the spec
routingHealth.rpkiActionsNo description in the spec
routingHealth.irrStatusNo description in the spec
routingHealth.irrActionsNo description in the spec
routingHealth.irmActionsNo description in the spec
cacheDerrivedNo description in the spec
cacheDerrived.registrarNo description in the spec
Set Holder Metadata
PATCH
/{tenantUUID}/prefixes/metadataUpdates target prefix holder metadata and returns updated prefixes.
Path parameters
tenantUUIDTenant UUID
Request body
notationA string field representing the notation.
metadataA map to hold the metadata. Map keys can only contain following symbols: [A-Z, a-z, 0-9, -, _]
Response 200
notationNo description in the spec
ipNetNo description in the spec
ipNet.ipNo description in the spec
ipNet.maskNo description in the spec
internalMetadataNo description in the spec
internalMetadata.internalNo description in the spec
internalMetadata.readOnlyNo description in the spec
internalMetadata.masterNo description in the spec
internalMetadata.prefixLengthLimitsNo description in the spec
internalMetadata.holdersNo description in the spec
externalMetadataNo description in the spec
holderMetadataNo description in the spec
geodataNo description in the spec
geodata.providerNo description in the spec
geodata.countryNameNo description in the spec
geodata.countryCodeNo description in the spec
geodata.cityNameNo description in the spec
geodata.dateNo description in the spec
geodata.stateNo description in the spec
whoisNo description in the spec
whois.inetnumNo description in the spec
whois.registrarNo description in the spec
whois.sourceNo description in the spec
whois.recordActiveNo description in the spec
whois.netsNo description in the spec
whois.domainsNo description in the spec
bgpNo description in the spec
bgp.peerCountNo description in the spec
bgp.asOriginsNo description in the spec
bgp.asSetOriginsNo description in the spec
rpkiNo description in the spec
rpki.roasNo description in the spec
rpki.suggestionsNo description in the spec
routesNo description in the spec
routes.routeNo description in the spec
routes.originNo description in the spec
routes.descrNo description in the spec
routes.mnt_byNo description in the spec
routes.changedNo description in the spec
routes.sourceNo description in the spec
routingHealthNo description in the spec
routingHealth.criticalityStatusNo description in the spec
routingHealth.bgpStatusNo description in the spec
routingHealth.bgpActionsNo description in the spec
routingHealth.rpkiStatusNo description in the spec
routingHealth.rpkiActionsNo description in the spec
routingHealth.irrStatusNo description in the spec
routingHealth.irrActionsNo description in the spec
routingHealth.irmActionsNo description in the spec
cacheDerrivedNo description in the spec
cacheDerrived.registrarNo description in the spec
Request
curl -X PATCH 'https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/metadata' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '[
{
"notation": "string",
"metadata": {}
}
]'import os, requests
url = "https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/metadata"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = [
{
"notation": "string",
"metadata": {}
}
]
r = requests.patch(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/metadata";
const res = await fetch(url, {
method: "PATCH",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify([
{
"notation": "string",
"metadata": {}
}
]),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`[
{
"notation": "string",
"metadata": {}
}
]`)
req, _ := http.NewRequest("PATCH", "https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/metadata", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/metadata");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([[
"notation" => "string",
"metadata" => [
]
]]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
A list of updated prefixes.
[
{
"notation": "string",
"ipNet": {
"ip": "string",
"mask": "string"
},
"internalMetadata": {
"internal": "string",
"readOnly": "string",
"master": "string",
"prefixLengthLimits": {},
"holders": "string"
},
"externalMetadata": {},
"holderMetadata": {},
"geodata": [
{
"provider": {},
"countryName": {},
"countryCode": {},
"cityName": {},
"date": {},
"state": {}
}
],
"whois": {
"inetnum": "string",
"registrar": "string",
"source": "string",
"recordActive": "string",
"nets": "string",
"domains": "string"
},
"bgp": {
"peerCount": {},
"asOrigins": "string",
"asSetOrigins": "string"
}
}
]400
Bad request
{
"status": "string",
"code": 1,
"error": "string"
}403
Forbidden
{
"status": "string",
"code": 1,
"error": "string"
}500
Internal Server Error
{
"status": "string",
"code": 1,
"error": "string"
}Delete Holder Metadata
DELETE
/{tenantUUID}/prefixes/metadataDeletes target prefix holder metadata by requested keys and returns updated prefixes.
Path parameters
tenantUUIDTenant UUID
Request body
notationA string field representing the notation.
metadataAn array of strings representing metadata keys. Values can only contain following symbols: [A-Z, a-z, 0-9, -, _]
Response 200
notationNo description in the spec
ipNetNo description in the spec
ipNet.ipNo description in the spec
ipNet.maskNo description in the spec
internalMetadataNo description in the spec
internalMetadata.internalNo description in the spec
internalMetadata.readOnlyNo description in the spec
internalMetadata.masterNo description in the spec
internalMetadata.prefixLengthLimitsNo description in the spec
internalMetadata.holdersNo description in the spec
externalMetadataNo description in the spec
holderMetadataNo description in the spec
geodataNo description in the spec
geodata.providerNo description in the spec
geodata.countryNameNo description in the spec
geodata.countryCodeNo description in the spec
geodata.cityNameNo description in the spec
geodata.dateNo description in the spec
geodata.stateNo description in the spec
whoisNo description in the spec
whois.inetnumNo description in the spec
whois.registrarNo description in the spec
whois.sourceNo description in the spec
whois.recordActiveNo description in the spec
whois.netsNo description in the spec
whois.domainsNo description in the spec
bgpNo description in the spec
bgp.peerCountNo description in the spec
bgp.asOriginsNo description in the spec
bgp.asSetOriginsNo description in the spec
rpkiNo description in the spec
rpki.roasNo description in the spec
rpki.suggestionsNo description in the spec
routesNo description in the spec
routes.routeNo description in the spec
routes.originNo description in the spec
routes.descrNo description in the spec
routes.mnt_byNo description in the spec
routes.changedNo description in the spec
routes.sourceNo description in the spec
routingHealthNo description in the spec
routingHealth.criticalityStatusNo description in the spec
routingHealth.bgpStatusNo description in the spec
routingHealth.bgpActionsNo description in the spec
routingHealth.rpkiStatusNo description in the spec
routingHealth.rpkiActionsNo description in the spec
routingHealth.irrStatusNo description in the spec
routingHealth.irrActionsNo description in the spec
routingHealth.irmActionsNo description in the spec
cacheDerrivedNo description in the spec
cacheDerrived.registrarNo description in the spec
Request
curl -X DELETE 'https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/metadata' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '[
{
"notation": "string",
"metadata": [
"string"
]
}
]'import os, requests
url = "https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/metadata"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = [
{
"notation": "string",
"metadata": [
"string"
]
}
]
r = requests.delete(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/metadata";
const res = await fetch(url, {
method: "DELETE",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify([
{
"notation": "string",
"metadata": [
"string"
]
}
]),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`[
{
"notation": "string",
"metadata": [
"string"
]
}
]`)
req, _ := http.NewRequest("DELETE", "https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/metadata", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/metadata");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([[
"notation" => "string",
"metadata" => ["string"]
]]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
A list of updated prefixes.
[
{
"notation": "string",
"ipNet": {
"ip": "string",
"mask": "string"
},
"internalMetadata": {
"internal": "string",
"readOnly": "string",
"master": "string",
"prefixLengthLimits": {},
"holders": "string"
},
"externalMetadata": {},
"holderMetadata": {},
"geodata": [
{
"provider": {},
"countryName": {},
"countryCode": {},
"cityName": {},
"date": {},
"state": {}
}
],
"whois": {
"inetnum": "string",
"registrar": "string",
"source": "string",
"recordActive": "string",
"nets": "string",
"domains": "string"
},
"bgp": {
"peerCount": {},
"asOrigins": "string",
"asSetOrigins": "string"
}
}
]400
Bad request
{
"status": "string",
"code": 1,
"error": "string"
}403
Forbidden
{
"status": "string",
"code": 1,
"error": "string"
}500
Internal Server Error
{
"status": "string",
"code": 1,
"error": "string"
}Delete All Holder Metadata
DELETE
/{tenantUUID}/prefixes/metadata/allDeletes target prefix holder metadata and returns updated prefixes.
Path parameters
tenantUUIDTenant UUID
Request body
notationA string field representing the notation.
Response 200
notationNo description in the spec
ipNetNo description in the spec
ipNet.ipNo description in the spec
ipNet.maskNo description in the spec
internalMetadataNo description in the spec
internalMetadata.internalNo description in the spec
internalMetadata.readOnlyNo description in the spec
internalMetadata.masterNo description in the spec
internalMetadata.prefixLengthLimitsNo description in the spec
internalMetadata.holdersNo description in the spec
externalMetadataNo description in the spec
holderMetadataNo description in the spec
geodataNo description in the spec
geodata.providerNo description in the spec
geodata.countryNameNo description in the spec
geodata.countryCodeNo description in the spec
geodata.cityNameNo description in the spec
geodata.dateNo description in the spec
geodata.stateNo description in the spec
whoisNo description in the spec
whois.inetnumNo description in the spec
whois.registrarNo description in the spec
whois.sourceNo description in the spec
whois.recordActiveNo description in the spec
whois.netsNo description in the spec
whois.domainsNo description in the spec
bgpNo description in the spec
bgp.peerCountNo description in the spec
bgp.asOriginsNo description in the spec
bgp.asSetOriginsNo description in the spec
rpkiNo description in the spec
rpki.roasNo description in the spec
rpki.suggestionsNo description in the spec
routesNo description in the spec
routes.routeNo description in the spec
routes.originNo description in the spec
routes.descrNo description in the spec
routes.mnt_byNo description in the spec
routes.changedNo description in the spec
routes.sourceNo description in the spec
routingHealthNo description in the spec
routingHealth.criticalityStatusNo description in the spec
routingHealth.bgpStatusNo description in the spec
routingHealth.bgpActionsNo description in the spec
routingHealth.rpkiStatusNo description in the spec
routingHealth.rpkiActionsNo description in the spec
routingHealth.irrStatusNo description in the spec
routingHealth.irrActionsNo description in the spec
routingHealth.irmActionsNo description in the spec
cacheDerrivedNo description in the spec
cacheDerrived.registrarNo description in the spec
Request
curl -X DELETE 'https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/metadata/all' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '[
{
"notation": "string"
}
]'import os, requests
url = "https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/metadata/all"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = [
{
"notation": "string"
}
]
r = requests.delete(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/metadata/all";
const res = await fetch(url, {
method: "DELETE",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify([
{
"notation": "string"
}
]),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`[
{
"notation": "string"
}
]`)
req, _ := http.NewRequest("DELETE", "https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/metadata/all", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/metadata/all");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([[
"notation" => "string"
]]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
A list of updated prefixes.
[
{
"notation": "string",
"ipNet": {
"ip": "string",
"mask": "string"
},
"internalMetadata": {
"internal": "string",
"readOnly": "string",
"master": "string",
"prefixLengthLimits": {},
"holders": "string"
},
"externalMetadata": {},
"holderMetadata": {},
"geodata": [
{
"provider": {},
"countryName": {},
"countryCode": {},
"cityName": {},
"date": {},
"state": {}
}
],
"whois": {
"inetnum": "string",
"registrar": "string",
"source": "string",
"recordActive": "string",
"nets": "string",
"domains": "string"
},
"bgp": {
"peerCount": {},
"asOrigins": "string",
"asSetOrigins": "string"
}
}
]400
Bad request
{
"status": "string",
"code": 1,
"error": "string"
}403
Forbidden
{
"status": "string",
"code": 1,
"error": "string"
}500
Internal Server Error
{
"status": "string",
"code": 1,
"error": "string"
}Add metadata array elements to existing prefix holders metadata
POST
/{tenantUUID}/prefixes/metadata/arrayThis endpoint allows for the addition of array elements to the metadata arrays of existing prefix holders. If matching values already exist no action is performed.
Path parameters
tenantUUIDTenant UUID
Request body
notationThe notation identifier for the metadata array.
itemsNo description in the spec
items.pathToArrayNo description in the spec
items.elementsNo description in the spec
items.positionNo description in the spec
Response 200
notationNo description in the spec
ipNetNo description in the spec
ipNet.ipNo description in the spec
ipNet.maskNo description in the spec
maskSizeNo description in the spec
type0 - IPv4, 1 - IPv6
0 1holderMetadataNo description in the spec
Request
curl -X POST 'https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/metadata/array' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '[
{
"notation": "string",
"items": [
{
"pathToArray": {},
"elements": {},
"position": {}
}
]
}
]'import os, requests
url = "https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/metadata/array"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = [
{
"notation": "string",
"items": [
{
"pathToArray": {},
"elements": {},
"position": {}
}
]
}
]
r = requests.post(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/metadata/array";
const res = await fetch(url, {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify([
{
"notation": "string",
"items": [
{
"pathToArray": {},
"elements": {},
"position": {}
}
]
}
]),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`[
{
"notation": "string",
"items": [
{
"pathToArray": {},
"elements": {},
"position": {}
}
]
}
]`)
req, _ := http.NewRequest("POST", "https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/metadata/array", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/metadata/array");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([[
"notation" => "string",
"items" => [[
"pathToArray" => [
],
"elements" => [
],
"position" => [
]
]]
]]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Successful addition of metadata array elements.
[
{
"notation": "string",
"ipNet": {
"ip": "string",
"mask": "string"
},
"maskSize": 1,
"type": 0,
"holderMetadata": {}
}
]400
Bad request.
{
"status": "string",
"code": 1,
"error": "string"
}403
Forbidden
{
"status": "string",
"code": 1,
"error": "string"
}404
Not Found.
{
"status": "string",
"code": 1,
"error": "string"
}500
Internal Server Error.
{
"status": "string",
"code": 1,
"error": "string"
}Add metadata array elements to existing prefix holders metadata
PATCH
/{tenantUUID}/prefixes/metadata/arrayThis endpoint allows for the addition of array elements to the metadata arrays of existing prefix holders. Values are always added to the target array. Position can be provided to set where exactly in the array new values should be added. If element in the target position already exists the value is overwritten.
Path parameters
tenantUUIDTenant UUID
Request body
notationThe notation identifier for the metadata array.
itemsNo description in the spec
items.pathToArrayNo description in the spec
items.elementsNo description in the spec
items.positionNo description in the spec
Response 200
notationNo description in the spec
ipNetNo description in the spec
ipNet.ipNo description in the spec
ipNet.maskNo description in the spec
maskSizeNo description in the spec
type0 - IPv4, 1 - IPv6
0 1holderMetadataNo description in the spec
Request
curl -X PATCH 'https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/metadata/array' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '[
{
"notation": "string",
"items": [
{
"pathToArray": {},
"elements": {},
"position": {}
}
]
}
]'import os, requests
url = "https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/metadata/array"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = [
{
"notation": "string",
"items": [
{
"pathToArray": {},
"elements": {},
"position": {}
}
]
}
]
r = requests.patch(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/metadata/array";
const res = await fetch(url, {
method: "PATCH",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify([
{
"notation": "string",
"items": [
{
"pathToArray": {},
"elements": {},
"position": {}
}
]
}
]),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`[
{
"notation": "string",
"items": [
{
"pathToArray": {},
"elements": {},
"position": {}
}
]
}
]`)
req, _ := http.NewRequest("PATCH", "https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/metadata/array", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/metadata/array");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([[
"notation" => "string",
"items" => [[
"pathToArray" => [
],
"elements" => [
],
"position" => [
]
]]
]]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Successful addition of metadata array elements.
[
{
"notation": "string",
"ipNet": {
"ip": "string",
"mask": "string"
},
"maskSize": 1,
"type": 0,
"holderMetadata": {}
}
]400
Bad request.
{
"status": "string",
"code": 1,
"error": "string"
}403
Forbidden
{
"status": "string",
"code": 1,
"error": "string"
}404
Not Found.
{
"status": "string",
"code": 1,
"error": "string"
}500
Internal Server Error.
{
"status": "string",
"code": 1,
"error": "string"
}Remove metadata array elements from existing prefix holders metadata
DELETE
/{tenantUUID}/prefixes/metadata/arrayThis endpoint allows for the deletion of array elements from the metadata arrays of existing prefix holders. This endpoint can be combined with `DELETE - /{tenantUUID}/prefixes/metadata` by removing specific array components with that endpoint first and since it sets values to `NULL` when performing delete operations on array positions, one can execute this API call by providing single value of `NULL` to `elements` and it will easily remove all those elements, freeing up array space and resetting positions.
Path parameters
tenantUUIDTenant UUID
Request body
notationThe notation identifier for the metadata array.
itemsNo description in the spec
items.pathToArrayNo description in the spec
items.elementsNo description in the spec
items.positionNo description in the spec
Response 200
notationNo description in the spec
ipNetNo description in the spec
ipNet.ipNo description in the spec
ipNet.maskNo description in the spec
maskSizeNo description in the spec
type0 - IPv4, 1 - IPv6
0 1holderMetadataNo description in the spec
Request
curl -X DELETE 'https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/metadata/array' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '[
{
"notation": "string",
"items": [
{
"pathToArray": {},
"elements": {},
"position": {}
}
]
}
]'import os, requests
url = "https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/metadata/array"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = [
{
"notation": "string",
"items": [
{
"pathToArray": {},
"elements": {},
"position": {}
}
]
}
]
r = requests.delete(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/metadata/array";
const res = await fetch(url, {
method: "DELETE",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify([
{
"notation": "string",
"items": [
{
"pathToArray": {},
"elements": {},
"position": {}
}
]
}
]),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`[
{
"notation": "string",
"items": [
{
"pathToArray": {},
"elements": {},
"position": {}
}
]
}
]`)
req, _ := http.NewRequest("DELETE", "https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/metadata/array", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/metadata/array");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([[
"notation" => "string",
"items" => [[
"pathToArray" => [
],
"elements" => [
],
"position" => [
]
]]
]]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Successful deletion of metadata array elements.
[
{
"notation": "string",
"ipNet": {
"ip": "string",
"mask": "string"
},
"maskSize": 1,
"type": 0,
"holderMetadata": {}
}
]400
Bad request.
{
"status": "string",
"code": 1,
"error": "string"
}403
Forbidden
{
"status": "string",
"code": 1,
"error": "string"
}404
Not Found.
{
"status": "string",
"code": 1,
"error": "string"
}500
Internal Server Error.
{
"status": "string",
"code": 1,
"error": "string"
}Search for Prefixes
POST
/{tenantUUID}/prefixes/searchReturns a list of prefixes that match the given search parameters.
Path parameters
tenantUUIDTenant UUID
Request body
notationNo description in the spec
notation.fieldThe field to be searched.
notation.opThe operation to be performed. Possible values include 'or', 'and', 'eq', 'ne', 'lt', 'lte', 'gt', 'gte'.
notation.valsThe values to be used for the operation.
notation.childrenAn array of child filters, if any.
internalMetadataNo description in the spec
internalMetadata.fieldThe field to be searched.
internalMetadata.opThe operation to be performed. Possible values include 'or', 'and', 'eq', 'ne', 'lt', 'lte', 'gt', 'gte'.
internalMetadata.valsThe values to be used for the operation.
internalMetadata.childrenAn array of child filters, if any.
externalMetadataNo description in the spec
externalMetadata.fieldThe field to be searched.
externalMetadata.opThe operation to be performed. Possible values include 'or', 'and', 'eq', 'ne', 'lt', 'lte', 'gt', 'gte'.
externalMetadata.valsThe values to be used for the operation.
externalMetadata.childrenAn array of child filters, if any.
holderMetadataNo description in the spec
holderMetadata.fieldThe field to be searched.
holderMetadata.opThe operation to be performed. Possible values include 'or', 'and', 'eq', 'ne', 'lt', 'lte', 'gt', 'gte'.
holderMetadata.valsThe values to be used for the operation.
holderMetadata.childrenAn array of child filters, if any.
geodataNo description in the spec
geodata.fieldThe field to be searched.
geodata.opThe operation to be performed. Possible values include 'or', 'and', 'eq', 'ne', 'lt', 'lte', 'gt', 'gte'.
geodata.valsThe values to be used for the operation.
geodata.childrenAn array of child filters, if any.
whoisNo description in the spec
whois.fieldThe field to be searched.
whois.opThe operation to be performed. Possible values include 'or', 'and', 'eq', 'ne', 'lt', 'lte', 'gt', 'gte'.
whois.valsThe values to be used for the operation.
whois.childrenAn array of child filters, if any.
bgpNo description in the spec
bgp.fieldThe field to be searched.
bgp.opThe operation to be performed. Possible values include 'or', 'and', 'eq', 'ne', 'lt', 'lte', 'gt', 'gte'.
bgp.valsThe values to be used for the operation.
bgp.childrenAn array of child filters, if any.
rpkiNo description in the spec
rpki.fieldThe field to be searched.
rpki.opThe operation to be performed. Possible values include 'or', 'and', 'eq', 'ne', 'lt', 'lte', 'gt', 'gte'.
rpki.valsThe values to be used for the operation.
rpki.childrenAn array of child filters, if any.
routesNo description in the spec
routes.fieldThe field to be searched.
routes.opThe operation to be performed. Possible values include 'or', 'and', 'eq', 'ne', 'lt', 'lte', 'gt', 'gte'.
routes.valsThe values to be used for the operation.
routes.childrenAn array of child filters, if any.
routingHealthNo description in the spec
routingHealth.fieldThe field to be searched.
routingHealth.opThe operation to be performed. Possible values include 'or', 'and', 'eq', 'ne', 'lt', 'lte', 'gt', 'gte'.
routingHealth.valsThe values to be used for the operation.
routingHealth.childrenAn array of child filters, if any.
cacheDerrivedNo description in the spec
cacheDerrived.fieldThe field to be searched.
cacheDerrived.opThe operation to be performed. Possible values include 'or', 'and', 'eq', 'ne', 'lt', 'lte', 'gt', 'gte'.
cacheDerrived.valsThe values to be used for the operation.
cacheDerrived.childrenAn array of child filters, if any.
offsetNo description in the spec
limitNo description in the spec
sortSort order for the returned items. Keys must be provided in a single string, separated by `,`. Order determines sorting priority. Adding `-` in front of the key enables DESCENDING sort. Supported keys: [`notation`, `ipNet`]. To achieve correct "IP sort" use `ipNet`.
fieldsarray of prefix object fields to return in response. Supports sub-object projection by using `.`, i.e.: `geodata.provider`. **NOTE**: `internalMetadata` does not fully support sub-object field projection and will always return entire structure, with non-requested fields initialized with default type values (i.e. booleans will be equal to `FALSE` and strings to `""`), so it is advised to always request entire `internalMetadata` to avoid data analysis inconsistencies.
Response 200
dataNo description in the spec
data.notationNo description in the spec
data.ipNetNo description in the spec
data.internalMetadataNo description in the spec
data.externalMetadataNo description in the spec
data.holderMetadataNo description in the spec
data.geodataNo description in the spec
data.whoisNo description in the spec
data.bgpNo description in the spec
data.rpkiNo description in the spec
data.routesNo description in the spec
data.routingHealthNo description in the spec
data.cacheDerrivedNo description in the spec
metadataNo description in the spec
metadata.limitNo description in the spec
metadata.offsetNo description in the spec
Request
curl -X POST 'https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/search' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"notation": {
"field": "string",
"op": "string",
"vals": [
"string"
],
"children": [
{}
]
},
"internalMetadata": {
"field": "string",
"op": "string",
"vals": [
"string"
],
"children": [
{}
]
},
"externalMetadata": {
"field": "string",
"op": "string",
"vals": [
"string"
],
"children": [
{}
]
},
"holderMetadata": {
"field": "string",
"op": "string",
"vals": [
"string"
],
"children": [
{}
]
},
"geodata": {
"field": "string",
"op": "string",
"vals": [
"string"
],
"children": [
{}
]
},
"whois": {
"field": "string",
"op": "string",
"vals": [
"string"
],
"children": [
{}
]
},
"bgp": {
"field": "string",
"op": "string",
"vals": [
"string"
],
"children": [
{}
]
},
"rpki": {
"field": "string",
"op": "string",
"vals": [
"string"
],
"children": [
{}
]
}
}'import os, requests
url = "https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/search"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = {
"notation": {
"field": "string",
"op": "string",
"vals": [
"string"
],
"children": [
{}
]
},
"internalMetadata": {
"field": "string",
"op": "string",
"vals": [
"string"
],
"children": [
{}
]
},
"externalMetadata": {
"field": "string",
"op": "string",
"vals": [
"string"
],
"children": [
{}
]
},
"holderMetadata": {
"field": "string",
"op": "string",
"vals": [
"string"
],
"children": [
{}
]
},
"geodata": {
"field": "string",
"op": "string",
"vals": [
"string"
],
"children": [
{}
]
},
"whois": {
"field": "string",
"op": "string",
"vals": [
"string"
],
"children": [
{}
]
},
"bgp": {
"field": "string",
"op": "string",
"vals": [
"string"
],
"children": [
{}
]
},
"rpki": {
"field": "string",
"op": "string",
"vals": [
"string"
],
"children": [
{}
]
}
}
r = requests.post(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/search";
const res = await fetch(url, {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify({
"notation": {
"field": "string",
"op": "string",
"vals": [
"string"
],
"children": [
{}
]
},
"internalMetadata": {
"field": "string",
"op": "string",
"vals": [
"string"
],
"children": [
{}
]
},
"externalMetadata": {
"field": "string",
"op": "string",
"vals": [
"string"
],
"children": [
{}
]
},
"holderMetadata": {
"field": "string",
"op": "string",
"vals": [
"string"
],
"children": [
{}
]
},
"geodata": {
"field": "string",
"op": "string",
"vals": [
"string"
],
"children": [
{}
]
},
"whois": {
"field": "string",
"op": "string",
"vals": [
"string"
],
"children": [
{}
]
},
"bgp": {
"field": "string",
"op": "string",
"vals": [
"string"
],
"children": [
{}
]
},
"rpki": {
"field": "string",
"op": "string",
"vals": [
"string"
],
"children": [
{}
]
}
}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"notation": {
"field": "string",
"op": "string",
"vals": [
"string"
],
"children": [
{}
]
},
"internalMetadata": {
"field": "string",
"op": "string",
"vals": [
"string"
],
"children": [
{}
]
},
"externalMetadata": {
"field": "string",
"op": "string",
"vals": [
"string"
],
"children": [
{}
]
},
"holderMetadata": {
"field": "string",
"op": "string",
"vals": [
"string"
],
"children": [
{}
]
},
"geodata": {
"field": "string",
"op": "string",
"vals": [
"string"
],
"children": [
{}
]
},
"whois": {
"field": "string",
"op": "string",
"vals": [
"string"
],
"children": [
{}
]
},
"bgp": {
"field": "string",
"op": "string",
"vals": [
"string"
],
"children": [
{}
]
},
"rpki": {
"field": "string",
"op": "string",
"vals": [
"string"
],
"children": [
{}
]
}
}`)
req, _ := http.NewRequest("POST", "https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/search", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/search");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"notation" => [
"field" => "string",
"op" => "string",
"vals" => ["string"],
"children" => [[
]]
],
"internalMetadata" => [
"field" => "string",
"op" => "string",
"vals" => ["string"],
"children" => [[
]]
],
"externalMetadata" => [
"field" => "string",
"op" => "string",
"vals" => ["string"],
"children" => [[
]]
],
"holderMetadata" => [
"field" => "string",
"op" => "string",
"vals" => ["string"],
"children" => [[
]]
],
"geodata" => [
"field" => "string",
"op" => "string",
"vals" => ["string"],
"children" => [[
]]
],
"whois" => [
"field" => "string",
"op" => "string",
"vals" => ["string"],
"children" => [[
]]
],
"bgp" => [
"field" => "string",
"op" => "string",
"vals" => ["string"],
"children" => [[
]]
],
"rpki" => [
"field" => "string",
"op" => "string",
"vals" => ["string"],
"children" => [[
]]
]
]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
A list of matching prefixes.
{
"data": [
{
"notation": "string",
"ipNet": {},
"internalMetadata": {},
"externalMetadata": {},
"holderMetadata": {},
"geodata": "string",
"whois": {},
"bgp": {}
}
],
"metadata": {
"limit": 1,
"offset": 1
}
}400
Bad request
{
"status": "string",
"code": 1,
"error": "string"
}403
Forbidden
{
"status": "string",
"code": 1,
"error": "string"
}500
Internal Server Error
{
"status": "string",
"code": 1,
"error": "string"
}Find master prefixes with subsets metadata
GET
/{tenantUUID}/prefixes/subsets/metadataReturns the master prefixes with subsets metadata based on the provided search criteria
Path parameters
tenantUUIDTenant UUID
Query parameters
notationlist of starting point notations. If provided will use these notations to find prefixes to use as top-levels to begin calculating subsets. If not provided will default to master level prefixes. Can provide multiple values by using the same key.
offsetThe number of items to skip before starting to collect the result set
limitThe numbers of items to return
sortSort order for the returned items. Keys must be provided in a single string, separated by `,`. Order determines sorting priority. Adding `-` in front of the key enables DESCENDING sort. Supported keys: [`notation`, `ipNet`]. To achieve correct "IP sort" use `ipNet`.
fieldsComma (`,`) separated list of prefix object fields to return in response. Supports sub-object projection by using `.`, i.e.: `geodata.provider`. **NOTE**: `internalMetadata` does not fully support sub-object field projection and will always return entire structure, with non-requested fields initialized with default type values (i.e. booleans will be equal to `FALSE` and strings to `""`), so it is advised to always request entire `internalMetadata` to avoid data analysis inconsistencies.
Response 200
dataNo description in the spec
data.notationNo description in the spec
data.ipNetNo description in the spec
data.internalMetadataNo description in the spec
data.externalMetadataNo description in the spec
data.holderMetadataNo description in the spec
data.geodataNo description in the spec
data.whoisNo description in the spec
data.bgpNo description in the spec
data.rpkiNo description in the spec
data.routesNo description in the spec
data.routingHealthNo description in the spec
data.cacheDerrivedNo description in the spec
data.subsetsNo description in the spec
metadataNo description in the spec
metadata.limitNo description in the spec
metadata.offsetNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/subsets/metadata' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/subsets/metadata"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/subsets/metadata";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/subsets/metadata", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/subsets/metadata");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Successfully retrieved master prefixes with subsets metadata
{
"data": [
{
"notation": "string",
"ipNet": {},
"internalMetadata": {},
"externalMetadata": {},
"holderMetadata": {},
"geodata": "string",
"whois": {},
"bgp": {}
}
],
"metadata": {
"limit": 1,
"offset": 1
}
}400
Bad request
{
"status": "string",
"code": 1,
"error": "string"
}500
Internal Server Error.
{
"status": "string",
"code": 1,
"error": "string"
}Set Holder Metadata for a single Prefix
PATCH
/{tenantUUID}/prefixes/{notation}/metadataUpdates target prefix holder metadata and returns updated prefix.
Path parameters
tenantUUIDTenant UUID
notationPrefix notation
Request body
metadataA map to hold the metadata. Map keys can only contain following symbols: [A-Z, a-z, 0-9, -, _]
Response 200
notationNo description in the spec
ipNetNo description in the spec
ipNet.ipNo description in the spec
ipNet.maskNo description in the spec
internalMetadataNo description in the spec
internalMetadata.internalNo description in the spec
internalMetadata.readOnlyNo description in the spec
internalMetadata.masterNo description in the spec
internalMetadata.prefixLengthLimitsNo description in the spec
internalMetadata.prefixLengthLimits.typeNo description in the spec
internalMetadata.prefixLengthLimits.x-truncatedNo description in the spec
internalMetadata.holdersNo description in the spec
externalMetadataNo description in the spec
holderMetadataNo description in the spec
geodataNo description in the spec
geodata.providerNo description in the spec
geodata.countryNameNo description in the spec
geodata.countryCodeNo description in the spec
geodata.cityNameNo description in the spec
geodata.dateNo description in the spec
geodata.stateNo description in the spec
whoisNo description in the spec
whois.inetnumNo description in the spec
whois.registrarNo description in the spec
whois.sourceNo description in the spec
whois.recordActiveNo description in the spec
whois.netsNo description in the spec
whois.domainsNo description in the spec
bgpNo description in the spec
bgp.peerCountNo description in the spec
bgp.peerCount.typeNo description in the spec
bgp.peerCount.x-truncatedNo description in the spec
bgp.asOriginsNo description in the spec
bgp.asSetOriginsNo description in the spec
rpkiNo description in the spec
rpki.roasNo description in the spec
rpki.suggestionsNo description in the spec
routesNo description in the spec
routes.routeNo description in the spec
routes.originNo description in the spec
routes.descrNo description in the spec
routes.mnt_byNo description in the spec
routes.changedNo description in the spec
routes.sourceNo description in the spec
routingHealthNo description in the spec
routingHealth.criticalityStatusNo description in the spec
routingHealth.bgpStatusNo description in the spec
routingHealth.bgpActionsNo description in the spec
routingHealth.rpkiStatusNo description in the spec
routingHealth.rpkiActionsNo description in the spec
routingHealth.irrStatusNo description in the spec
routingHealth.irrActionsNo description in the spec
routingHealth.irmActionsNo description in the spec
cacheDerrivedNo description in the spec
cacheDerrived.registrarNo description in the spec
Request
curl -X PATCH 'https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/{notation}/metadata' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"metadata": {}
}'import os, requests
url = "https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/{notation}/metadata"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = {
"metadata": {}
}
r = requests.patch(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/{notation}/metadata";
const res = await fetch(url, {
method: "PATCH",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify({
"metadata": {}
}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"metadata": {}
}`)
req, _ := http.NewRequest("PATCH", "https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/{notation}/metadata", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/{notation}/metadata");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"metadata" => [
]
]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Updated prefix
{
"notation": "string",
"ipNet": {
"ip": "string",
"mask": "string"
},
"internalMetadata": {
"internal": true,
"readOnly": true,
"master": true,
"prefixLengthLimits": {
"type": "string",
"x-truncated": "string"
},
"holders": [
{}
]
},
"externalMetadata": {},
"holderMetadata": {},
"geodata": [
{
"provider": "string",
"countryName": "string",
"countryCode": "string",
"cityName": "string",
"date": "string",
"state": "string"
}
],
"whois": {
"inetnum": "string",
"registrar": "string",
"source": "string",
"recordActive": true,
"nets": [
{}
],
"domains": [
{}
]
},
"bgp": {
"peerCount": {
"type": "string",
"x-truncated": "string"
},
"asOrigins": [
{}
],
"asSetOrigins": [
{}
]
}
}400
Bad request
{
"status": "string",
"code": 1,
"error": "string"
}403
Forbidden
{
"status": "string",
"code": 1,
"error": "string"
}500
Internal Server Error
{
"status": "string",
"code": 1,
"error": "string"
}Delete Holder Metadata for a single Prefix
DELETE
/{tenantUUID}/prefixes/{notation}/metadataDeletes target prefix holder metadata and returns updated prefix.
Path parameters
tenantUUIDTenant UUID
notationPrefix notation
Request body
metadataAn array of strings representing metadata keys. Values can only contain following symbols: [A-Z, a-z, 0-9, -, _]
Response 200
notationNo description in the spec
ipNetNo description in the spec
ipNet.ipNo description in the spec
ipNet.maskNo description in the spec
internalMetadataNo description in the spec
internalMetadata.internalNo description in the spec
internalMetadata.readOnlyNo description in the spec
internalMetadata.masterNo description in the spec
internalMetadata.prefixLengthLimitsNo description in the spec
internalMetadata.prefixLengthLimits.typeNo description in the spec
internalMetadata.prefixLengthLimits.x-truncatedNo description in the spec
internalMetadata.holdersNo description in the spec
externalMetadataNo description in the spec
holderMetadataNo description in the spec
geodataNo description in the spec
geodata.providerNo description in the spec
geodata.countryNameNo description in the spec
geodata.countryCodeNo description in the spec
geodata.cityNameNo description in the spec
geodata.dateNo description in the spec
geodata.stateNo description in the spec
whoisNo description in the spec
whois.inetnumNo description in the spec
whois.registrarNo description in the spec
whois.sourceNo description in the spec
whois.recordActiveNo description in the spec
whois.netsNo description in the spec
whois.domainsNo description in the spec
bgpNo description in the spec
bgp.peerCountNo description in the spec
bgp.peerCount.typeNo description in the spec
bgp.peerCount.x-truncatedNo description in the spec
bgp.asOriginsNo description in the spec
bgp.asSetOriginsNo description in the spec
rpkiNo description in the spec
rpki.roasNo description in the spec
rpki.suggestionsNo description in the spec
routesNo description in the spec
routes.routeNo description in the spec
routes.originNo description in the spec
routes.descrNo description in the spec
routes.mnt_byNo description in the spec
routes.changedNo description in the spec
routes.sourceNo description in the spec
routingHealthNo description in the spec
routingHealth.criticalityStatusNo description in the spec
routingHealth.bgpStatusNo description in the spec
routingHealth.bgpActionsNo description in the spec
routingHealth.rpkiStatusNo description in the spec
routingHealth.rpkiActionsNo description in the spec
routingHealth.irrStatusNo description in the spec
routingHealth.irrActionsNo description in the spec
routingHealth.irmActionsNo description in the spec
cacheDerrivedNo description in the spec
cacheDerrived.registrarNo description in the spec
Request
curl -X DELETE 'https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/{notation}/metadata' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"metadata": [
"string"
]
}'import os, requests
url = "https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/{notation}/metadata"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = {
"metadata": [
"string"
]
}
r = requests.delete(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/{notation}/metadata";
const res = await fetch(url, {
method: "DELETE",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify({
"metadata": [
"string"
]
}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"metadata": [
"string"
]
}`)
req, _ := http.NewRequest("DELETE", "https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/{notation}/metadata", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/{notation}/metadata");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"metadata" => ["string"]
]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Updated prefix.
{
"notation": "string",
"ipNet": {
"ip": "string",
"mask": "string"
},
"internalMetadata": {
"internal": true,
"readOnly": true,
"master": true,
"prefixLengthLimits": {
"type": "string",
"x-truncated": "string"
},
"holders": [
{}
]
},
"externalMetadata": {},
"holderMetadata": {},
"geodata": [
{
"provider": "string",
"countryName": "string",
"countryCode": "string",
"cityName": "string",
"date": "string",
"state": "string"
}
],
"whois": {
"inetnum": "string",
"registrar": "string",
"source": "string",
"recordActive": true,
"nets": [
{}
],
"domains": [
{}
]
},
"bgp": {
"peerCount": {
"type": "string",
"x-truncated": "string"
},
"asOrigins": [
{}
],
"asSetOrigins": [
{}
]
}
}400
Bad request
{
"status": "string",
"code": 1,
"error": "string"
}403
Forbidden
{
"status": "string",
"code": 1,
"error": "string"
}500
Internal Server Error
{
"status": "string",
"code": 1,
"error": "string"
}Delete All Holder Metadata for a single Prefix
DELETE
/{tenantUUID}/prefixes/{notation}/metadata/allDeletes target prefix holder metadata and returns updated prefix.
Path parameters
tenantUUIDTenant UUID
notationPrefix notation
Response 200
notationNo description in the spec
ipNetNo description in the spec
ipNet.ipNo description in the spec
ipNet.maskNo description in the spec
internalMetadataNo description in the spec
internalMetadata.internalNo description in the spec
internalMetadata.readOnlyNo description in the spec
internalMetadata.masterNo description in the spec
internalMetadata.prefixLengthLimitsNo description in the spec
internalMetadata.prefixLengthLimits.typeNo description in the spec
internalMetadata.prefixLengthLimits.x-truncatedNo description in the spec
internalMetadata.holdersNo description in the spec
externalMetadataNo description in the spec
holderMetadataNo description in the spec
geodataNo description in the spec
geodata.providerNo description in the spec
geodata.countryNameNo description in the spec
geodata.countryCodeNo description in the spec
geodata.cityNameNo description in the spec
geodata.dateNo description in the spec
geodata.stateNo description in the spec
whoisNo description in the spec
whois.inetnumNo description in the spec
whois.registrarNo description in the spec
whois.sourceNo description in the spec
whois.recordActiveNo description in the spec
whois.netsNo description in the spec
whois.domainsNo description in the spec
bgpNo description in the spec
bgp.peerCountNo description in the spec
bgp.peerCount.typeNo description in the spec
bgp.peerCount.x-truncatedNo description in the spec
bgp.asOriginsNo description in the spec
bgp.asSetOriginsNo description in the spec
rpkiNo description in the spec
rpki.roasNo description in the spec
rpki.suggestionsNo description in the spec
routesNo description in the spec
routes.routeNo description in the spec
routes.originNo description in the spec
routes.descrNo description in the spec
routes.mnt_byNo description in the spec
routes.changedNo description in the spec
routes.sourceNo description in the spec
routingHealthNo description in the spec
routingHealth.criticalityStatusNo description in the spec
routingHealth.bgpStatusNo description in the spec
routingHealth.bgpActionsNo description in the spec
routingHealth.rpkiStatusNo description in the spec
routingHealth.rpkiActionsNo description in the spec
routingHealth.irrStatusNo description in the spec
routingHealth.irrActionsNo description in the spec
routingHealth.irmActionsNo description in the spec
cacheDerrivedNo description in the spec
cacheDerrived.registrarNo description in the spec
Request
curl -X DELETE 'https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/{notation}/metadata/all' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/{notation}/metadata/all"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.delete(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/{notation}/metadata/all";
const res = await fetch(url, {
method: "DELETE",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("DELETE", "https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/{notation}/metadata/all", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/{notation}/metadata/all");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Updated prefix.
{
"notation": "string",
"ipNet": {
"ip": "string",
"mask": "string"
},
"internalMetadata": {
"internal": true,
"readOnly": true,
"master": true,
"prefixLengthLimits": {
"type": "string",
"x-truncated": "string"
},
"holders": [
{}
]
},
"externalMetadata": {},
"holderMetadata": {},
"geodata": [
{
"provider": "string",
"countryName": "string",
"countryCode": "string",
"cityName": "string",
"date": "string",
"state": "string"
}
],
"whois": {
"inetnum": "string",
"registrar": "string",
"source": "string",
"recordActive": true,
"nets": [
{}
],
"domains": [
{}
]
},
"bgp": {
"peerCount": {
"type": "string",
"x-truncated": "string"
},
"asOrigins": [
{}
],
"asSetOrigins": [
{}
]
}
}400
Bad request
{
"status": "string",
"code": 1,
"error": "string"
}403
Forbidden
{
"status": "string",
"code": 1,
"error": "string"
}500
Internal Server Error
{
"status": "string",
"code": 1,
"error": "string"
}Add metadata array elements to existing prefix holders metadata of a specified notation
POST
/{tenantUUID}/prefixes/{notation}/metadata/arrayThis endpoint allows for the addition of array elements to the metadata arrays of existing prefix holders notation. If matching values already exist no action is performed.
Path parameters
tenantUUIDTenant UUID
notationPrefix notation
Request body
pathToArrayThe path to the metadata array in the holder.
elementsThe elements to add to the array.
positionThe position at which to add elements in the array. Only works with push. Optional.
Response 200
notationNo description in the spec
ipNetNo description in the spec
ipNet.ipNo description in the spec
ipNet.maskNo description in the spec
maskSizeNo description in the spec
type0 - IPv4, 1 - IPv6
0 1holderMetadataNo description in the spec
Request
curl -X POST 'https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/{notation}/metadata/array' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '[
{
"pathToArray": "string",
"elements": [
{}
],
"position": 1
}
]'import os, requests
url = "https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/{notation}/metadata/array"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = [
{
"pathToArray": "string",
"elements": [
{}
],
"position": 1
}
]
r = requests.post(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/{notation}/metadata/array";
const res = await fetch(url, {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify([
{
"pathToArray": "string",
"elements": [
{}
],
"position": 1
}
]),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`[
{
"pathToArray": "string",
"elements": [
{}
],
"position": 1
}
]`)
req, _ := http.NewRequest("POST", "https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/{notation}/metadata/array", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/{notation}/metadata/array");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([[
"pathToArray" => "string",
"elements" => [[
]],
"position" => 1
]]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Successful addition of metadata array elements.
[
{
"notation": "string",
"ipNet": {
"ip": "string",
"mask": "string"
},
"maskSize": 1,
"type": 0,
"holderMetadata": {}
}
]400
Bad request.
{
"status": "string",
"code": 1,
"error": "string"
}403
Forbidden
{
"status": "string",
"code": 1,
"error": "string"
}404
Not Found.
{
"status": "string",
"code": 1,
"error": "string"
}500
Internal Server Error.
{
"status": "string",
"code": 1,
"error": "string"
}Add metadata array elements to existing prefix holders metadata of a specified notation
PATCH
/{tenantUUID}/prefixes/{notation}/metadata/arrayThis endpoint allows for the addition of array elements to the metadata arrays of existing prefix holders notation. Values are always added to the target array. Position can be provided to set where exactly in the array new values should be added. If element in the target position already exists the value is overwritten.
Path parameters
tenantUUIDTenant UUID
notationPrefix notation
Request body
pathToArrayThe path to the metadata array in the holder.
elementsThe elements to add to the array.
positionThe position at which to add elements in the array. Only works with push. Optional.
Response 200
notationNo description in the spec
ipNetNo description in the spec
ipNet.ipNo description in the spec
ipNet.maskNo description in the spec
maskSizeNo description in the spec
type0 - IPv4, 1 - IPv6
0 1holderMetadataNo description in the spec
Request
curl -X PATCH 'https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/{notation}/metadata/array' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '[
{
"pathToArray": "string",
"elements": [
{}
],
"position": 1
}
]'import os, requests
url = "https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/{notation}/metadata/array"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = [
{
"pathToArray": "string",
"elements": [
{}
],
"position": 1
}
]
r = requests.patch(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/{notation}/metadata/array";
const res = await fetch(url, {
method: "PATCH",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify([
{
"pathToArray": "string",
"elements": [
{}
],
"position": 1
}
]),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`[
{
"pathToArray": "string",
"elements": [
{}
],
"position": 1
}
]`)
req, _ := http.NewRequest("PATCH", "https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/{notation}/metadata/array", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/{notation}/metadata/array");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([[
"pathToArray" => "string",
"elements" => [[
]],
"position" => 1
]]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Successful addition of metadata array elements.
[
{
"notation": "string",
"ipNet": {
"ip": "string",
"mask": "string"
},
"maskSize": 1,
"type": 0,
"holderMetadata": {}
}
]400
Bad request.
{
"status": "string",
"code": 1,
"error": "string"
}403
Forbidden
{
"status": "string",
"code": 1,
"error": "string"
}404
Not Found.
{
"status": "string",
"code": 1,
"error": "string"
}500
Internal Server Error.
{
"status": "string",
"code": 1,
"error": "string"
}Remove metadata array elements from existing prefix holders metadata of a specified notation
DELETE
/{tenantUUID}/prefixes/{notation}/metadata/arrayThis endpoint allows for the deletion of array elements from the metadata arrays of existing prefix holders notation. This endpoint can be combined with `DELETE - /{tenantUUID}/prefixes/metadata` by removing specific array components with that endpoint first and since it sets values to `NULL` when performing delete operations on array positions, one can execute this API call by providing single value of `NULL` to `elements` and it will easily remove all those elements, freeing up array space and resetting positions.
Path parameters
tenantUUIDTenant UUID
notationPrefix notation
Request body
pathToArrayThe path to the metadata array in the holder.
elementsThe elements to add to the array.
positionThe position at which to add elements in the array. Only works with push. Optional.
Response 200
notationNo description in the spec
ipNetNo description in the spec
ipNet.ipNo description in the spec
ipNet.maskNo description in the spec
maskSizeNo description in the spec
type0 - IPv4, 1 - IPv6
0 1holderMetadataNo description in the spec
Request
curl -X DELETE 'https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/{notation}/metadata/array' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '[
{
"pathToArray": "string",
"elements": [
{}
],
"position": 1
}
]'import os, requests
url = "https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/{notation}/metadata/array"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = [
{
"pathToArray": "string",
"elements": [
{}
],
"position": 1
}
]
r = requests.delete(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/{notation}/metadata/array";
const res = await fetch(url, {
method: "DELETE",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify([
{
"pathToArray": "string",
"elements": [
{}
],
"position": 1
}
]),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`[
{
"pathToArray": "string",
"elements": [
{}
],
"position": 1
}
]`)
req, _ := http.NewRequest("DELETE", "https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/{notation}/metadata/array", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/nethub-data/{tenantUUID}/prefixes/{notation}/metadata/array");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([[
"pathToArray" => "string",
"elements" => [[
]],
"position" => 1
]]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Successful removal of metadata array elements.
[
{
"notation": "string",
"ipNet": {
"ip": "string",
"mask": "string"
},
"maskSize": 1,
"type": 0,
"holderMetadata": {}
}
]400
Bad request.
{
"status": "string",
"code": 1,
"error": "string"
}403
Forbidden
{
"status": "string",
"code": 1,
"error": "string"
}404
Not Found.
{
"status": "string",
"code": 1,
"error": "string"
}500
Internal Server Error.
{
"status": "string",
"code": 1,
"error": "string"
}Payment methods
6 operations
The object synthesised
The spec declares no named object for this resource, so the renderer synthesised one from its richest response body (GET /public/{user_id}/payment-methods). Fields no endpoint returns cannot appear here.
Attributes
dataNo description in the spec
data.uuidNo description in the spec
data.typeNo description in the spec
data.is_defaultNo description in the spec
data.detailsNo description in the spec
data.statusNo description in the spec
metaNo description in the spec
meta.current_pageNo description in the spec
meta.totalNo description in the spec
meta.per_pageNo description in the spec
List Gateways
GET
/public/{user_id}/gatewaysList all Gateways.
Path parameters
user_idThe ID of the user.
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.gatewayNo description in the spec
data.configNo description in the spec
data.config.public_keyNo description in the spec
metaNo description in the spec
meta.current_pageNo description in the spec
meta.totalNo description in the spec
meta.per_pageNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/ecommerce/public/{user_id}/gateways' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/gateways"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/gateways";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/ecommerce/public/{user_id}/gateways", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/gateways");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": [
{
"uuid": "00000000-0000-0000-0000-000000000000",
"gateway": "string",
"config": {
"public_key": "string"
}
}
],
"meta": {
"current_page": 1,
"total": 1,
"per_page": 1
}
}Setup Gateway
POST
/public/{user_id}/gateways/{gatewayConfig_uuid}/setupSetup Gateway
Path parameters
user_idThe ID of the user.
gatewayConfig_uuidNo description in the spec
Request
curl -X POST 'https://apigw.ipxo.com/ecommerce/public/{user_id}/gateways/{gatewayConfig_uuid}/setup' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/gateways/{gatewayConfig_uuid}/setup"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.post(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/gateways/{gatewayConfig_uuid}/setup";
const res = await fetch(url, {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("POST", "https://apigw.ipxo.com/ecommerce/public/{user_id}/gateways/{gatewayConfig_uuid}/setup", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/gateways/{gatewayConfig_uuid}/setup");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{}Add Payment Method
POST
/public/{user_id}/gateways/{gatewayConfig_uuid}/{paymentMethodType}Add Payment Method
Path parameters
user_idThe ID of the user.
gatewayConfig_uuidNo description in the spec
paymentMethodTypeNo description in the spec
Request
curl -X POST 'https://apigw.ipxo.com/ecommerce/public/{user_id}/gateways/{gatewayConfig_uuid}/{paymentMethodType}' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/gateways/{gatewayConfig_uuid}/{paymentMethodType}"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.post(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/gateways/{gatewayConfig_uuid}/{paymentMethodType}";
const res = await fetch(url, {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("POST", "https://apigw.ipxo.com/ecommerce/public/{user_id}/gateways/{gatewayConfig_uuid}/{paymentMethodType}", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/gateways/{gatewayConfig_uuid}/{paymentMethodType}");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
204
Card added successfully
{}List Payment Methods
GET
/public/{user_id}/payment-methodsList the Payment Methods.
Path parameters
user_idThe ID of the user.
Query parameters
filter[type]No description in the spec
filter[status]No description in the spec
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.typeNo description in the spec
data.is_defaultNo description in the spec
data.detailsNo description in the spec
data.details.card_brandNo description in the spec
data.details.card_last_fourNo description in the spec
data.details.card_expiry_monthNo description in the spec
data.details.card_expiry_yearNo description in the spec
data.statusNo description in the spec
metaNo description in the spec
meta.current_pageNo description in the spec
meta.totalNo description in the spec
meta.per_pageNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/ecommerce/public/{user_id}/payment-methods' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/payment-methods"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/payment-methods";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/ecommerce/public/{user_id}/payment-methods", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/payment-methods");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": [
{
"uuid": "00000000-0000-0000-0000-000000000000",
"type": "string",
"is_default": true,
"details": {
"card_brand": "string",
"card_last_four": "string",
"card_expiry_month": "string",
"card_expiry_year": "string"
},
"status": "string"
}
],
"meta": {
"current_page": 1,
"total": 1,
"per_page": 1
}
}Updates Payment Method
PATCH
/public/{user_id}/payment-methods/{paymentMethod_uuid}Updates Payment Method information.
Path parameters
user_idThe ID of the user.
paymentMethod_uuidNo description in the spec
Request body
make_defaultNo description in the spec
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.typeNo description in the spec
data.is_defaultNo description in the spec
data.detailsNo description in the spec
data.details.card_brandNo description in the spec
data.details.card_last_fourNo description in the spec
data.details.card_expiry_monthNo description in the spec
data.details.card_expiry_yearNo description in the spec
data.statusNo description in the spec
Request
curl -X PATCH 'https://apigw.ipxo.com/ecommerce/public/{user_id}/payment-methods/{paymentMethod_uuid}' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"make_default": true
}'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/payment-methods/{paymentMethod_uuid}"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = {
"make_default": true
}
r = requests.patch(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/payment-methods/{paymentMethod_uuid}";
const res = await fetch(url, {
method: "PATCH",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify({
"make_default": true
}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"make_default": true
}`)
req, _ := http.NewRequest("PATCH", "https://apigw.ipxo.com/ecommerce/public/{user_id}/payment-methods/{paymentMethod_uuid}", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/payment-methods/{paymentMethod_uuid}");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"make_default" => true
]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": {
"uuid": "00000000-0000-0000-0000-000000000000",
"type": "string",
"is_default": true,
"details": {
"card_brand": "string",
"card_last_four": "string",
"card_expiry_month": 1,
"card_expiry_year": 1
},
"status": "string"
}
}Delete Payment Method
DELETE
/public/{user_id}/payment-methods/{paymentMethod_uuid}Delete a Payment Method
Path parameters
user_idThe ID of the user.
paymentMethod_uuidNo description in the spec
Request
curl -X DELETE 'https://apigw.ipxo.com/ecommerce/public/{user_id}/payment-methods/{paymentMethod_uuid}' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/payment-methods/{paymentMethod_uuid}"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.delete(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/payment-methods/{paymentMethod_uuid}";
const res = await fetch(url, {
method: "DELETE",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("DELETE", "https://apigw.ipxo.com/ecommerce/public/{user_id}/payment-methods/{paymentMethod_uuid}", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/payment-methods/{paymentMethod_uuid}");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
204
Successful Deleted Payment Method
{}Addresses
5 operations
The object synthesised
The spec declares no named object for this resource, so the renderer synthesised one from its richest response body (GET /public/{user_id}/addresses). Fields no endpoint returns cannot appear here.
Attributes
dataNo description in the spec
data.uuidNo description in the spec
data.first_nameNo description in the spec
data.last_nameNo description in the spec
data.company_nameNo description in the spec
data.vat_numberNo description in the spec
data.vat_validation_statusNo description in the spec
data.vat_validated_atNo description in the spec
data.line_oneNo description in the spec
data.line_twoNo description in the spec
data.line_threeNo description in the spec
data.cityNo description in the spec
data.province_codeNo description in the spec
data.country_codeNo description in the spec
data.postcodeNo description in the spec
data.contact_emailNo description in the spec
data.contact_phoneNo description in the spec
data.company_codeNo description in the spec
metaNo description in the spec
meta.current_pageNo description in the spec
meta.totalNo description in the spec
meta.per_pageNo description in the spec
List Countries
GET
/public/common/countriesList all Countries.
Response 200
dataNo description in the spec
data.nameNo description in the spec
data.codeNo description in the spec
metaNo description in the spec
meta.current_pageNo description in the spec
meta.totalNo description in the spec
meta.per_pageNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/ecommerce/public/common/countries' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/common/countries"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/common/countries";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/ecommerce/public/common/countries", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/common/countries");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": [
{
"name": "string",
"code": "string"
}
],
"meta": {
"current_page": 1,
"total": 1,
"per_page": 1
}
}List Provinces
GET
/public/common/countries/{country_code}/provincesList all Provinces for a Country.
Path parameters
country_codeNo description in the spec
Response 200
dataNo description in the spec
data.country_codeNo description in the spec
data.nameNo description in the spec
data.codeNo description in the spec
metaNo description in the spec
meta.current_pageNo description in the spec
meta.totalNo description in the spec
meta.per_pageNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/ecommerce/public/common/countries/{country_code}/provinces' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/common/countries/{country_code}/provinces"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/common/countries/{country_code}/provinces";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/ecommerce/public/common/countries/{country_code}/provinces", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/common/countries/{country_code}/provinces");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": [
{
"country_code": "string",
"name": "string",
"code": "string"
}
],
"meta": {
"current_page": 1,
"total": 1,
"per_page": 1
}
}List Customer Billing Addresses
GET
/public/{user_id}/addressesList the customer billing addresses.
Path parameters
user_idThe ID of the user.
Query parameters
filter[addressable_type]No description in the spec
filter[addressable_id]No description in the spec
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.first_nameNo description in the spec
data.last_nameNo description in the spec
data.company_nameNo description in the spec
data.vat_numberNo description in the spec
data.vat_validation_statusNo description in the spec
data.vat_validated_atNo description in the spec
data.line_oneNo description in the spec
data.line_twoNo description in the spec
data.line_threeNo description in the spec
data.cityNo description in the spec
data.province_codeNo description in the spec
data.country_codeNo description in the spec
data.postcodeNo description in the spec
data.contact_emailNo description in the spec
data.contact_phoneNo description in the spec
data.company_codeNo description in the spec
metaNo description in the spec
meta.current_pageNo description in the spec
meta.totalNo description in the spec
meta.per_pageNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/ecommerce/public/{user_id}/addresses' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/addresses"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/addresses";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/ecommerce/public/{user_id}/addresses", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/addresses");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": [
{
"uuid": "00000000-0000-0000-0000-000000000000",
"first_name": "string",
"last_name": "string",
"company_name": "string",
"vat_number": "string",
"vat_validation_status": "string",
"vat_validated_at": "string",
"line_one": "string"
}
],
"meta": {
"current_page": 1,
"total": 1,
"per_page": 1
}
}Create Address
POST
/public/{user_id}/addressesCreate a single Address.
Path parameters
user_idThe ID of the user.
Request body
country_codeThe <code>code</code> of an existing record in the countries table.
vat_numberNo description in the spec
first_nameMust not be greater than 20 characters.
last_nameMust not be greater than 30 characters.
company_nameMust match the regex /^[A-Za-z0-9.()[\],'"_\/@&!*+\-, ]+$/. Must not be greater than 150 characters.
company_codeMust be at least 3 characters. Must not be greater than 20 characters.
line_oneMust be at least 2 characters. Must not be greater than 100 characters.
line_twoMust not be greater than 100 characters.
line_threeMust not be greater than 100 characters.
cityMust not be greater than 90 characters.
province_codeThe <code>code</code> of an existing record in the provinces table. Must not be greater than 20 characters.
postcodeMust not be greater than 20 characters.
contact_emailMust be a valid email address. Must not be greater than 255 characters.
contact_phoneMust not be greater than 20 characters.
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.first_nameNo description in the spec
data.last_nameNo description in the spec
data.company_nameNo description in the spec
data.vat_numberNo description in the spec
data.vat_validation_statusNo description in the spec
data.vat_validated_atNo description in the spec
data.line_oneNo description in the spec
data.line_twoNo description in the spec
data.line_threeNo description in the spec
data.cityNo description in the spec
data.province_codeNo description in the spec
data.country_codeNo description in the spec
data.postcodeNo description in the spec
data.contact_emailNo description in the spec
data.contact_phoneNo description in the spec
data.company_codeNo description in the spec
Request
curl -X POST 'https://apigw.ipxo.com/ecommerce/public/{user_id}/addresses' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"country_code": "string",
"vat_number": "string",
"first_name": "string",
"last_name": "string",
"company_name": "string",
"company_code": "string",
"line_one": "string",
"line_two": "string"
}'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/addresses"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = {
"country_code": "string",
"vat_number": "string",
"first_name": "string",
"last_name": "string",
"company_name": "string",
"company_code": "string",
"line_one": "string",
"line_two": "string"
}
r = requests.post(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/addresses";
const res = await fetch(url, {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify({
"country_code": "string",
"vat_number": "string",
"first_name": "string",
"last_name": "string",
"company_name": "string",
"company_code": "string",
"line_one": "string",
"line_two": "string"
}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"country_code": "string",
"vat_number": "string",
"first_name": "string",
"last_name": "string",
"company_name": "string",
"company_code": "string",
"line_one": "string",
"line_two": "string"
}`)
req, _ := http.NewRequest("POST", "https://apigw.ipxo.com/ecommerce/public/{user_id}/addresses", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/addresses");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"country_code" => "string",
"vat_number" => "string",
"first_name" => "string",
"last_name" => "string",
"company_name" => "string",
"company_code" => "string",
"line_one" => "string",
"line_two" => "string"
]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": {
"uuid": "00000000-0000-0000-0000-000000000000",
"first_name": "string",
"last_name": "string",
"company_name": "string",
"vat_number": "string",
"vat_validation_status": "string",
"vat_validated_at": "string",
"line_one": "string"
}
}Update Address
PUT
/public/{user_id}/addresses/{customerAddress_id}Update customer address.
Path parameters
user_idThe ID of the user.
customerAddress_idThe ID of the customerAddress.
Request body
line_oneMust not be greater than 255 characters.
line_twoMust not be greater than 255 characters.
cityMust not be greater than 255 characters.
postcodeMust not be greater than 20 characters.
province_codeMust not be greater than 10 characters.
contact_emailMust be a valid email address. Must not be greater than 255 characters.
vat_numberMust not be greater than 50 characters.
company_codeMust not be greater than 50 characters.
first_nameMust not be greater than 255 characters.
last_nameMust not be greater than 255 characters.
company_nameMust not be greater than 255 characters.
contact_phoneMust not be greater than 50 characters.
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.first_nameNo description in the spec
data.last_nameNo description in the spec
data.company_nameNo description in the spec
data.vat_numberNo description in the spec
data.vat_validation_statusNo description in the spec
data.vat_validated_atNo description in the spec
data.line_oneNo description in the spec
data.line_twoNo description in the spec
data.line_threeNo description in the spec
data.cityNo description in the spec
data.province_codeNo description in the spec
data.country_codeNo description in the spec
data.postcodeNo description in the spec
data.contact_emailNo description in the spec
data.contact_phoneNo description in the spec
data.company_codeNo description in the spec
Request
curl -X PUT 'https://apigw.ipxo.com/ecommerce/public/{user_id}/addresses/{customerAddress_id}' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"line_one": "string",
"line_two": "string",
"city": "string",
"postcode": "string",
"province_code": "string",
"contact_email": "[email protected]",
"vat_number": "string",
"company_code": "string"
}'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/addresses/{customerAddress_id}"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = {
"line_one": "string",
"line_two": "string",
"city": "string",
"postcode": "string",
"province_code": "string",
"contact_email": "[email protected]",
"vat_number": "string",
"company_code": "string"
}
r = requests.put(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/addresses/{customerAddress_id}";
const res = await fetch(url, {
method: "PUT",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify({
"line_one": "string",
"line_two": "string",
"city": "string",
"postcode": "string",
"province_code": "string",
"contact_email": "[email protected]",
"vat_number": "string",
"company_code": "string"
}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"line_one": "string",
"line_two": "string",
"city": "string",
"postcode": "string",
"province_code": "string",
"contact_email": "[email protected]",
"vat_number": "string",
"company_code": "string"
}`)
req, _ := http.NewRequest("PUT", "https://apigw.ipxo.com/ecommerce/public/{user_id}/addresses/{customerAddress_id}", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/addresses/{customerAddress_id}");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"line_one" => "string",
"line_two" => "string",
"city" => "string",
"postcode" => "string",
"province_code" => "string",
"contact_email" => "[email protected]",
"vat_number" => "string",
"company_code" => "string"
]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": {
"uuid": "00000000-0000-0000-0000-000000000000",
"first_name": "string",
"last_name": "string",
"company_name": "string",
"vat_number": "string",
"vat_validation_status": "string",
"vat_validated_at": "string",
"line_one": "string"
}
}Products
3 operations
The object synthesised
The spec declares no named object for this resource, so the renderer synthesised one from its richest response body (GET /public/{user_id}/products). Fields no endpoint returns cannot appear here.
Attributes
dataNo description in the spec
data.uuidNo description in the spec
data.nameNo description in the spec
data.codeNo description in the spec
data.short_descriptionNo description in the spec
data.priceNo description in the spec
metaNo description in the spec
meta.current_pageNo description in the spec
meta.totalNo description in the spec
meta.per_pageNo description in the spec
List Product Variants
GET
/public/{user_id}/productsReturn the List of all Product Variants that are purchasable.
Path parameters
user_idThe ID of the user.
Query parameters
filter[code]No description in the spec
filter[uuid]No description in the spec
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.nameNo description in the spec
data.codeNo description in the spec
data.short_descriptionNo description in the spec
data.priceNo description in the spec
data.price.uuidNo description in the spec
data.price.priceNo description in the spec
data.price.price.typeNo description in the spec
data.price.price.x-truncatedNo description in the spec
data.price.typeNo description in the spec
data.price.recurrenceNo description in the spec
data.price.recurrence.typeNo description in the spec
data.price.recurrence.x-truncatedNo description in the spec
data.price.codeNo description in the spec
data.price.is_defaultNo description in the spec
data.price.created_atNo description in the spec
data.price.requires_external_terminationNo description in the spec
metaNo description in the spec
meta.current_pageNo description in the spec
meta.totalNo description in the spec
meta.per_pageNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/ecommerce/public/{user_id}/products' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/products"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/products";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/ecommerce/public/{user_id}/products", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/products");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": [
{
"uuid": "00000000-0000-0000-0000-000000000000",
"name": "string",
"code": "string",
"short_description": "string",
"price": {
"uuid": "00000000-0000-0000-0000-000000000000",
"price": {
"type": "\u2026",
"x-truncated": "\u2026"
},
"type": "string",
"recurrence": {
"type": "\u2026",
"x-truncated": "\u2026"
},
"code": "string",
"is_default": "string",
"created_at": "string",
"requires_external_termination": "string"
}
}
],
"meta": {
"current_page": 1,
"total": 1,
"per_page": 1
}
}List Bundle Variants
GET
/public/{user_id}/products/bundlesReturn the List of all Bundle Variants that are purchasable.
Path parameters
user_idThe ID of the user.
Query parameters
includeA comma-separated list of relationships to include. Multiple parameters are allowed.
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.nameNo description in the spec
data.short_descriptionNo description in the spec
data.typeNo description in the spec
data.priceNo description in the spec
data.price.currencyNo description in the spec
data.price.amountNo description in the spec
data.price.amount_minorNo description in the spec
metaNo description in the spec
meta.current_pageNo description in the spec
meta.totalNo description in the spec
meta.per_pageNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/ecommerce/public/{user_id}/products/bundles' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/products/bundles"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/products/bundles";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/ecommerce/public/{user_id}/products/bundles", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/products/bundles");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": [
{
"uuid": "00000000-0000-0000-0000-000000000000",
"name": "string",
"short_description": "string",
"type": "string",
"price": {
"currency": "string",
"amount": "string",
"amount_minor": "string"
}
}
],
"meta": {
"current_page": 1,
"total": 1,
"per_page": 1
}
}List Product Categories
GET
/public/{user_id}/products/categoriesReturns a list of Product Categories.
Path parameters
user_idThe ID of the user.
Query parameters
filter[slugs]Filter by product category slugs (comma-separated)
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.slugNo description in the spec
data.enabledNo description in the spec
data.is_cart_enabledNo description in the spec
data.is_stock_enabledNo description in the spec
metaNo description in the spec
meta.current_pageNo description in the spec
meta.totalNo description in the spec
meta.per_pageNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/ecommerce/public/{user_id}/products/categories' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/products/categories"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/products/categories";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/ecommerce/public/{user_id}/products/categories", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/products/categories");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": [
{
"uuid": "00000000-0000-0000-0000-000000000000",
"slug": "string",
"enabled": true,
"is_cart_enabled": true,
"is_stock_enabled": true
}
],
"meta": {
"current_page": 1,
"total": 1,
"per_page": 1
}
}Account
14 operations
The object
API.Pub.Resources.Tenants.TenantShowResourceDeclared in the spec. Shown from GET /v1/{tenantUUID}.
Attributes
uuidNo description in the spec
titleNo description in the spec
emailNo description in the spec
business_sinceNo description in the spec
company_sizeNo description in the spec
address1No description in the spec
address2No description in the spec
cityNo description in the spec
postcodeNo description in the spec
countryNo description in the spec
stateNo description in the spec
statusNo description in the spec
abuse_emailNo description in the spec
created_atNo description in the spec
optionsNo description in the spec
options.keyNo description in the spec
options.valueNo description in the spec
metaNo description in the spec
meta.keyNo description in the spec
meta.valueNo description in the spec
industryNo description in the spec
industry.uuidNo description in the spec
industry.nameNo description in the spec
creditNo description in the spec
credit.uuidNo description in the spec
credit.amountNo description in the spec
credit.auto_paymentNo description in the spec
summaryNo description in the spec
logoNo description in the spec
logo.imageNo description in the spec
payment_gatewaysNo description in the spec
flagsNo description in the spec
flags.uuidNo description in the spec
flags.slugNo description in the spec
status_reasonNo description in the spec
status_reason.uuidNo description in the spec
status_reason.slugNo description in the spec
status_reason.titleNo description in the spec
vat_numberNo description in the spec
email_verifiedNo description in the spec
abuse_email_verifiedNo description in the spec
Show Customer
GET
/public/{user_id}Show the current Customer
Path parameters
user_idThe ID of the user.
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.auth_idNo description in the spec
data.nameNo description in the spec
data.business_entity_idNo description in the spec
data.currencyNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/ecommerce/public/{user_id}' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/ecommerce/public/{user_id}", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": {
"uuid": "00000000-0000-0000-0000-000000000000",
"auth_id": "string",
"name": "string",
"business_entity_id": "string",
"currency": "string"
}
}Show Business Entity
GET
/public/{user_id}/business-entityShow the Business Entity assigned to the current Customer
Path parameters
user_idThe ID of the user.
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.country_codeNo description in the spec
data.company_nameNo description in the spec
data.line_oneNo description in the spec
data.line_twoNo description in the spec
data.line_threeNo description in the spec
data.cityNo description in the spec
data.province_codeNo description in the spec
data.postcodeNo description in the spec
data.contact_emailNo description in the spec
data.bank_transfer_detailsNo description in the spec
data.bank_transfer_details.accountsNo description in the spec
data.bank_transfer_details.accounts.typeNo description in the spec
data.bank_transfer_details.accounts.x-truncatedNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/ecommerce/public/{user_id}/business-entity' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/business-entity"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/business-entity";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/ecommerce/public/{user_id}/business-entity", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/business-entity");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": {
"uuid": "00000000-0000-0000-0000-000000000000",
"country_code": "string",
"company_name": "string",
"line_one": "string",
"line_two": "string",
"line_three": "string",
"city": "string",
"province_code": "string"
}
}List Customer Flags
GET
/public/{user_id}/flagsReturns flags attached to a customer.
Path parameters
user_idThe ID of the user.
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.nameNo description in the spec
data.slugNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/ecommerce/public/{user_id}/flags' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/flags"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/{user_id}/flags";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/ecommerce/public/{user_id}/flags", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/{user_id}/flags");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": {
"uuid": "00000000-0000-0000-0000-000000000000",
"name": "string",
"slug": "string"
}
}Get list of tenants
GET
/v1Returns list of tenants
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.emailNo description in the spec
data.business_sinceNo description in the spec
data.company_sizeNo description in the spec
data.titleNo description in the spec
data.statusNo description in the spec
data.codeNo description in the spec
data.optionsNo description in the spec
data.metaNo description in the spec
data.creditNo description in the spec
data.credit.typeNo description in the spec
data.credit.x-truncatedNo description in the spec
data.summaryNo description in the spec
data.logoNo description in the spec
data.payment_gatewaysNo description in the spec
data.flagsNo description in the spec
data.status_reasonNo description in the spec
data.vat_numberNo description in the spec
data.email_verifiedNo description in the spec
data.abuse_email_verifiedNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Tenants Collection
{
"data": [
{
"uuid": "00000000-0000-0000-0000-000000000000",
"email": "[email protected]",
"business_since": "string",
"company_size": "string",
"title": "string",
"status": "string",
"code": "string",
"options": "string"
}
]
}401
Unauthorized
403
Forbidden
Create Tenant
POST
/v1Create Tenant
Request body
titleNo description in the spec
emailNo description in the spec
business_sinceNo description in the spec
company_sizeNo description in the spec
address1No description in the spec
address2No description in the spec
cityNo description in the spec
countryNo description in the spec
postcodeNo description in the spec
stateNo description in the spec
abuse_emailNo description in the spec
vat_numberNo description in the spec
industry_uuidNo description in the spec
reuse_addressNo description in the spec
optionsNo description in the spec
options.websiteNo description in the spec
options.social_networkNo description in the spec
options.has_social_networkNo description in the spec
options.found_usNo description in the spec
options.primary_intentionNo description in the spec
options.proprataNo description in the spec
options.prorata_dayTenant Option Prorata Day
Response 200
uuidNo description in the spec
emailNo description in the spec
business_sinceNo description in the spec
company_sizeNo description in the spec
titleNo description in the spec
statusNo description in the spec
codeNo description in the spec
optionsNo description in the spec
options.keyNo description in the spec
options.valueNo description in the spec
metaNo description in the spec
meta.keyNo description in the spec
meta.valueNo description in the spec
creditNo description in the spec
credit.amountNo description in the spec
credit.auto_paymentNo description in the spec
summaryNo description in the spec
logoNo description in the spec
logo.imageNo description in the spec
payment_gatewaysNo description in the spec
flagsNo description in the spec
flags.uuidNo description in the spec
flags.slugNo description in the spec
status_reasonNo description in the spec
status_reason.uuidNo description in the spec
status_reason.slugNo description in the spec
status_reason.titleNo description in the spec
vat_numberNo description in the spec
email_verifiedNo description in the spec
abuse_email_verifiedNo description in the spec
Request
curl -X POST 'https://apigw.ipxo.com/billing/v1' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"title": "string",
"email": "[email protected]",
"business_since": "string",
"company_size": "string",
"address1": "string",
"address2": "string",
"city": "string",
"country": "string"
}'import os, requests
url = "https://apigw.ipxo.com/billing/v1"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = {
"title": "string",
"email": "[email protected]",
"business_since": "string",
"company_size": "string",
"address1": "string",
"address2": "string",
"city": "string",
"country": "string"
}
r = requests.post(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1";
const res = await fetch(url, {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify({
"title": "string",
"email": "[email protected]",
"business_since": "string",
"company_size": "string",
"address1": "string",
"address2": "string",
"city": "string",
"country": "string"
}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"title": "string",
"email": "[email protected]",
"business_since": "string",
"company_size": "string",
"address1": "string",
"address2": "string",
"city": "string",
"country": "string"
}`)
req, _ := http.NewRequest("POST", "https://apigw.ipxo.com/billing/v1", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"title" => "string",
"email" => "[email protected]",
"business_since" => "string",
"company_size" => "string",
"address1" => "string",
"address2" => "string",
"city" => "string",
"country" => "string"
]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Successful operation
{
"uuid": "00000000-0000-0000-0000-000000000000",
"email": "[email protected]",
"business_since": "string",
"company_size": "string",
"title": "string",
"status": "string",
"code": "string",
"options": [
{
"key": "string",
"value": "string"
}
]
}401
Unauthorized
403
Forbidden
422
Unprocessable Entity
Get list of tenants with Summary
GET
/v1/common/summaryReturns list of tenants with Summary
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.address1No description in the spec
data.address2No description in the spec
data.emailNo description in the spec
data.cityNo description in the spec
data.postcodeNo description in the spec
data.abuse_emailNo description in the spec
data.countryNo description in the spec
data.stateNo description in the spec
data.titleNo description in the spec
data.created_atNo description in the spec
data.statusNo description in the spec
data.users_countNo description in the spec
data.industryNo description in the spec
data.vat_numberNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/common/summary' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/common/summary"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/common/summary";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/common/summary", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/common/summary");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Tenants With Summary Collection
{
"data": [
{
"uuid": "00000000-0000-0000-0000-000000000000",
"address1": "string",
"address2": "string",
"email": "[email protected]",
"city": "string",
"postcode": "string",
"abuse_email": "[email protected]",
"country": "string"
}
]
}401
Unauthorized
403
Forbidden
Get Single Tenant information
GET
/v1/{tenantUUID}Get Single Tenant information
Path parameters
tenantUUIDTenant UUID
Response 200
uuidNo description in the spec
titleNo description in the spec
emailNo description in the spec
business_sinceNo description in the spec
company_sizeNo description in the spec
address1No description in the spec
address2No description in the spec
cityNo description in the spec
postcodeNo description in the spec
countryNo description in the spec
stateNo description in the spec
statusNo description in the spec
abuse_emailNo description in the spec
created_atNo description in the spec
optionsNo description in the spec
options.keyNo description in the spec
options.valueNo description in the spec
metaNo description in the spec
meta.keyNo description in the spec
meta.valueNo description in the spec
industryNo description in the spec
industry.uuidNo description in the spec
industry.nameNo description in the spec
creditNo description in the spec
credit.uuidNo description in the spec
credit.amountNo description in the spec
credit.auto_paymentNo description in the spec
summaryNo description in the spec
logoNo description in the spec
logo.imageNo description in the spec
payment_gatewaysNo description in the spec
flagsNo description in the spec
flags.uuidNo description in the spec
flags.slugNo description in the spec
status_reasonNo description in the spec
status_reason.uuidNo description in the spec
status_reason.slugNo description in the spec
status_reason.titleNo description in the spec
vat_numberNo description in the spec
email_verifiedNo description in the spec
abuse_email_verifiedNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Tenant
{
"uuid": "00000000-0000-0000-0000-000000000000",
"title": "string",
"email": "[email protected]",
"business_since": "string",
"company_size": "string",
"address1": "string",
"address2": "string",
"city": "string"
}401
Unauthorized
403
Forbidden
404
Not Found
Update Tenant Information
PATCH
/v1/{tenantUUID}Update Tenant Information
Path parameters
tenantUUIDTenant UUID
Request body
titleNo description in the spec
emailNo description in the spec
business_sinceNo description in the spec
company_sizeNo description in the spec
address1No description in the spec
address2No description in the spec
cityNo description in the spec
postcodeNo description in the spec
stateNo description in the spec
abuse_emailNo description in the spec
vat_numberNo description in the spec
industry_uuidNo description in the spec
optionsNo description in the spec
options.websiteNo description in the spec
options.has_websiteNo description in the spec
options.social_networkNo description in the spec
options.has_social_networkNo description in the spec
options.found_usNo description in the spec
options.proprataNo description in the spec
options.prorata_dayTenant Option Prorata Day
Response 200
uuidNo description in the spec
emailNo description in the spec
business_sinceNo description in the spec
company_sizeNo description in the spec
titleNo description in the spec
statusNo description in the spec
codeNo description in the spec
optionsNo description in the spec
options.keyNo description in the spec
options.valueNo description in the spec
metaNo description in the spec
meta.keyNo description in the spec
meta.valueNo description in the spec
creditNo description in the spec
credit.amountNo description in the spec
credit.auto_paymentNo description in the spec
summaryNo description in the spec
logoNo description in the spec
logo.imageNo description in the spec
payment_gatewaysNo description in the spec
flagsNo description in the spec
flags.uuidNo description in the spec
flags.slugNo description in the spec
status_reasonNo description in the spec
status_reason.uuidNo description in the spec
status_reason.slugNo description in the spec
status_reason.titleNo description in the spec
vat_numberNo description in the spec
email_verifiedNo description in the spec
abuse_email_verifiedNo description in the spec
Request
curl -X PATCH 'https://apigw.ipxo.com/billing/v1/{tenantUUID}' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"title": "string",
"email": "[email protected]",
"business_since": "string",
"company_size": "string",
"address1": "string",
"address2": "string",
"city": "string",
"postcode": "string"
}'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = {
"title": "string",
"email": "[email protected]",
"business_since": "string",
"company_size": "string",
"address1": "string",
"address2": "string",
"city": "string",
"postcode": "string"
}
r = requests.patch(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}";
const res = await fetch(url, {
method: "PATCH",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify({
"title": "string",
"email": "[email protected]",
"business_since": "string",
"company_size": "string",
"address1": "string",
"address2": "string",
"city": "string",
"postcode": "string"
}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"title": "string",
"email": "[email protected]",
"business_since": "string",
"company_size": "string",
"address1": "string",
"address2": "string",
"city": "string",
"postcode": "string"
}`)
req, _ := http.NewRequest("PATCH", "https://apigw.ipxo.com/billing/v1/{tenantUUID}", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"title" => "string",
"email" => "[email protected]",
"business_since" => "string",
"company_size" => "string",
"address1" => "string",
"address2" => "string",
"city" => "string",
"postcode" => "string"
]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Tenant
{
"uuid": "00000000-0000-0000-0000-000000000000",
"email": "[email protected]",
"business_since": "string",
"company_size": "string",
"title": "string",
"status": "string",
"code": "string",
"options": [
{
"key": "string",
"value": "string"
}
]
}401
Unauthorized
403
Forbidden
404
Not Found
422
Unprocessable Entity
Get Tenants Details
GET
/v1/{tenantUUID}/detailsReturns tenants Details
Path parameters
tenantUUIDTenant UUID
Response 200
monetizing_ips_countNo description in the spec
renting_ips_countNo description in the spec
codeNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/details' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/details"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/details";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/details", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/details");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Tenant Details
{
"monetizing_ips_count": 1.0,
"renting_ips_count": 1.0,
"code": "string"
}401
Unauthorized
403
Forbidden
Initiate email verification
POST
/v1/{tenantUUID}/email_verification/initiateInitiate email verification
Path parameters
tenantUUIDTenant UUID
Request body
email_typeNo description in the spec
email abuse_emailRequest
curl -X POST 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/email_verification/initiate' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"email_type": "email"
}'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/email_verification/initiate"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = {
"email_type": "email"
}
r = requests.post(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/email_verification/initiate";
const res = await fetch(url, {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify({
"email_type": "email"
}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"email_type": "email"
}`)
req, _ := http.NewRequest("POST", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/email_verification/initiate", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/email_verification/initiate");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"email_type" => "email"
]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Verification initiated
400
Bad Request
401
Unauthorized
403
Forbidden
409
Email is already verified
Verify email
POST
/v1/{tenantUUID}/email_verification/verifyVerify email
Path parameters
tenantUUIDTenant UUID
Request body
email_typeNo description in the spec
email abuse_emailcodeNo description in the spec
Request
curl -X POST 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/email_verification/verify' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"email_type": "email",
"code": "string"
}'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/email_verification/verify"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = {
"email_type": "email",
"code": "string"
}
r = requests.post(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/email_verification/verify";
const res = await fetch(url, {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify({
"email_type": "email",
"code": "string"
}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"email_type": "email",
"code": "string"
}`)
req, _ := http.NewRequest("POST", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/email_verification/verify", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/email_verification/verify");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"email_type" => "email",
"code" => "string"
]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Email verified successfully
400
Invalid Request
401
Unauthorized
403
Forbidden
409
Email is already verified
Get list of AWS connected accounts
GET
/v1/{tenantUUID}/integrations/aws/connected-accountsReturns list of AWS connected accounts for the tenant
Path parameters
tenantUUIDTenant UUID
Response 200
dataNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/integrations/aws/connected-accounts' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/integrations/aws/connected-accounts"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/integrations/aws/connected-accounts";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/integrations/aws/connected-accounts", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/integrations/aws/connected-accounts");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
AWS Connected Accounts List
{
"data": [
"string"
]
}401
Unauthorized
403
Forbidden
404
Not Found
Upload Tenant Logo
POST
/v1/{tenantUUID}/logoUpload Tenant Logo
Path parameters
tenantUUIDTenant UUID
Request body
imageTenant Logo Image
Response 200
uuidNo description in the spec
emailNo description in the spec
business_sinceNo description in the spec
company_sizeNo description in the spec
titleNo description in the spec
statusNo description in the spec
codeNo description in the spec
optionsNo description in the spec
options.keyNo description in the spec
options.valueNo description in the spec
metaNo description in the spec
meta.keyNo description in the spec
meta.valueNo description in the spec
creditNo description in the spec
credit.amountNo description in the spec
credit.auto_paymentNo description in the spec
summaryNo description in the spec
logoNo description in the spec
logo.imageNo description in the spec
payment_gatewaysNo description in the spec
flagsNo description in the spec
flags.uuidNo description in the spec
flags.slugNo description in the spec
status_reasonNo description in the spec
status_reason.uuidNo description in the spec
status_reason.slugNo description in the spec
status_reason.titleNo description in the spec
vat_numberNo description in the spec
email_verifiedNo description in the spec
abuse_email_verifiedNo description in the spec
Request
curl -X POST 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/logo' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"image": "string"
}'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/logo"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = {
"image": "string"
}
r = requests.post(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/logo";
const res = await fetch(url, {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify({
"image": "string"
}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"image": "string"
}`)
req, _ := http.NewRequest("POST", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/logo", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/logo");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"image" => "string"
]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Successful operation
{
"uuid": "00000000-0000-0000-0000-000000000000",
"email": "[email protected]",
"business_since": "string",
"company_size": "string",
"title": "string",
"status": "string",
"code": "string",
"options": [
{
"key": "string",
"value": "string"
}
]
}401
Unauthorized
403
Forbidden
422
Unprocessable Entity
Remove Tenant Logo
DELETE
/v1/{tenantUUID}/logoRemove Tenant Logo
Path parameters
tenantUUIDTenant UUID
Request
curl -X DELETE 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/logo' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/logo"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.delete(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/logo";
const res = await fetch(url, {
method: "DELETE",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("DELETE", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/logo", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/logo");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
204
No Content
401
Unauthorized
403
Forbidden
422
Unprocessable Entity
Activity log
2 operations
The object synthesised
The spec declares no named object for this resource, so the renderer synthesised one from its richest response body (GET /v1/{tenantUUID}/market/services/event_logs). Fields no endpoint returns cannot appear here.
Attributes
dataNo description in the spec
data.labelNo description in the spec
data.typeNo description in the spec
data.dataNo description in the spec
data.created_atNo description in the spec
metaNo description in the spec
meta.current_pageNo description in the spec
meta.fromNo description in the spec
meta.last_pageNo description in the spec
meta.per_pageNo description in the spec
meta.toNo description in the spec
meta.totalNo description in the spec
List EventLog
GET
/v1/{tenantUUID}/market/services/event_logsList Tenant IP Market EventLog
Path parameters
tenantUUIDTenant UUID
Query parameters
typeFilter by Event Type
labelFilter by subnet label
startFilter by Start period date in unix timestamp format which is greater or equal to input
endFilter By End period date in unix timestamp format which is lower or equal to input
sortSort by key
pageList Page
per_pageItems Per Page
Response 200
dataNo description in the spec
data.labelNo description in the spec
data.typeNo description in the spec
data.dataNo description in the spec
data.data.typeNo description in the spec
data.data.x-truncatedNo description in the spec
data.created_atNo description in the spec
metaNo description in the spec
meta.current_pageNo description in the spec
meta.fromNo description in the spec
meta.last_pageNo description in the spec
meta.per_pageNo description in the spec
meta.toNo description in the spec
meta.totalNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/event_logs' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/event_logs"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/event_logs";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/event_logs", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/event_logs");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Successful operation
{
"data": [
{
"label": "string",
"type": "string",
"data": [
{
"type": "\u2026",
"x-truncated": "\u2026"
}
],
"created_at": 1
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 1,
"to": 1,
"total": 1
}
}400
Invalid Request
401
Unauthorized
403
Forbidden
422
Unprocessable Entity
List EventLog
GET
/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/event_logsList IP Market EventLog
Path parameters
tenantUUIDTenant UUID
ipmarketServiceUUIDIPMarket Service UUID
Query parameters
eventFilter by Event Type
startFilter by Start period date in unix timestamp format which is greater or equal to input
endFilter By End period date in unix timestamp format which is lower or equal to input
sortSort by key
labelFilter By Subnet label
pageList Page
per_pageItems Per Page
Response 200
dataNo description in the spec
data.labelNo description in the spec
data.typeNo description in the spec
data.dataNo description in the spec
data.data.typeNo description in the spec
data.data.x-truncatedNo description in the spec
data.created_atNo description in the spec
metaNo description in the spec
meta.current_pageNo description in the spec
meta.fromNo description in the spec
meta.last_pageNo description in the spec
meta.per_pageNo description in the spec
meta.toNo description in the spec
meta.totalNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/event_logs' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/event_logs"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/event_logs";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/event_logs", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/event_logs");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Successful operation
{
"data": [
{
"label": "string",
"type": "string",
"data": [
{
"type": "\u2026",
"x-truncated": "\u2026"
}
],
"created_at": 1
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 1,
"to": 1,
"total": 1
}
}400
Invalid Request
401
Unauthorized
403
Forbidden
422
Unprocessable Entity
Reference data
13 operations
The object
API.Pub.Resources.IPMarket.Services.LeasedServiceResourceDeclared in the spec. Shown from GET /v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/leased.
Attributes
uuidNo description in the spec
prefix_lengthNo description in the spec
addressNo description in the spec
pricingNo description in the spec
pricing.uuidNo description in the spec
pricing.subnet_sizeNo description in the spec
pricing.ip_countNo description in the spec
pricing.priceNo description in the spec
pricing.commissionNo description in the spec
pricing.wants_to_negotiateNo description in the spec
pricing.selected_commitment_periodsCommitment period in months
commitmentsNo description in the spec
commitments.uuidNo description in the spec
commitments.pricing_uuidNo description in the spec
commitments.statusNo description in the spec
commitments.priceNo description in the spec
commitments.periodNo description in the spec
commitments.start_dateNo description in the spec
commitments.end_dateNo description in the spec
Validate Vat Number
POST
/public/common/vat/validateValidates a VAT number.
Request body
vat_numberNo description in the spec
Response 200
dataNo description in the spec
data.statusNo description in the spec
data.validated_atNo description in the spec
data.company_nameNo description in the spec
data.country_codeNo description in the spec
Request
curl -X POST 'https://apigw.ipxo.com/ecommerce/public/common/vat/validate' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"vat_number": "string"
}'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/common/vat/validate"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = {
"vat_number": "string"
}
r = requests.post(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/common/vat/validate";
const res = await fetch(url, {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify({
"vat_number": "string"
}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"vat_number": "string"
}`)
req, _ := http.NewRequest("POST", "https://apigw.ipxo.com/ecommerce/public/common/vat/validate", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/common/vat/validate");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"vat_number" => "string"
]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
{
"data": {
"status": "string",
"validated_at": "string",
"company_name": "string",
"country_code": "string"
}
}ASN Validate
GET
/v1/common/asn/validate/{asn}ASN Validate
Path parameters
asnASN
Response 200
asnNo description in the spec
validNo description in the spec
as_nameNo description in the spec
uce3No description in the spec
ofacNo description in the spec
spamhausNo description in the spec
countryNo description in the spec
statusNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/common/asn/validate/{asn}' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/common/asn/validate/{asn}"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/common/asn/validate/{asn}";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/common/asn/validate/{asn}", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/common/asn/validate/{asn}");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
ASN Validate Resource
{
"asn": 1,
"valid": true,
"as_name": "string",
"uce3": true,
"ofac": true,
"spamhaus": true,
"country": "string",
"status": "string"
}401
Unauthorized
403
Forbidden
404
Not Found
Get list of countries
GET
/v1/common/countriesReturns list of countries
Response 200
uuidNo description in the spec
alpha_2_codeNo description in the spec
alpha_3_codeNo description in the spec
nameNo description in the spec
phone_codeNo description in the spec
tenant_availabilityNo description in the spec
ofac_listedNo description in the spec
statesmap of state_code => state_name
states.state_code1No description in the spec
states.state_code2No description in the spec
states.state_code..No description in the spec
states.state_codeNNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/common/countries' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/common/countries"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/common/countries";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/common/countries", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/common/countries");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Countries resource
{
"uuid": "00000000-0000-0000-0000-000000000000",
"alpha_2_code": "string",
"alpha_3_code": "string",
"name": "string",
"phone_code": "string",
"tenant_availability": true,
"ofac_listed": true,
"states": {
"state_code1": "string",
"state_code2": "string",
"state_code..": "string",
"state_codeN": "string"
}
}401
Unauthorized
403
Forbidden
Get list of Tenant Industries
GET
/v1/common/industriesReturns list of Tenant Industries
Query parameters
sortSort By Key
directionSort Direction
Response 200
dataNo description in the spec
data.uuidNo description in the spec
data.nameNo description in the spec
metaNo description in the spec
meta.current_pageNo description in the spec
meta.fromNo description in the spec
meta.last_pageNo description in the spec
meta.per_pageNo description in the spec
meta.toNo description in the spec
meta.totalNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/common/industries' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/common/industries"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/common/industries";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/common/industries", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/common/industries");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Industries Collection
{
"data": [
{
"uuid": "00000000-0000-0000-0000-000000000000",
"name": "string"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 1,
"to": 1,
"total": 1
}
}401
Unauthorized
403
Forbidden
404
Not Found
List available registrars
GET
/v1/common/market/registrarsReturns available registrars
Response 200
uuidNo description in the spec
nameNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/common/market/registrars' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/common/market/registrars"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/common/market/registrars";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/common/market/registrars", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/common/market/registrars");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Successful operation
[
{
"uuid": "00000000-0000-0000-0000-000000000000",
"name": "string"
}
]401
Unauthorized
403
Forbidden
404
Not Found
List aggregated subnet usage
GET
/v1/common/market/subnetUsageReturns subnet usage
Query parameters
maskmask
periodtime period
sortSort. If direction is not provided defaults to descending.
directionSorting direction. If not provided defaults to descending
Response 200
maskNo description in the spec
freeNo description in the spec
in_useNo description in the spec
price_minNo description in the spec
price_maxNo description in the spec
price_avgNo description in the spec
periodNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/common/market/subnetUsage' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/common/market/subnetUsage"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/common/market/subnetUsage";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/common/market/subnetUsage", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/common/market/subnetUsage");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Successful operation
[
{
"mask": 1,
"free": 1,
"in_use": 1,
"price_min": 1.0,
"price_max": 1.0,
"price_avg": 1.0,
"period": "2026-01-01T00:00:00Z"
}
]401
Unauthorized
403
Forbidden
404
Not Found
Check if prefixes is valid for adding to Market
POST
/v1/common/market/subnetValidityCheck if prefixes is valid for adding to Market
Request body
prefixesNo description in the spec
Response 200
addressNo description in the spec
cidrNo description in the spec
statusNo description in the spec
messageNo description in the spec
minimum_splitNo description in the spec
maximum_splitNo description in the spec
registryNo description in the spec
Request
curl -X POST 'https://apigw.ipxo.com/billing/v1/common/market/subnetValidity' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"prefixes": [
"string"
]
}'import os, requests
url = "https://apigw.ipxo.com/billing/v1/common/market/subnetValidity"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = {
"prefixes": [
"string"
]
}
r = requests.post(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/common/market/subnetValidity";
const res = await fetch(url, {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify({
"prefixes": [
"string"
]
}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"prefixes": [
"string"
]
}`)
req, _ := http.NewRequest("POST", "https://apigw.ipxo.com/billing/v1/common/market/subnetValidity", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/common/market/subnetValidity");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"prefixes" => ["string"]
]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Successful operation
[
{
"address": "string",
"cidr": 1,
"status": true,
"message": "string",
"minimum_split": 1,
"maximum_split": 1,
"registry": "string"
}
]401
Unauthorized
403
Forbidden
Market Service verification
GET
/v1/common/market_auth_verify/{token}Market Service verification
Path parameters
tokenNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/common/market_auth_verify/{token}' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/common/market_auth_verify/{token}"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/common/market_auth_verify/{token}";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/common/market_auth_verify/{token}", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/common/market_auth_verify/{token}");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Successful operation
404
Verification token not found
500
Internal Server Error
Get list of Commission minimum pricings
GET
/v1/common/pricing/commissionsGet list of Commission minimum pricings
Response 200
cidrNo description in the spec
min_commissionNo description in the spec
min_ip_priceNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/common/pricing/commissions' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/common/pricing/commissions"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/common/pricing/commissions";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/common/pricing/commissions", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/common/pricing/commissions");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Commissions Collection
[
{
"cidr": 1,
"min_commission": 1.0,
"min_ip_price": 1.0
}
]401
Unauthorized
403
Forbidden
404
Not Found
Get Public Slack URL
GET
/v1/common/slackGet Public Slack URL
Response 200
slack_urlNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/common/slack' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/common/slack"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/common/slack";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/common/slack", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/common/slack");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Slack URL Resource
{
"slack_url": "string"
}401
Unauthorized
403
Forbidden
404
Not Found
List Services Terminations Reasons
GET
/v1/common/termination-reasonsList of termination reasons for services
Response 200
uuidNo description in the spec
titleNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/common/termination-reasons' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/common/termination-reasons"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/common/termination-reasons";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/common/termination-reasons", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/common/termination-reasons");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Services terminations reasons Collection
{
"uuid": "00000000-0000-0000-0000-000000000000",
"title": "string"
}400
Invalid Request
401
Unauthorized
403
Forbidden
Validate subnets for ASN
POST
/v1/{tenantUUID}/asn/validate/{asn}Validates which subnets can be added to cart with the given ASN
Path parameters
tenantUUIDTenant UUID
asnASN
Request body
subnetsNo description in the spec
Response 200
asnNo description in the spec
validNo description in the spec
as_nameNo description in the spec
uce3No description in the spec
ofacNo description in the spec
spamhausNo description in the spec
countryNo description in the spec
statusNo description in the spec
subnetsNo description in the spec
subnets.subnetNo description in the spec
subnets.already_addedNo description in the spec
Request
curl -X POST 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/asn/validate/{asn}' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"subnets": [
"string"
]
}'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/asn/validate/{asn}"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = {
"subnets": [
"string"
]
}
r = requests.post(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/asn/validate/{asn}";
const res = await fetch(url, {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify({
"subnets": [
"string"
]
}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"subnets": [
"string"
]
}`)
req, _ := http.NewRequest("POST", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/asn/validate/{asn}", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/asn/validate/{asn}");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"subnets" => ["string"]
]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Subnet validation results
{
"asn": 1,
"valid": true,
"as_name": "string",
"uce3": true,
"ofac": true,
"spamhaus": true,
"country": "string",
"status": "string"
}401
Unauthorized
403
Forbidden
404
ASN Not Found
422
Validation Error
Get list of service leased pricings
GET
/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/leasedGet list of service leased pricings
Path parameters
tenantUUIDTenant UUID
ipmarketServiceUUIDIPMarket Service UUID
Response 200
uuidNo description in the spec
prefix_lengthNo description in the spec
addressNo description in the spec
pricingNo description in the spec
pricing.uuidNo description in the spec
pricing.subnet_sizeNo description in the spec
pricing.ip_countNo description in the spec
pricing.priceNo description in the spec
pricing.commissionNo description in the spec
pricing.wants_to_negotiateNo description in the spec
pricing.selected_commitment_periodsCommitment period in months
commitmentsNo description in the spec
commitments.uuidNo description in the spec
commitments.pricing_uuidNo description in the spec
commitments.statusNo description in the spec
commitments.priceNo description in the spec
commitments.periodNo description in the spec
commitments.start_dateNo description in the spec
commitments.end_dateNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/leased' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/leased"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/leased";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/leased", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/services/{ipmarketServiceUUID}/leased");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Leased service resource
{
"uuid": "00000000-0000-0000-0000-000000000000",
"prefix_length": 1,
"address": "string",
"pricing": {
"uuid": "00000000-0000-0000-0000-000000000000",
"subnet_size": 1.0,
"ip_count": 1.0,
"price": 1.0,
"commission": 1.0,
"wants_to_negotiate": true,
"selected_commitment_periods": [
"string"
]
},
"commitments": [
{
"uuid": "00000000-0000-0000-0000-000000000000",
"pricing_uuid": "00000000-0000-0000-0000-000000000000",
"status": "string",
"price": "string",
"period": "string",
"start_date": "string",
"end_date": "string"
}
]
}401
Unauthorized
403
Forbidden
404
Not Found
IPv6 & quarantine
3 operations
The object
API.Pub.Resources.Jobs.BatchesResourceDeclared in the spec. Shown from GET /v1/{tenantUUID}/batches.
Attributes
nameNo description in the spec
total_jobsNo description in the spec
resultsNo description in the spec
results.statusNo description in the spec
results.metadataNo description in the spec
Get list of batches
GET
/v1/{tenantUUID}/batchesReturns list of batches
Path parameters
tenantUUIDTenant UUID
Query parameters
filterFilters
includeInclude relations
pageList Page
per_pageItems Per Page
Response 200
nameNo description in the spec
total_jobsNo description in the spec
resultsNo description in the spec
results.statusNo description in the spec
results.metadataNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/batches' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/batches"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.get(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/batches";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/batches", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/batches");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Batches Collection
{
"name": "string",
"total_jobs": 1,
"results": {
"status": "string",
"metadata": [
{}
]
}
}401
Unauthorized
403
Forbidden
Request IPV6
POST
/v1/{tenantUUID}/ipv6/requestRequest IPV6
Path parameters
tenantUUIDTenant UUID
Request
curl -X POST 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/ipv6/request' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '"string"'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/ipv6/request"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = "string"
r = requests.post(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/ipv6/request";
const res = await fetch(url, {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify("string"),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`"string"`)
req, _ := http.NewRequest("POST", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/ipv6/request", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/ipv6/request");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode("string"),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
204
Response status code
401
Unauthorized
403
Forbidden
404
Not Found
422
Unprocessable Entity
List Subnets In Quarantine
GET
/v1/{tenantUUID}/market/ipv4/quarantineList Subnets In Quarantine
Path parameters
tenantUUIDTenant UUID
Query parameters
sortSort By Key
directionSort Direction
Response 200
subnetNo description in the spec
in_quarantine_sinceNo description in the spec
roa_validation_last_updatedNo description in the spec
bgp_validation_last_updatedNo description in the spec
ip_reputation_last_updatedNo description in the spec
Request
curl -X GET 'https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/quarantine' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '"string"'import os, requests
url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/quarantine"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = "string"
r = requests.get(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/quarantine";
const res = await fetch(url, {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify("string"),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`"string"`)
req, _ := http.NewRequest("GET", "https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/quarantine", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/billing/v1/{tenantUUID}/market/ipv4/quarantine");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode("string"),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Subnets in quarantine collection
{
"subnet": "string",
"in_quarantine_since": 1,
"roa_validation_last_updated": 1,
"bgp_validation_last_updated": 1,
"ip_reputation_last_updated": 1
}400
Invalid Request
401
Unauthorized
403
Forbidden
Webhooks
2 operations
postPublicCommonStripeWebhook
POST
/public/common/stripe/webhookRequest
curl -X POST 'https://apigw.ipxo.com/ecommerce/public/common/stripe/webhook' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/common/stripe/webhook"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.post(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/common/stripe/webhook";
const res = await fetch(url, {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("POST", "https://apigw.ipxo.com/ecommerce/public/common/stripe/webhook", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/common/stripe/webhook");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Webhook Handled
{}postPublicCommonStripeWebhookEu
POST
/public/common/stripe/webhook/euRequest
curl -X POST 'https://apigw.ipxo.com/ecommerce/public/common/stripe/webhook/eu' \
-H 'Authorization: Bearer $IPXO_TOKEN' \
-H 'Accept: application/json'import os, requests
url = "https://apigw.ipxo.com/ecommerce/public/common/stripe/webhook/eu"
headers = {
"Authorization": f"Bearer {os.environ['IPXO_TOKEN']}",
"Accept": "application/json",
}
r = requests.post(url, headers=headers)
r.raise_for_status()
print(r.json())const url = "https://apigw.ipxo.com/ecommerce/public/common/stripe/webhook/eu";
const res = await fetch(url, {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.IPXO_TOKEN}`,
Accept: "application/json",
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("POST", "https://apigw.ipxo.com/ecommerce/public/common/stripe/webhook/eu", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("IPXO_TOKEN"))
req.Header.Set("Accept", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}<?php
$ch = curl_init("https://apigw.ipxo.com/ecommerce/public/common/stripe/webhook/eu");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("IPXO_TOKEN"),
"Accept: application/json",
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Response
200
Webhook Handled
{}