Get an offer version by id
curl --request GET \
--url https://api.example.com/offer-versions/{offerVersionId} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.example.com/offer-versions/{offerVersionId}"
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/offer-versions/{offerVersionId}', 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/offer-versions/{offerVersionId}",
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/offer-versions/{offerVersionId}"
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/offer-versions/{offerVersionId}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/offer-versions/{offerVersionId}")
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{
"id": "<string>",
"offerId": "<string>",
"versionNumber": 123,
"status": "DRAFT",
"createdAt": "<string>",
"totalPrice": "<string>",
"hasUsageBasedItems": true,
"items": [
{
"id": "<string>",
"pricing": {
"model": "STANDARD",
"properties": {
"price": "<string>",
"payInAdvance": true
}
},
"quantity": 123,
"billable": true,
"currency": "<string>",
"usageBased": true,
"component": {
"id": "<string>",
"name": "<string>",
"category": "<string>"
},
"billableFromCycle": 123,
"validity": {
"duration": 123,
"unit": "CYCLES"
}
}
],
"discounts": [
{
"id": "<string>",
"discount": {
"id": "<string>",
"name": "<string>",
"method": "AUTOMATIC",
"frequency": "ONCE",
"status": "ACTIVE",
"value": {
"type": "FIXED_AMOUNT",
"amount": "<string>",
"currency": "<string>"
},
"combinationMode": "CUMULATIVE",
"couponCode": "<string>",
"ruleId": "<string>"
},
"scope": "OFFER",
"fromCycle": 123,
"oncePerCustomer": true,
"redemptionCount": 123,
"isActive": true,
"componentId": "<string>",
"durationInCycles": 123,
"maxRedemptions": 123,
"removedAt": "<string>"
}
],
"activeSubscriptionsCount": 1,
"offer": {
"id": "<string>",
"name": "<string>",
"isAddon": true,
"externalCode": "<string>"
},
"publishedAt": "<string>",
"updatedAt": "<string>",
"validityStart": "<string>",
"validityEnd": "<string>",
"metadata": {},
"ruleId": "<string>"
}{
"type": "https://docs.bemobiwave.com/api-reference/errors/validation-error",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "https://docs.bemobiwave.com/api-reference/errors/validation-error",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "https://docs.bemobiwave.com/api-reference/errors/validation-error",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "https://docs.bemobiwave.com/api-reference/errors/validation-error",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Catalog
Get an offer version
Resolves a standalone offer-version id together with its parent offer — e.g. a BFF resolving pricing/plan details from a subscription product’s offerVersionId.
GET
/
offer-versions
/
{offerVersionId}
Get an offer version by id
curl --request GET \
--url https://api.example.com/offer-versions/{offerVersionId} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.example.com/offer-versions/{offerVersionId}"
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/offer-versions/{offerVersionId}', 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/offer-versions/{offerVersionId}",
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/offer-versions/{offerVersionId}"
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/offer-versions/{offerVersionId}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/offer-versions/{offerVersionId}")
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{
"id": "<string>",
"offerId": "<string>",
"versionNumber": 123,
"status": "DRAFT",
"createdAt": "<string>",
"totalPrice": "<string>",
"hasUsageBasedItems": true,
"items": [
{
"id": "<string>",
"pricing": {
"model": "STANDARD",
"properties": {
"price": "<string>",
"payInAdvance": true
}
},
"quantity": 123,
"billable": true,
"currency": "<string>",
"usageBased": true,
"component": {
"id": "<string>",
"name": "<string>",
"category": "<string>"
},
"billableFromCycle": 123,
"validity": {
"duration": 123,
"unit": "CYCLES"
}
}
],
"discounts": [
{
"id": "<string>",
"discount": {
"id": "<string>",
"name": "<string>",
"method": "AUTOMATIC",
"frequency": "ONCE",
"status": "ACTIVE",
"value": {
"type": "FIXED_AMOUNT",
"amount": "<string>",
"currency": "<string>"
},
"combinationMode": "CUMULATIVE",
"couponCode": "<string>",
"ruleId": "<string>"
},
"scope": "OFFER",
"fromCycle": 123,
"oncePerCustomer": true,
"redemptionCount": 123,
"isActive": true,
"componentId": "<string>",
"durationInCycles": 123,
"maxRedemptions": 123,
"removedAt": "<string>"
}
],
"activeSubscriptionsCount": 1,
"offer": {
"id": "<string>",
"name": "<string>",
"isAddon": true,
"externalCode": "<string>"
},
"publishedAt": "<string>",
"updatedAt": "<string>",
"validityStart": "<string>",
"validityEnd": "<string>",
"metadata": {},
"ruleId": "<string>"
}{
"type": "https://docs.bemobiwave.com/api-reference/errors/validation-error",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "https://docs.bemobiwave.com/api-reference/errors/validation-error",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "https://docs.bemobiwave.com/api-reference/errors/validation-error",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "https://docs.bemobiwave.com/api-reference/errors/validation-error",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Authorizations
Path Parameters
Response
Default Response
Available options:
DRAFT, APPROVING, ACTIVE, DEPRECATED Show child attributes
Show child attributes
Show child attributes
Show child attributes
Required range:
x >= 0Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I