Ctrl+K

Get an enterprise's Pricing Type config.

get/api/v2/enterprise/{enterpriseId}/config/pricing

Returns an enterprises pricing type info, including all of their current kits and the pricing information for the same.

Path Parameters

  • enterpriseIdstringRequired
    Example: "59cd72485007a239fb00282ed480da1f"
    Pattern: ^[0-9a-f]{32}$

200 Response

Array of
pricingType object required
name string
Allowed values: starter growth
accountFees array[object] required
feeType string
Various types of fees that we invoice our clients
Allowed values: auc utxoTx nonUtxoTx withdrawal subscription apiCall
feeName string
occurrence string
Intervals in which we assess fees on our invoices
Allowed values: monthly oneTime payPerUse
percentAmount number
flatAmount number
flatAmountUnits number
paymentMethod string
Available methods for paying an invoice
Allowed values: stripePayments instantOnChain
overage array[object]
kits array[object] required
kitName object required
active boolean
fees array required
promotions object required
name string required
percentOff number required
amountOff number required
overagePercentOff number required
overageAmountOff number required
currency string required
A unit of currency for a report
Allowed values: ZAR USD GBP EUR CNY CAD AUD
Default: USD
expiry string <date>required
active boolean

404 Response

error string required
Human-readable error message
requestId string required
Client request id
context object required
name string required
Error code
Allowed value: InvalidEnterpriseId

500 Response

context object
Properties that apply to a specific error name
name string required
Error code