Creates an Customer object
- Parameters:
params - a dict of parameters; valid keys are:
-
card => addressCity : City of the cardholder.
-
card => addressCountry : Country code
(ISO-3166-1-alpha-2 code) of residence of the cardholder.
-
card => addressLine1 : Address of the
cardholder
-
card => addressLine2 : Address of the
cardholder if needed.
-
card => addressState : State code (USPS code)
of residence of the cardholder.
-
card => addressZip : Postal code of the
cardholder.
-
card => cvc : CVC security code of the card.
This is the code on the back of the card. Example: 123
-
card => expMonth : Expiration month of the
card. Format is MM. Example: January = 01 required
-
card => expYear : Expiration year of the
card. Format is YY. Example: 2013 = 13 required
-
card => name : Name as appears on the card.
-
card => number : Card number as it appears on
the card. required
-
email : Email address of the customer
required
-
name : Customer name required
-
reference : Reference field for external
applications use.
-
subscriptions => amount : Amount of payment
in minor units. Example: 1000 = 10.00
-
subscriptions => coupon : Coupon associated
with the subscription for the customer.
-
subscriptions => currency : Currency code
(ISO-4217). Must match the currency associated with your
account. default:USD
-
subscriptions => customer : The customer ID
to create the subscription for. Do not supply this when
creating a customer.
-
subscriptions => frequency : Frequency of
payment for the plan. Example: Monthly
-
subscriptions => name : Name describing
subscription
-
subscriptions => plan : The plan ID that the
subscription should be created from.
-
subscriptions => quantity : Quantity of the
plan for the subscription.
-
token : If specified, card associated with card
token will be used
auth_args - an Authentication object used for the API call. If no value is
passed the gloabl keys simplify.public_key and
simplify.private_key are used. For backwards compatibility the
public and private keys may be passed instead of an
Authentication object.
private_api_key - Private key to use for the API call. If None , the
value of simplify.private_key will be used.
- Returns:
- a Customer object
|