Skip to main content
GET
Get Google Ads workspace debt

Authorizations

api_key
string
header
required

Personal API key.

Path Parameters

app_id
string
required

ID of the app whose Google Ads campaigns to manage.

Response

What the workspace owes, and whether it can be settled.

Whether the workspace owes anything for Google Ads spend.

state
string
required

What can be done about the balance. no_workspace_debt means nothing is held. payable means there is an invoice and a usable card. requires_payment_method and requires_payment_refresh both mean a card is needed. pending_payment means a charge is already in flight. paid_recovery_incomplete means the invoice is paid but the account is still held. unavailable means the balance cannot be settled right now, including when stripe_unavailable is true. no_debt and not_recoverable mean the account has no settleable balance.

Example:

"payable"

recoverable
boolean
required

Whether the account is in a state Base44 can settle at all (true) or not (false).

Example:

true

can_pay_now
boolean
required

Whether there is a chargeable invoice and a usable card, so settling would go through now (true) or not (false).

Example:

true

requires_payment_method
boolean
required

Whether a card has to be added or replaced before the balance can be settled (true) or not (false).

Example:

false

stripe_unavailable
boolean
required

Whether Base44 could not reach the payment provider (true) or reached it fine (false). When it is true the card check failed closed, so payment_method reads null and can_pay_now reads false because the check failed, not because the card is missing. Retry rather than telling someone to add a card.

Example:

false

account_id
string | null

ID of the Google Ads account the balance belongs to, or null when state is no_workspace_debt.

Example:

"68b1c0d4e7b91d003c45a1f8"

app_id
string | null

ID of the app that owns the held account, which is not necessarily the app in the path. The value is null when state is no_workspace_debt.

Example:

"6820f3a4e7b91d003c45a1f2"

account_status
string | null

Status of the held Google Ads account, or null when state is no_workspace_debt.

Example:

"BLOCKED"

block_reason
string | null

Why the account is held, or null when it is not held or the reason is unrecorded.

Example:

"PAYMENT_FAILED"

charge_trigger_mode
string | null

How the account is billed. cadence is the recurring charge and threshold is spend-triggered. The value is null when state is no_workspace_debt.

Example:

"cadence"

payment_method
WorkspaceDebtPaymentMethod · object | null

The card on file, or null when the workspace has none and when the payment provider could not be reached.

invoice
WorkspaceDebtInvoice · object | null

The unpaid invoice behind the hold, or null when there is none to settle and when the latest one is already paid.