NAME
Net::API::Stripe::Issuing::Card::Holder - A Stripe Card Holder Object
SYNOPSIS
my $holder = $stripe->card_holder({
authorization_controls =>
{
allowed_categories => [],
blocked_categories => [],
spending_limits =>
[
{
amount => 2000000,
categories => '',
interval => 'monthly',
},
{
amount => 200000,
categories => '',
interval => 'weekly',
},
],
spending_limits_currency => 'jpy',
},
billing => $billing_details_object,
company => $account_company_object,
created => '2020-04-12T07:30:10',
email => 'john.doe@example.com',
individual => $account_individual_object,
is_default => $stripe->true,
livemode => $stripe->false,
name => 'John Doe',
phone_number => '+81-(0)90-1234-5678',
requirements => $account_requirements_object,
status => 'active',
type => 'individual',
});
See documentation in Net::API::Stripe for example to make api calls to Stripe to create those objects.
VERSION
v0.200.0
DESCRIPTION
An Issuing Cardholder object represents an individual or business entity who is issued (https://stripe.com/docs/issuing) cards.
CONSTRUCTOR
- new( %ARG )
-
Creates a new Net::API::Stripe::Issuing::Card::Holder object. It may also take an hash like arguments, that also are method of the same name.
METHODS
- id string
-
Unique identifier for the object.
- object string, value is "issuing.cardholder"
-
String representing the object’s type. Objects of the same type share the same value.
-
This is a Net::API::Stripe::Issuing::Card::AuthorizationsControl object.
- billing hash
-
The cardholder’s billing address.
This is a Net::API::Stripe::Billing::Details object.
- company hash preview feature
-
Additional information about a business_entity cardholder.
This is a Net::API::Stripe::Connect::Account::Company object.
- created timestamp
-
Time at which the object was created. Measured in seconds since the Unix epoch.
This is a
DateTime
object. - email string
-
The cardholder’s email address.
- individual hash preview feature
-
Additional information about an individual cardholder.
This is a Net::API::Stripe::Connect::Person object.
- is_default boolean
-
Whether or not this cardholder is the default cardholder.
- livemode boolean
-
Has the value true if the object exists in live mode or the value false if the object exists in test mode.
- metadata hash
-
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- name string
-
The cardholder’s name. This will be printed on cards issued to them.
- phone_number string
-
The cardholder’s phone number.
- requirements hash
-
Information about verification requirements for the cardholder, including what information needs to be collected.
This is a Net::API::Stripe::Connect::Account::Requirements object.
- spending_controls hash
-
This is a hash whose properties are accessible as a dynamic class methods
- amount positive integer
-
Maximum amount allowed to spend per time interval.
- categories array
-
Array of strings containing categories on which to apply the spending limit. Leave this blank to limit all charges.
- interval enum
-
The time interval or event with which to apply this spending limit towards.
-
A maximum amount for each authorization.
- daily
-
A maximum within a day. A day start at midnight UTC.
- weekly
-
A maximum within a week. The first day of a week is Monday.
- monthly
-
A maximum within a month. Starts on the first of that month.
- yearly
-
A maximum amount within a year. Starts January 1st.
- all_time
-
A maximum amount for all transactions.
-
- spending_limits_currency currency
-
Currency for the amounts within spending_limits. Locked to the currency of the card.
- status string
-
One of active, inactive, or blocked.
- type string
-
One of individual or business_entity.
API SAMPLE
{
"id": "ich_fake123456789",
"object": "issuing.cardholder",
"authorization_controls": {
"allowed_categories": [],
"blocked_categories": [],
"spending_limits": [],
"spending_limits_currency": null
},
"billing": {
"address": {
"city": "Beverly Hills",
"country": "US",
"line1": "123 Fake St",
"line2": "Apt 3",
"postal_code": "90210",
"state": "CA"
},
"name": "Jenny Rosen"
},
"company": null,
"created": 1540111055,
"email": "jenny@example.com",
"individual": null,
"is_default": false,
"livemode": false,
"metadata": {},
"name": "Jenny Rosen",
"phone_number": "+18008675309",
"requirements": {
"disabled_reason": null,
"past_due": []
},
"status": "active",
"type": "individual"
}
HISTORY
v0.1
Initial version
v0.2
Added method "spending_controls" that was added on Stripe api.
AUTHOR
Jacques Deguest <jack@deguest.jp>
SEE ALSO
Stripe API documentation:
https://stripe.com/docs/api/issuing/cardholders, https://stripe.com/docs/issuing/cards#create-cardholder
COPYRIGHT & LICENSE
Copyright (c) 2019-2020 DEGUEST Pte. Ltd.
You can use, copy, modify and redistribute this package and associated files under the same terms as Perl itself.