Herald
OpenapiExt

Resolve an entitlement's default price row by currency

Filters the entitlement's enabled Stripe mapping rows by the requested currency (plus optional billing type/period filters) and returns the unique match. Fail-loud by design: 404 when no row matches the currency (no secondary-currency fallback), 409 when multiple rows remain and the caller must narrow by billing type/period. # Authentication Requires valid API Key via X-API-Key header # Realm Isolation The API key must belong to the same realm as the requested realm.

GET
/api/ext/{realmId}/entitlements/{entitlementKey}/default-price

Filters the entitlement's enabled Stripe mapping rows by the requested currency (plus optional billing type/period filters) and returns the unique match. Fail-loud by design: 404 when no row matches the currency (no secondary-currency fallback), 409 when multiple rows remain and the caller must narrow by billing type/period.

Authentication

Requires valid API Key via X-API-Key header

Realm Isolation

The API key must belong to the same realm as the requested realm.

Authorization

api_key
X-API-Key<token>

Client-app API key (third-party external API).

In: header

Path Parameters

realmId*string

Realm ID

entitlementKey*string

Entitlement key

Query Parameters

currency*string

ISO 4217 currency code (e.g. "USD"); reserved codes rejected

billingType?string

Optional narrowing filter: recurring | one_time | non_renewing

billingPeriod?string

Optional narrowing filter: billing period (e.g. month / year)

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/ext/string/entitlements/string/default-price?currency=string"
{  "amount": 0,  "billingPeriod": "string",  "billingType": "string",  "currency": "string",  "entitlementKey": "string",  "externalPriceId": "string",  "mappingId": "string",  "paymentProvider": "string"}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}