CustomerSelectedPriceInput
extends DomainValue
in package
Couples a saved customer-selected price with one concrete unit amount.
Table of Contents
Properties
- $priceId : string
- Required. PHP type: `string`; wire field: `price_id` (`string`).
- $selectedAmount : AmountParams
- Required. PHP type: `AmountParams`; wire field: `selected_amount` (`object`).
Methods
- __construct() : mixed
- Creates a price-and-amount selection for one order line item.
- fromArray() : static
- Creates the selection from a decoded API wire object.
- 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
$priceId read-only
Required. PHP type: `string`; wire field: `price_id` (`string`).
public
string
$priceId
$selectedAmount read-only
Required. PHP type: `AmountParams`; wire field: `selected_amount` (`object`).
public
AmountParams
$selectedAmount
Methods
__construct()
Creates a price-and-amount selection for one order line item.
public
__construct(string $priceId, AmountParams $selectedAmount) : mixed
Parameters
- $priceId : string
- $selectedAmount : AmountParams
fromArray()
Creates the selection from a decoded API wire object.
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 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
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.