checkBillingAction

The check the app runs before a skip trace, export or email verification of count records. Read state and reason first: a BLOCKED org (payment needed) shows 0 whatever it holds. For those three, unitsAvailable is what the action can spend, unused plan allowance (none during a trial) PLUS wallet credits (bought or granted): what answers "how many skip traces are left". For other actions it is not credits (null, or seat slots for an invite). It checks the org, not the person: skip traces still need an admin. willTriggerAutoRecharge.chargeCents is a card charge: say so and get a yes first; when null, mention no card. Read-only.

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "operationId": "checkBillingAction",
    "variables": {
      "action": "EXPORT_PROPERTIES"
    }
  }'

import { GoliathClient } from '@goliath-data/sdk'

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

// Enum values as strings: the SDK's enum types aren't exported yet, so assert to the method's variables type.
const variables = {
  action: 'EXPORT_PROPERTIES'
} as Parameters<typeof goliath.billing.checkBillingAction>[0]

const result = await goliath.billing.checkBillingAction(variables)

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: 'checkBillingAction',
    variables: {
      action: 'EXPORT_PROPERTIES'
    }
  }),
})
const { data, errors } = await res.json()

Variables

The example sends only what the schema requires. Some operations also need one of several optional variables (one filter or another, say); the description above says which.

actionBillingAction!required

EXPORT_PROPERTIESSKIPTRACEEMAIL_VERIFICATIONSEND_TEXTSTART_CALLCREATE_TEAM_INVITEACCEPT_TEAM_INVITE

countInt

Response

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

response shape

{
  "data": {
    "organizationQuery": {
      "canTakeAction": "…"
    }
  }
}

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.

curl https://server.goliathdata.com/api/v1/call \ -H "Authorization: Bearer $GOLIATH_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "operationId": "checkBillingAction", "variables": { "action": "EXPORT_PROPERTIES" } }'

import { GoliathClient } from '@goliath-data/sdk' const goliath = new GoliathClient({ apiKey: process.env.GOLIATH_API_KEY!, baseUrl: 'https://server.goliathdata.com', }) // Enum values as strings: the SDK's enum types aren't exported yet, so assert to the method's variables type. const variables = { action: 'EXPORT_PROPERTIES' } as Parameters<typeof goliath.billing.checkBillingAction>[0] const result = await goliath.billing.checkBillingAction(variables)

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: 'checkBillingAction', variables: { action: 'EXPORT_PROPERTIES' } }), }) const { data, errors } = await res.json()

Variables

Response

Errors

Behaviour

Related