The currency object provides access to currency information used throughout the system. This object is used to represent various currencies and their properties.

​
Availability

The currency object is globally available and represents the global currency set in the billing settings. It can be accessed in other contexts where currency information is needed, such as in affiliate.currency or subscription.currency.

​
Properties

The currency object contains the following properties:

code
string
required

A unique three-letter code that identifies the currency, following the ISO 4217 standard (e.g., “USD” for United States Dollar).

name
string
required

The full name of the currency (e.g., “United States Dollar”).

symbol
string|null
required

The symbol used to represent the currency. This can be null if no specific symbol is associated with the currency.

fraction_digits
number
required

The number of digits typically used for fractional amounts of this currency (e.g., 2 for currenzcies like USD or EUR, which use cents, or 0 for currencies like JPY that don’t use fractional units).

Was this page helpful?

AffiliateEnvironment