Mayson Monorepo Documentation
    Preparing search index...

    Interface MandateOptions

    interface MandateOptions {
        amount: number;
        amount_type: Stripe.Checkout.Session.PaymentMethodOptions.Payto.MandateOptions.AmountType;
        end_date: string;
        payment_schedule: Stripe.Checkout.Session.PaymentMethodOptions.Payto.MandateOptions.PaymentSchedule;
        payments_per_period: number;
        purpose: Stripe.Checkout.Session.PaymentMethodOptions.Payto.MandateOptions.Purpose;
        start_date: string;
    }
    Index

    Properties

    amount amount_type end_date payment_schedule payments_per_period purpose start_date

    Properties

    amount: number

    Amount that will be collected. It is required when amount_type is fixed.

    amount_type: Stripe.Checkout.Session.PaymentMethodOptions.Payto.MandateOptions.AmountType

    The type of amount that will be collected. The amount charged must be exact or up to the value of amount param for fixed or maximum type respectively. Defaults to maximum.

    end_date: string

    Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.

    payment_schedule: Stripe.Checkout.Session.PaymentMethodOptions.Payto.MandateOptions.PaymentSchedule

    The periodicity at which payments will be collected. Defaults to adhoc.

    payments_per_period: number

    The number of payments that will be made during a payment period. Defaults to 1 except for when payment_schedule is adhoc. In that case, it defaults to no limit.

    purpose: Stripe.Checkout.Session.PaymentMethodOptions.Payto.MandateOptions.Purpose

    The purpose for which payments are made. Has a default value based on your merchant category code.

    start_date: string

    Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.

    Settings

    Member Visibility

    On This Page

    Properties