kalshi-typescript/docs/AmendOrderRequest.md

OpenAPI client for kalshi-typescript

# AmendOrderRequest


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**subaccount** | **number** | Optional subaccount number to use for this amendment (0 for primary, 1-32 for subaccounts) | [optional] [default to 0]
**ticker** | **string** | Market ticker | [default to undefined]
**side** | **string** | Side of the order | [default to undefined]
**action** | **string** | Action of the order | [default to undefined]
**client_order_id** | **string** | The original client-specified order ID to be amended | [optional] [default to undefined]
**updated_client_order_id** | **string** | The new client-specified order ID after amendment | [optional] [default to undefined]
**yes_price** | **number** | Updated yes price for the order in cents | [optional] [default to undefined]
**no_price** | **number** | Updated no price for the order in cents | [optional] [default to undefined]
**yes_price_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [optional] [default to undefined]
**no_price_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [optional] [default to undefined]
**count** | **number** | Updated quantity for the order (whole contracts only). If updating quantity, provide count or count_fp; if both provided they must match. | [optional] [default to undefined]
**count_fp** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Currently only whole contract values are permitted, but the format supports future fractional precision. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [optional] [default to undefined]

## Example

```typescript
import { AmendOrderRequest } from 'kalshi-typescript';

const instance: AmendOrderRequest = {
    subaccount,
    ticker,
    side,
    action,
    client_order_id,
    updated_client_order_id,
    yes_price,
    no_price,
    yes_price_dollars,
    no_price_dollars,
    count,
    count_fp,
};
```

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)