Mayson Monorepo Documentation
    Preparing search index...
    interface MandateOptions {
        amount: number;
        amount_type: Stripe.SetupIntentUpdateParams.PaymentMethodOptions.Card.MandateOptions.AmountType;
        currency: string;
        description?: string;
        end_date?: number;
        interval: Stripe.SetupIntentUpdateParams.PaymentMethodOptions.Card.MandateOptions.Interval;
        interval_count?: number;
        reference: string;
        start_date: number;
        supported_types?: "india"[];
    }
    Index

    Properties

    amount: number

    Amount to be charged for future payments.

    One of fixed or maximum. If fixed, the amount param refers to the exact amount to be charged in future payments. If maximum, the amount charged can be up to the value passed for the amount param.

    currency: string

    Currency in which future payments will be charged. Three-letter ISO currency code, in lowercase. Must be a supported currency.

    description?: string

    A description of the mandate or subscription that is meant to be displayed to the customer.

    end_date?: number

    End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.

    Specifies payment frequency. One of day, week, month, year, or sporadic.

    interval_count?: number

    The number of intervals between payments. For example, interval=month and interval_count=3 indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when interval=sporadic.

    reference: string

    Unique identifier for the mandate or subscription.

    start_date: number

    Start date of the mandate or subscription. Start date should not be lesser than yesterday.

    supported_types?: "india"[]

    Specifies the type of mandates supported. Possible values are india.