paddle_list_credit_balances: List Credit Balances for a Customer

View source: R/customers.R

paddle_list_credit_balancesR Documentation

List Credit Balances for a Customer

Description

Retrieves credit balances across all currencies for a specific customer from the Paddle API.

Usage

paddle_list_credit_balances(id, currency_code = NULL)

Arguments

id

Character. Paddle customer ID (e.g., "ctm_123"). Required.

currency_code

Optional character vector of ISO 4217 currency codes to filter results.

Value

A list of credit balances by currency with available, reserved, and used totals.

Examples


set_paddle_mode("sandbox")
result <- paddle_list_credit_balances(
  id = "ctm_123",
  currency_code = c("USD", "EUR")
)


paddleR documentation built on June 24, 2025, 9:07 a.m.