Skip to docs content
Browse and search
On this page

Read the public catalog

Plans, prices, limits and trials an agent can check out, with the default payment rail and billing cycle. No key needed.

GET/api/agent/catalog

Response fields

  • currencyenum<string>required
  • defaultsobjectrequired
    • billingCycleenum<string>required
    • paymentRailenum<string>required
  • familiesobjectrequired
    • BASEobjectrequired
      • plansobject[]required
        • limitsobjectrequired
        • namestringrequired
        • planTypeenum<string>required
        • pricesobject[]required
        • trialobjectrequired
      • scaleobjectrequired
        • monitoredAccountLimitobjectrequired
        • namestringrequired
        • planTypeenum<string>required
        • websocketLimitobjectrequired
    • INSTAGRAMobjectrequired
      • tiersobject[]required
        • accountLimitintegerrequiredan integer
        • pricesobject[]required
        • websocketConnectionsintegerrequiredan integer
    • ULTRAobjectrequired
      • accountLimitobjectrequired
        • maxintegerrequiredan integer
        • minintegerrequiredan integer
      • pricesPerAccountobject[]required
        • billingCycleenum<string>required
        • chargeMinorstringrequired
      • websocketConnectionsintegerrequiredan integer
  • paymentRailsenum<string>[]required

Responses

  • 200Success