Mayson Monorepo Documentation
    Preparing search index...

    Interface Mandate

    A Mandate is a record of the permission that your customer gives you to debit their payment method.

    interface Mandate {
        id: string;
        object: "mandate";
        customer_acceptance: Stripe.Mandate.CustomerAcceptance;
        livemode: boolean;
        multi_use?: MultiUse;
        on_behalf_of?: string;
        payment_method: string | Stripe.PaymentMethod;
        payment_method_details: Stripe.Mandate.PaymentMethodDetails;
        single_use?: Stripe.Mandate.SingleUse;
        status: Stripe.Mandate.Status;
        type: Stripe.Mandate.Type;
    }
    Index

    Properties

    id object customer_acceptance livemode multi_use? on_behalf_of? payment_method payment_method_details single_use? status type

    Properties

    id: string

    Unique identifier for the object.

    object: "mandate"

    String representing the object's type. Objects of the same type share the same value.

    customer_acceptance: Stripe.Mandate.CustomerAcceptance
    livemode: boolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    multi_use?: MultiUse
    on_behalf_of?: string

    The account (if any) that the mandate is intended for.

    payment_method: string | Stripe.PaymentMethod

    ID of the payment method associated with this mandate.

    payment_method_details: Stripe.Mandate.PaymentMethodDetails
    single_use?: Stripe.Mandate.SingleUse
    status: Stripe.Mandate.Status

    The mandate status indicates whether or not you can use it to initiate a payment.

    type: Stripe.Mandate.Type

    The type of the mandate.

    Settings

    Member Visibility

    On This Page

    Properties