Skip to main content
GET
/
pricing
/
{policyId}
/
price
Get price lines for display
curl --request GET \
  --url https://api.example.com/pricing/{policyId}/price
{
  "frequency": "YEARLY",
  "total": {
    "premiumPreFeesAndTaxes": 123,
    "fees": 123,
    "withFeesPreTaxes": 123,
    "taxes": 123,
    "withFeesAndTaxes": 123
  },
  "recurring": {
    "premiumPreFeesAndTaxes": 123,
    "fees": 123,
    "withFeesPreTaxes": 123,
    "taxes": 123,
    "withFeesAndTaxes": 123
  },
  "oneTime": {
    "premiumPreFeesAndTaxes": 123,
    "fees": 123,
    "withFeesPreTaxes": 123,
    "taxes": 123,
    "withFeesAndTaxes": 123
  },
  "lines": [
    {
      "key": "<string>",
      "amount": 123,
      "forTypes": [
        "<string>"
      ],
      "adjustedAmount": 123,
      "type": "price",
      "subLines": [
        {
          "key": "<string>",
          "amount": 123,
          "forTypes": [
            "<string>"
          ],
          "adjustedAmount": 123,
          "type": "price"
        }
      ]
    }
  ],
  "totalLine": {
    "key": "<string>",
    "amount": 123,
    "adjustedAmount": 123
  },
  "firstInvoiceTotal": {
    "key": "<string>",
    "amount": 123,
    "adjustedAmount": 123
  },
  "renewalTotal": {
    "key": "<string>",
    "amount": 123,
    "adjustedAmount": 123
  }
}

Path Parameters

policyId
string
required

Policy ID

Query Parameters

branchId
string

Branch ID (optional, defaults to latest)

whenAt
string

Filter assets active at this date (ISO-8601)

Response

frequency
enum<string>
required

Billing frequency from policy config

Available options:
YEARLY,
HALF_YEARLY,
QUARTERLY,
MONTHLY,
BIENNIAL,
WEEKLY
total
object
required

Full contract amounts (face value)

recurring
object
required

Recurring amounts divided by frequency

oneTime
object
required

One-time amounts at face value

lines
object[]

Configurable display lines computed from product priceBreakdownConfig

totalLine
object

Configurable total display line

firstInvoiceTotal
object

First invoice total display line

renewalTotal
object

Renewal total display line