Skip to main content
GET
/
monetization
/
product-offering
/
{product_id}
/
Get Product Offering
curl --request GET \
  --url https://api.kelviq.com/api/v1/monetization/product-offering/{product_id}/ \
  --header 'Authorization: Bearer <token>'
{
  "organizationId": 6,
  "countryCode": "US",
  "pricingLocale": "en-US",
  "currencyCode": "USD",
  "currencySymbol": "$",
  "currencyConversionRate": 1,
  "baseCurrencyCode": "USD",
  "baseCurrencySymbol": "$",
  "plans": [
    {
      "name": "iBase",
      "description": "",
      "identifier": "i-base",
      "details": {},
      "isVisible": true,
      "metadata": {},
      "basePlan": null,
      "price": {
        "id": "43856a3d-255c-4f60-a17d-98e1d113bb98",
        "priceType": "PAID",
        "freeTrial": false,
        "trialPeriod": 7,
        "currency": "USD",
        "enabled": true,
        "charges": [
          {
            "id": "6bc6e8f7-5c52-48ae-b75b-0c652dddceb8",
            "chargePeriod": "MONTHLY",
            "tiers": [],
            "priceData": {
              "amount": 19
            },
            "details": {},
            "advanced": {},
            "featureQuantityPrice": 19
          },
          {
            "id": "d3ca0fb6-d478-424d-8621-56d1e15073bd",
            "chargePeriod": "YEARLY",
            "tiers": [],
            "priceData": {
              "amount": 190
            },
            "details": {},
            "advanced": {},
            "featureQuantityPrice": 190
          }
        ]
      },
      "originalPrice": {
        "MONTHLY": 19,
        "YEARLY": 190
      },
      "features": [],
      "shouldHighlight": false,
      "enabled": true,
      "displayName": "iBase",
      "displayDescription": "",
      "includes": ""
    },
    {
      "name": "iStandard",
      "description": "",
      "identifier": "i-standard",
      "details": {},
      "isVisible": true,
      "metadata": {},
      "basePlan": null,
      "price": {
        "id": "61f11451-5aed-4534-9c4c-44e0c47810a6",
        "priceType": "PAID",
        "freeTrial": false,
        "trialPeriod": 7,
        "currency": "USD",
        "enabled": true,
        "charges": [
          {
            "id": "4762b0c0-89b4-4f16-9779-ecd871d98a4e",
            "chargePeriod": "MONTHLY",
            "tiers": [],
            "priceData": {
              "amount": 39
            },
            "details": {},
            "advanced": {},
            "featureQuantityPrice": 39
          },
          {
            "id": "dfc2e342-317c-4d0c-bbf5-c1db43f63a42",
            "chargePeriod": "YEARLY",
            "tiers": [],
            "priceData": {
              "amount": 390
            },
            "details": {},
            "advanced": {},
            "featureQuantityPrice": 390
          }
        ]
      },
      "originalPrice": {
        "MONTHLY": 39,
        "YEARLY": 390
      },
      "features": [],
      "shouldHighlight": false,
      "enabled": true,
      "displayName": "iStandard",
      "displayDescription": "",
      "includes": ""
    },
    {
      "name": "iPremium",
      "description": "",
      "identifier": "i-premium",
      "details": {},
      "isVisible": true,
      "metadata": {},
      "basePlan": null,
      "price": {
        "id": "3b523320-ad1a-4922-b3e0-d504660e4747",
        "priceType": "PAID",
        "freeTrial": false,
        "trialPeriod": 7,
        "currency": "USD",
        "enabled": true,
        "charges": [
          {
            "id": "7a1f0b92-f49a-419b-8845-9b7f7706c566",
            "chargePeriod": "MONTHLY",
            "tiers": [],
            "priceData": {
              "amount": 59
            },
            "details": {},
            "advanced": {},
            "featureQuantityPrice": 59
          },
          {
            "id": "453c2a16-33dc-4585-8876-63b59504d8b5",
            "chargePeriod": "YEARLY",
            "tiers": [],
            "priceData": {
              "amount": 590
            },
            "details": {},
            "advanced": {},
            "featureQuantityPrice": 590
          }
        ]
      },
      "originalPrice": {
        "MONTHLY": 59,
        "YEARLY": 590
      },
      "features": [],
      "shouldHighlight": false,
      "enabled": true,
      "displayName": "iPremium",
      "displayDescription": "",
      "includes": ""
    },
    {
      "name": "freepaln",
      "description": "",
      "identifier": "freepaln",
      "details": {},
      "isVisible": true,
      "metadata": {},
      "basePlan": null,
      "price": {
        "id": "fc5b3277-474e-49d3-8dcf-edd9e46c5bab",
        "priceType": "FREE",
        "freeTrial": false,
        "trialPeriod": 0,
        "currency": "USD",
        "enabled": true,
        "charges": [
          {
            "id": "a9262eb9-447e-4d87-a781-8502432f1dbf",
            "chargePeriod": "ONE_TIME",
            "tiers": [],
            "priceData": {
              "amount": 0
            },
            "details": {},
            "advanced": {},
            "featureQuantityPrice": 0
          }
        ]
      },
      "originalPrice": {
        "ONE_TIME": 0
      },
      "features": [],
      "shouldHighlight": false,
      "enabled": true,
      "displayName": "freepaln",
      "displayDescription": "",
      "includes": ""
    },
    {
      "name": "iUltra",
      "description": "",
      "identifier": "i-ultra",
      "details": {},
      "isVisible": true,
      "metadata": {},
      "basePlan": null,
      "price": {
        "id": "28d8dd6e-e864-4188-958a-f16c9b4a5ae6",
        "priceType": "PAID",
        "freeTrial": true,
        "trialPeriod": 7,
        "currency": "USD",
        "enabled": true,
        "charges": [
          {
            "id": "7195b8ec-1262-413c-a84a-217427d0fdcc",
            "chargePeriod": "MONTHLY",
            "tiers": [],
            "priceData": {
              "amount": 20
            },
            "details": {},
            "advanced": {},
            "featureQuantityPrice": 20
          },
          {
            "id": "d4d6be26-dc10-40bb-9555-6db6985af8a4",
            "chargePeriod": "YEARLY",
            "tiers": [],
            "priceData": {
              "amount": 230
            },
            "details": {},
            "advanced": {},
            "featureQuantityPrice": 230
          }
        ]
      },
      "originalPrice": {
        "MONTHLY": 20,
        "YEARLY": 230
      },
      "features": [],
      "shouldHighlight": false,
      "enabled": true,
      "displayName": "iUltra",
      "displayDescription": "",
      "includes": ""
    }
  ],
  "subscription": {
    "hasPreviousSubscription": false
  },
  "isCustomerExists": false,
  "billingPeriods": [
    {
      "chargePeriod": "ONE_TIME",
      "enabled": true,
      "displayName": "One Time",
      "promoCaption": "",
      "defaultSelected": false
    },
    {
      "chargePeriod": "MONTHLY",
      "enabled": true,
      "displayName": "Monthly",
      "promoCaption": "",
      "defaultSelected": false
    },
    {
      "chargePeriod": "YEARLY",
      "enabled": true,
      "displayName": "Yearly",
      "promoCaption": "",
      "defaultSelected": false
    }
  ]
}

