GET
/
monetization
/
public-offering
/
{offering_id}
/
Get Public Offering
curl --request GET \
  --url https://api.paritydeals.com/api/v1/monetization/public-offering/{offering_id}/ \
  --header 'Authorization: Bearer <token>'
{
  "id": "7b793738-9f99-43e0-a8af-7b72fc8f8886",
  "name": "Aphelo v1",
  "description": "",
  "pricingTable": {
    "name": "Aphelo Paywall",
    "description": "",
    "identifier": "aphelo-paywall",
    "style": {
      "priceColor": "#171923",
      "titleColor": "#171923",
      "buttonColor": "#F7FAFC",
      "dividerColor": "#E2E8F0",
      "featureColor": "#2D3748",
      "priceUnitColor": "#171923",
      "descriptionColor": "#718096",
      "pricePeriodColor": "#718096",
      "cardBackgroundColor": "#fff",
      "buttonBackgroundColor": "#1A202C",
      "buttonHoverBackgroundColor": "#1A202C"
    },
    "typography": {
      "priceFontSize": 32,
      "titleFontSize": 24,
      "featureFontSize": 16,
      "priceFontWeight": "bold",
      "titleFontWeight": "bold",
      "featureFontWeight": "normal",
      "priceUnitFontSize": 32,
      "descriptionFontSize": 16,
      "pricePeriodFontSize": 16,
      "priceUnitFontWeight": "bold",
      "descriptionFontWeight": "normal",
      "pricePeriodFontWeight": "normal"
    },
    "layout": {
      "gap": 24,
      "align": "center",
      "maxWidth": 400,
      "minWidth": 360
    },
    "template": null,
    "descriptionTooltipEnabled": true,
    "pricingOptions": {
      "localization": true,
      "showDecimal": true,
      "showCurrencyCode": false,
      "showCurrencySymbol": true,
      "maximumDecimalDigits": 2,
      "minimumDecimalDigits": 2
    }
  },
  "plans": [
    {
      "name": "Free",
      "identifier": "free",
      "details": {
        "stripeProductId": "prod_SUs8ZwzyrjlSAZ"
      },
      "isVisible": true,
      "features": [
        {
          "identifier": "apicalls",
          "displayName": "apicalls",
          "featureType": "METER",
          "value": 5000
        },
        {
          "identifier": "products",
          "displayName": "Products",
          "featureType": "CUSTOMIZABLE",
          "value": 1
        },
        {
          "identifier": "branding",
          "displayName": "branding",
          "featureType": "BOOLEAN",
          "value": false
        },
        {
          "identifier": "email-settings",
          "displayName": "Email settings",
          "featureType": "BOOLEAN",
          "value": true
        }
      ],
      "price": {
        "priceType": "FREE",
        "charges": [
          {
            "chargePeriod": "YEARLY",
            "priceData": {
              "amount": 0
            }
          }
        ]
      }
    },
    {
      "name": "Basic",
      "identifier": "basic",
      "details": {
        "stripeProductId": "prod_SUsCWTpt2AkvJD"
      },
      "isVisible": true,
      "features": [
        {
          "identifier": "apicalls",
          "displayName": "apicalls",
          "featureType": "METER",
          "value": 50000
        },
        {
          "identifier": "products",
          "displayName": "Products",
          "featureType": "CUSTOMIZABLE",
          "value": 5
        },
        {
          "identifier": "branding",
          "displayName": "branding",
          "featureType": "BOOLEAN",
          "value": false
        },
        {
          "identifier": "email-settings",
          "displayName": "Email settings",
          "featureType": "BOOLEAN",
          "value": true
        }
      ],
      "price": {
        "priceType": "PAID",
        "charges": [
          {
            "chargePeriod": "MONTHLY",
            "priceData": {
              "amount": 59
            }
          },
          {
            "chargePeriod": "YEARLY",
            "priceData": {
              "amount": 491
            }
          }
        ]
      }
    }
  ],
  "countryCode": "IN",
  "pricingLocale": "en-US",
  "currencyCode": "USD",
  "currencySymbol": "$",
  "baseCurrencyCode": "USD",
  "baseCurrencySymbol": "$",
  "subscription": {
    "planIdentifier": "basic",
    "features": [],
    "subscriptionId": "7e468572-cc01-424f-ba88-69917164538b",
    "chargePeriod": "MONTHLY",
    "hasPreviousSubscription": true
  },
  "isCustomerExists": true,
  "billingPeriods": [
    {
      "displayName": "Monthly",
      "chargePeriod": "MONTHLY"
    },
    {
      "displayName": "Yearly",
      "chargePeriod": "YEARLY"
    },
    {
      "displayName": "One Time",
      "chargePeriod": "ONE_TIME"
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Path Parameters

offering_id
string
required

The unique identifier (UUID) for the offering.

Query Parameters

customer_id
string

Optional. The identifier for an existing customer to tailor the offering view (e.g., showing their current plan).

Response

200
application/json

Successful response with public offering details.

The response is of type object.