GoliathDevelopersGet an API key
Reference/Billinggenerated from the gateway manifest

getPlanCatalog

Every plan on sale.

POST/api/v1/callREADreadruns as the key's owner
View as Markdown

Every plan on sale: monthly and annual (whole-year) price, and what each includes per month. Quote *Formatted; never divide *Cents. Current plan: getBillingSummary; plans change on Billing & Plans.

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "operationId": "getPlanCatalog",
    "variables": {}
  }'
import { GoliathClient } from '@goliath-data/sdk'

const goliath = new GoliathClient({
  apiKey: process.env.GOLIATH_API_KEY!,
  baseUrl: 'https://server.goliathdata.com',
})

const result = await goliath.billing.getPlanCatalog()
const res = await fetch('https://server.goliathdata.com/api/v1/call', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.GOLIATH_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    operationId: 'getPlanCatalog',
    variables: {}
  }),
})
const { data, errors } = await res.json()

Variables

None. Send "variables": {}.

Response

What comes back under data: a list shows as one entry, and a value as its type.

response shape
{
  "data": {
    "billing": {
      "getPlanPrices": {
        "oneMonthRampPriceCents": 0,
        "annualRampPriceCents": 0,
        "oneMonthGrowthPriceCents": 0,
        "annualGrowthPriceCents": 0,
        "oneMonthScalePriceCents": 0,
        "annualScalePriceCents": 0,
        "oneMonthRampPriceFormatted": "…",
        "annualRampPriceFormatted": "…",
        "oneMonthGrowthPriceFormatted": "…",
        "annualGrowthPriceFormatted": "…",
        "oneMonthScalePriceFormatted": "…",
        "annualScalePriceFormatted": "…"
      },
      "getPlanCatalog": [
        {
          "planCode": "RAMP",
          "featureLimits": {
            "seatsCap": 0,
            "skiptraceCap": 0,
            "emailVerificationCap": 0,
            "exportPropertiesCap": 0,
            "aiCreditsCap": 0,
            "smsCreditsCap": 0,
            "phoneNumbersCap": 0,
            "callingMinutesCap": 0
          }
        }
      ]
    }
  }
}

Errors

400unknown_variable

A variable the operation does not declare. A typo is refused rather than silently dropped.

401unauthorized

No bearer header, or the key is invalid or revoked.

403insufficient_scope

The key lacks the scope the operation requires.

403forbidden

A referenced record does not exist, was deleted, or is outside your organization. The gateway cannot tell those apart.

Behaviour

A read. It rejects an Idempotency-Key header with 400 bad_request.

READgetCreditPricesREADgetCreditsPurchaseUrlREADgetSeatsPurchaseUrlREADgetPhoneNumbersPurchaseUrlREADgetAddOnPricesREADgetAiCreditUsage