Authorizations

​
Authorization
string
header
required

The Server API Key obtained from the kelviq application. Pass as a Bearer token in the Authorization header. Example: 'Authorization: Bearer YOUR_API_KEY'

Path Parameters

​
product_id
string<uuid>
required

The unique identifier (UUID) of the product.

Query Parameters

​
customer_id
string

Optional. Your customer's ID. When provided, the response includes the customer's active subscription details and the isCustomerExists flag.

​
plans_enabled
string

Optional. Comma-separated list of plan identifiers to include in the response. When omitted, all active plans for the product are returned. Example: plans_enabled=pro,enterprise

​
ip_address
string

Optional. The end customer's IP address, used to determine pricing locale and currency based on their location. Only applied when authenticating with a server API key.

Response

Successful response with product offering details.

​
organizationId
integer

The internal ID of the organization that owns this product.

​
countryCode
string

ISO 3166-1 alpha-2 country code resolved from the request.

​
pricingLocale
string

BCP 47 locale tag used for price formatting (e.g. "en-US").

​
currencyCode
string

ISO 4217 currency code for the resolved locale (e.g. "USD").

​
currencySymbol
string
​
currencyConversionRate
number

Conversion rate from the base currency to the resolved currency.

​
baseCurrencyCode
string
​
baseCurrencySymbol
string
​
plans
object[]
​
subscription
object
​
isCustomerExists
boolean
​
billingPeriods
object[]