Sign in

List Google Ads promotional credits

<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Returns the promotional credits on the app's Google Ads account.

Each credit carries its face value in amount_micros and how much has been spent in used_micros, both in micros of the credit currency. Subtract one from the other for what is left.

By default only credits that can still be spent are returned. Pass include_settled=true to also get recently used or expired ones, which come back with spendable: false. If you sum credits, filter on spendable rather than adding every row.

<Note>This endpoint accepts a personal API key. Workspace API keys are not authorized for it and are rejected with a 403.</Note>

<Warning>The response includes fields beyond the ones documented here. Don't rely on undocumented response fields, as they can change at any time.</Warning>

get/api/apps/{app_id}/google-ads/billing/credits

Path parameters

app_idstring required

ID of the app whose Google Ads campaigns to manage.

ID of the app whose Google Ads campaigns to manage.

Query parameters

include_settledboolean

Response

Successful Response

idstring required

ID of the credit.

codestring required

Code the credit was granted under. Empty on a credit Base44 granted directly.

credit_typestring required

Where the credit came from. A value of GOOGLE_PROMO is a Google Ads promotional credit, and PLATFORM_CREDIT is one Base44 granted.

statusstring required

State of the credit. Either ACTIVE, USED, or EXPIRED.

currency_codestring required

Currency of the amounts, as an ISO 4217 code.

amount_microsinteger required

Face value of the credit in micros, so 50000000 is 50.00.

used_microsinteger required

How much of it has been spent, in micros.

expires_atstring date-time nullable

When the credit expires, or null on a credit that does not expire.

spendableboolean required

Whether the credit can still be spent. Rows returned only because you passed include_settled=true report false.

Example response

[
  {
    "id": "68b1c0d4e7b91d003c45a1f7",
    "code": "WELCOME50",
    "credit_type": "GOOGLE_PROMO",
    "status": "ACTIVE",
    "currency_code": "EUR",
    "amount_micros": 50000000,
    "used_micros": 12000000,
    "expires_at": "2026-12-31T23:59:59Z",
    "spendable": true
  }
]

Changes

Changed in 1 of the 14 revisions of this API.1