Inline
extends Amount
in package
An inline amount returned where the API embeds a one-off price rather than a catalog price.
This immutable value inherits its hydration and wire-serialization behavior from its typed parent class.
Table of Contents
Properties
- $currency : Currency
- Required. PHP type: `Currency`; wire field: `currency` (`string`).
- $value : int
- Required. PHP type: `int`; wire field: `value` (`integer` minor units).
Methods
- __construct() : mixed
- Creates a monetary amount returned by the API.
- fromArray() : static
- Creates an Amount from its decoded API wire representation.
- jsonSerialize() : array<string, mixed>
- Returns the same API wire object as `toArray()` for `json_encode()`.
- offsetExists() : bool
- Reports whether a non-null property exists for a PHP or API field name.
- offsetGet() : mixed
- Reads a typed property through PHP `ArrayAccess`.
- offsetSet() : void
- Rejects mutation because domain values are immutable.
- offsetUnset() : void
- Rejects unsetting because domain values are immutable.
- toArray() : array<string, mixed>
- Converts typed properties back to the API's wire representation.
Properties
$currency read-only
Required. PHP type: `Currency`; wire field: `currency` (`string`).
public
Currency
$currency
$value read-only
Required. PHP type: `int`; wire field: `value` (`integer` minor units).
public
int
$value
Methods
__construct()
Creates a monetary amount returned by the API.
public
__construct(Currency $currency, int $value) : mixed
Parameters
- $currency : Currency
-
Required ISO 4217 currency. Wire field:
currency(string). - $value : int
-
Required integer minor-unit value. Wire field:
value(integer).
fromArray()
Creates an Amount from its decoded API wire representation.
public
static fromArray(array<string, mixed> $data) : static
Parameters
- $data : array<string, mixed>
-
Wire object keyed by
snake_caseAPI field names.
Return values
static —A typed, immutable Amount value.
jsonSerialize()
Returns the same API wire object as `toArray()` for `json_encode()`.
public
jsonSerialize() : array<string, mixed>
Return values
array<string, mixed>offsetExists()
Reports whether a non-null property exists for a PHP or API field name.
public
offsetExists(mixed $offset) : bool
Both paymentId and payment_id address the same typed property.
Parameters
- $offset : mixed
-
PHP
camelCaseor wiresnake_casefield name.
Return values
booloffsetGet()
Reads a typed property through PHP `ArrayAccess`.
public
offsetGet(mixed $offset) : mixed
Parameters
- $offset : mixed
-
PHP
camelCaseor wiresnake_casefield name.
Return values
mixed —The PHP-native property value.
offsetSet()
Rejects mutation because domain values are immutable.
public
offsetSet(mixed $offset, mixed $value) : void
Parameters
- $offset : mixed
-
Ignored field name.
- $value : mixed
-
Ignored replacement value.
Tags
offsetUnset()
Rejects unsetting because domain values are immutable.
public
offsetUnset(mixed $offset) : void
Parameters
- $offset : mixed
-
Ignored field name.
Tags
toArray()
Converts typed properties back to the API's wire representation.
public
toArray() : array<string, mixed>
Property names become snake_case. Nested values, arrays, backed enums, and timestamps are
normalized recursively so the result is safe to pass to json_encode().
Return values
array<string, mixed> —The recursively normalized API object.