List catalog offers
curl --request GET \
--url https://api.example.com/offers \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.example.com/offers"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.example.com/offers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/offers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/offers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/offers")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/offers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"items": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"externalCode": "<string>",
"status": "ACTIVE",
"chargeType": "PREPAID",
"recurrence": {
"frequency": "MONTHLY",
"customPeriodDays": 123
},
"isAddon": true,
"tags": [
"<string>"
],
"discontinued": true,
"broker": {
"id": "<string>",
"name": "<string>"
},
"metadata": {},
"createdAt": "<string>",
"updatedAt": "<string>",
"currentVersion": {
"id": "<string>",
"versionNumber": 123,
"status": "DRAFT",
"validityStart": "<string>",
"validityEnd": "<string>",
"totalPrice": "<string>",
"hasUsageBasedItems": true,
"items": [
{
"id": "<string>",
"component": {
"id": "<string>",
"name": "<string>",
"icon": "<string>"
},
"quantity": 123,
"price": {
"model": "STANDARD",
"properties": {
"price": "<string>",
"payInAdvance": true
}
},
"currency": "<string>",
"billable": true,
"billableFromCycle": 123,
"validity": {
"duration": 123,
"unit": "CYCLES"
},
"usageBased": true
}
]
}
}
],
"meta": {
"total": 1,
"page": 123,
"pageSize": 123,
"totalPages": 1
}
}Catalog
List catalog offers
Paginated offer listing. Each item carries its current (ACTIVE) version with its priced items, or null when no version is active.
GET
/
offers
List catalog offers
curl --request GET \
--url https://api.example.com/offers \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.example.com/offers"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.example.com/offers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/offers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/offers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/offers")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/offers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"items": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"externalCode": "<string>",
"status": "ACTIVE",
"chargeType": "PREPAID",
"recurrence": {
"frequency": "MONTHLY",
"customPeriodDays": 123
},
"isAddon": true,
"tags": [
"<string>"
],
"discontinued": true,
"broker": {
"id": "<string>",
"name": "<string>"
},
"metadata": {},
"createdAt": "<string>",
"updatedAt": "<string>",
"currentVersion": {
"id": "<string>",
"versionNumber": 123,
"status": "DRAFT",
"validityStart": "<string>",
"validityEnd": "<string>",
"totalPrice": "<string>",
"hasUsageBasedItems": true,
"items": [
{
"id": "<string>",
"component": {
"id": "<string>",
"name": "<string>",
"icon": "<string>"
},
"quantity": 123,
"price": {
"model": "STANDARD",
"properties": {
"price": "<string>",
"payInAdvance": true
}
},
"currency": "<string>",
"billable": true,
"billableFromCycle": 123,
"validity": {
"duration": 123,
"unit": "CYCLES"
},
"usageBased": true
}
]
}
}
],
"meta": {
"total": 1,
"page": 123,
"pageSize": 123,
"totalPages": 1
}
}Authorizations
Headers
Query Parameters
Available options:
MONTHLY, QUARTERLY, ANNUAL, CUSTOM Minimum string length:
1Filter by broker (partner). The x-broker-id header takes precedence over this filter.
Available options:
createdAt, name, updatedAt Available options:
asc, desc Required range:
x <= 100Filter by one or more offer statuses. Repeat the parameter or pass a comma-separated list.
Available options:
ACTIVE, DRAFT, PAUSED, DISCONTINUED Filter by one or more charge types. Repeat the parameter or pass a comma-separated list.
Available options:
PREPAID, POSTPAID Filter by one or more tags. Repeat the parameter or pass a comma-separated list.
Minimum string length:
1