Struct MandatePolicyPeriodCap 

pub struct MandatePolicyPeriodCap {
    pub amount: String,
    pub period: MandatePolicyPeriod,
}

One rolling cap over period (a trailing window, not a calendar period). Send both amount and period, or omit the object. The stored amount is capped at the Coinbase ceiling for that period. Enforced atomically at authorization so concurrent charges cannot exceed the cap.

JSON schema

{
 "title": "Mandate Policy Period Cap",
 "description": "One rolling cap over `period` (a trailing window, not a calendar period). Send both `amount` and `period`, or omit the object. The stored amount is capped at the Coinbase ceiling for that period. Enforced atomically at authorization so concurrent charges cannot exceed the cap.",
 "examples": [
   {
     "amount": "500.00",
     "period": "month"
   }
 ],
 "type": "object",
 "required": [
   "amount",
   "period"
 ],
 "properties": {
   "amount": {
     "description": "Max total authorizable in the rolling `period`. Capped at the Coinbase ceiling for `period`.",
     "examples": [
       "500.00"
     ],
     "type": "string"
   },
   "period": {
     "$ref": "#/components/schemas/MandatePolicyPeriod"
   }
 }
}

Fields

amount: String

Max total authorizable in the rolling period. Capped at the Coinbase ceiling for period.

period: MandatePolicyPeriod

Implementations

impl MandatePolicyPeriodCap

pub fn builder() -> MandatePolicyPeriodCap

Trait Implementations

impl Clone for MandatePolicyPeriodCap

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MandatePolicyPeriodCap

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MandatePolicyPeriodCap

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&MandatePolicyPeriodCap> for MandatePolicyPeriodCap

fn from(value: &MandatePolicyPeriodCap) -> Self

Converts to this type from the input type.

impl From<MandatePolicyPeriodCap> for MandatePolicyPeriodCap

fn from(value: MandatePolicyPeriodCap) -> Self

Converts to this type from the input type.

impl Serialize for MandatePolicyPeriodCap

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<MandatePolicyPeriodCap> for MandatePolicyPeriodCap

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: MandatePolicyPeriodCap) -> Result<Self, ConversionError>

Performs the conversion.