Get your credit balance · Ownrecord docs

Returns the signed-in customer's invoice credit balance in every currency they have one (proration credits, goodwill credits and overpayments), which is applied automatically to their next invoices, and its latest changes. It isn't a usage wallet. Read-only; customer portal only (portal:read).

At a glance

REST: GET /api/v1/portal/me/credit_balance
MCP tool: portal_credit_balance_get
Operation ID: portal.credit_balance.get
Scope: Brand
Permission: portal:read
Risk tier: read
Dry run: Not supported
Idempotency: Not needed (read only)
Modes: Test and live
Authentication: A customer signed in to the customer portal (API keys can't call it)
Since: M9

Request

Query parameters

This operation takes no query parameters.

Response

200 OK with a JSON object:

Field	Type	Description
`object`	`"portal_credit_balance"`
`balances`	array of money	One per currency; applied to your next invoices automatically.
`changes`	array of object
`changes[].change`	money
`changes[].reason`	one of `adjustment`, `invoice_applied`, `invoice_voided`, `proration`, `other`
`changes[].invoiceId`	`inv_…` ID or null
`changes[].effectiveAt`	date-time

Examples

€50 of credit left

HTTP

GET /api/v1/portal/me/credit_balance
Authorization: Bearer or_test_…

Response (200):

JSON

{
  "object": "portal_credit_balance",
  "balances": [
    {
      "amount": "50000000",
      "currency": "EUR"
    }
  ],
  "changes": [
    {
      "change": {
        "amount": "-200000000",
        "currency": "EUR"
      },
      "reason": "invoice_applied",
      "invoiceId": "inv_01m4tx5nj8emwbyf7y9vcf48b3",
      "effectiveAt": "2026-10-20T09:00:00.000Z"
    }
  ]
}

Errors

Code	HTTP status	When	What to do
`validation_failed`	400	A field or pagination value is malformed.	Fix the fields listed in `details.issues` and send the request again.
`livemode_not_allowed`	403	The portal session is in the other mode than the request.	Use test mode, or credentials for the target's mode. Developers need live access granted by an organization owner or admin.
`permission_denied`	403	The caller isn't a customer signed in to this brand's portal (operators and API keys use the customer operations).	Ask an organization owner or admin for a role or scope that allows this action.

It can also return these common errors: api_version_unsupported, authentication_required, api_key_invalid, scope_required, resource_not_found, dry_run_not_supported, rate_limited, internal_error.

At a glance#

Request#

Query parameters#

Response#

Examples#

€50 of credit left#

Errors#