/ 
Net-API-Stripe-v2.0.6
River stage one • 1 direct dependent • 1 total dependent
/ Net::API::Stripe::Mandate::Options

NAME

Net::API::Stripe::Mandate::Options - Stripe API

SYNOPSIS

use Net::API::Stripe::Mandate::Options;
my $this = Net::API::Stripe::Mandate::Options->new || 
    die( Net::API::Stripe::Mandate::Options->error, "\n" );

VERSION

v0.1.0

DESCRIPTION

METHODS

amount

Amount to be charged for future payments.

amount_type

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.

custom_mandate_url string

A URL for custom mandate text

default_for array of enum values

List of Stripe products where this mandate can be selected automatically. Returned when the Session is in setup mode.

Possible enum values

  • invoice

    Enables payments for Stripe Invoices. ‘subscription’ must also be provided.

  • subscription

    Enables payments for Stripe Subscriptions. ‘invoice’ must also be provided.

description

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

end_date

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.

interval

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

interval_count

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.

interval_description string

Description of the interval. Only required if the payment_schedule parameter is interval or combined.

payment_schedule enum

Payment schedule for the mandate.

Possible enum values

  • interval

    Payments are initiated at a regular pre-defined interval

  • sporadic

    Payments are initiated sporadically

  • combined

    Payments can be initiated at a pre-defined interval or sporadically

reference

Unique identifier for the mandate or subscription.

start_date

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

supported_types

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

transaction_type

Found in invoice object and in subscription object and in checkout session

Transaction type of the mandate.

Possible enum values

  • personal

    Transactions are made for personal reasons

  • business

    Transactions are made for business reasons

AUTHOR

Jacques Deguest <jack@deguest.jp>

SEE ALSO

Payment intent, mandate_options property

COPYRIGHT & LICENSE

Copyright(c) 2022 DEGUEST Pte. Ltd.

All rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.