Settings

Update balance currency settings

Changed on

Updates the balance currency settings for your account.

You can only change preferred. Paddle then updates primary to match, but when depends on your account.

If more than one currency is in enabled, Paddle updates primary immediately. preferred must be one of the currencies in enabled, otherwise the request returns an invalid_field error.

Otherwise, Paddle updates primary when your balance is zero. That's immediately if it's already zero, or after your next payout if it isn't. Until then, primary and preferred are different.

If successful, your response includes a copy of the updated balance currency settings entity.

patch/settings/balance-currency

Request

  • Base URL
    https://sandbox-api.paddle.com
  • Auth
    HTTP bearer

Request body

preferred'AUD' | 'CAD' | 'EUR' | 'GBP' | 'USD'

Supported three-letter ISO 4217 currency code for balance currencies.

Response

The request has succeeded.

Example response

{
  "meta": {
    "request_id": "b15ec92e-8688-40d4-a04d-f44cbec93355"
  }
}

Changes