Skip to main content
GET
Get price lines for display

Authorizations

Authorization
string
header
required

Machine-to-machine clients use the OAuth 2.0 client credentials grant. Each tenant has its own authorization server: in the token URL below, replace tenant with your tenant identifier.

Headers

tenant
string
required

Your tenant identifier. Requests without it are rejected.

Path Parameters

policyId
string
required

Policy ID

Pattern: ^policy(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$

Query Parameters

branchId
string

Branch ID (optional, defaults to latest)

Pattern: ^branch(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$
whenAt
string<date-time>

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

effectiveAt
string<date-time>

Date the price was computed at (whenAt, branch effective date, or now)