Inttegro PHP SDK

CustomerSelectedAmount extends DomainValue
in package

FinalYes

Persisted currency, range, and suggestions for a selected amount.

Table of Contents

Properties

$currency  : Currency
Required. PHP type: `Currency`; wire field: `currency` (`string`).
$maximum  : int|null
Optional. PHP type: `int|null`; wire field: `maximum` (`integer` minor units).
$minimum  : int
Required. PHP type: `int`; wire field: `minimum` (`integer` minor units).
$suggestedAmounts  : array<string|int, mixed>|null
Optional. PHP type: `list<SuggestedAmount>|null`; wire field: `suggested_amounts` (`array`).

Methods

__construct()  : mixed
Creates a customer-selected price policy returned by the API.
fromArray()  : static
Creates the policy 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

$maximum read-only

Optional. PHP type: `int|null`; wire field: `maximum` (`integer` minor units).

public int|null $maximum = null

$minimum read-only

Required. PHP type: `int`; wire field: `minimum` (`integer` minor units).

public int $minimum

$suggestedAmounts read-only

Optional. PHP type: `list<SuggestedAmount>|null`; wire field: `suggested_amounts` (`array`).

public array<string|int, mixed>|null $suggestedAmounts = null

Methods

__construct()

Creates a customer-selected price policy returned by the API.

public __construct(Currency $currency, int $minimum[, int|null $maximum = null ][, array<int, SuggestedAmount>|null $suggestedAmounts = null ]) : mixed
Parameters
$currency : Currency
$minimum : int
$maximum : int|null = null
$suggestedAmounts : array<int, SuggestedAmount>|null = null

Optional choices. Wire field: suggested_amounts (array).

fromArray()

Creates the policy from its decoded API wire representation.

public static fromArray(array<string, mixed> $data) : static
Parameters
$data : array<string, mixed>

Wire object keyed by snake_case API field names.

Return values
static —

A typed, immutable domain 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 camelCase or wire snake_case field name.

Return values
bool

offsetGet()

Reads a typed property through PHP `ArrayAccess`.

public offsetGet(mixed $offset) : mixed
Parameters
$offset : mixed

PHP camelCase or wire snake_case field 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
throws
LogicException

Always.

offsetUnset()

Rejects unsetting because domain values are immutable.

public offsetUnset(mixed $offset) : void
Parameters
$offset : mixed

Ignored field name.

Tags
throws
LogicException

Always.

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.

On this page

Search results