Type: string
Required: Optional

The amount to charge from the token. Represented as a string to preserve numeric precision.

If the Seller Service has a priceModel of pay_per_use, this parameter is optional. When chargeAmount is not provided, Skyfire automatically charges the configured price of the Seller Service.

Validation Rules

When chargeAmount is provided, it must satisfy the following conditions:

Must be greater than 0
Must be less than or equal to the token's original tokenAmount
Must be less than or equal to the remaining balance on the token

If the token has already been partially charged, the remaining balance may be lower than the original tokenAmount.

If the requested chargeAmount exceeds the remaining balance, the charge will fail.

Token Balance

The token balance represents the remaining amount that can be charged after previous partial charges.

Sellers can use the Introspect Token API to query the remaining balance on a token if they are not tracking partial charges internally.