stripe-cli 1.6.1 → 1.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fef5bc5cbf9b0b6f8eb7c97f0f3241c54d1ec13e
-  data.tar.gz: 6f876a9808d867a0b722a11742ba02fc5f2387d0
+  metadata.gz: 2e85eab0abb136dbc6ef72c9ed499f50a2038d16
+  data.tar.gz: 57da9beb0081b703c4003af7871d114a53757a93
 SHA512:
-  metadata.gz: 240faef52c21585845df05f217aa5db285cd139a6f6795ceea363ae85ad7fa62f5f218d43087d0ae9fe9e4eb9516e533283f3907ad5a546b20ec86f25e6eae1b
-  data.tar.gz: 643c7e5db02ae8fd1bdd72112a50caf1992b5aaab17b6eb4a7cd008742deef4f28db23e331ce655f714e12397e37fd23fde44cb3aa02f2a9af2e9e0eaafce572
+  metadata.gz: 9af565dab61af8ddbb01b83d294b19a79d5c804928d47424c8b684baeef5d1005fa265c77553d132473b7c9b5ece90953fbbc2932ec91287028046f8081bfcc5
+  data.tar.gz: 4c5d119ec40a3f89daba2817dcdbb66c856e275a49542d0e07b11b7fa29e2b810744b8a692a92498eea1f5e99648c725d27c6e94fcb22aee69769a8c59dee65c

data/README.md

@@ -22,21 +22,25 @@ Note that Date/Time stamps are converted automatically.  No more Epoch/Unix time
 
 For authentication, pass your secret key using the `-k` or `--key` option
 
-    $ stripe events list -k XXXXXXXXXXXXXXXXXXXXXX
+    $ stripe events list -k sk_test_abcdef123456
 
 To use a specific api version, pass in the `-v` or `--version` option
 
     $ stripe balance_transactions list -v "2014-08-04"
 
-You may also store default configurations in a `~/.stripecli` file that conforms to the following example
+Explicitly passing in configuration every time is tedious. Avoid it by creating a configuration file that contains this data.
+
+Stripe-CLI will check your home folder (**~/**) for the existance of a `.stripecli` file that conforms to the following example
 
 ![example config file](./example.png)
 
-If this file exists, the specified default key is picked up and used automatically.
+If this file exists, the specified default configuration is picked up and used automatically.
 
 The current directory is now also checked for the existance of a `.stripecli` file. In which case, that file is used instead.
 
-You may also overide the default environment setting in your config file by passing in the `-e` or `--env` option
+As shown in the above example, you may set multiple configuration **environments** in a single file. Just make sure to specify a default.
+
+The default **environment** may be overridden by passing in the `-e` or `--env` option to any command
 
     $ stripe customers find cust_123 --env=live
 
@@ -57,53 +61,65 @@ or, if you'd rather:
 
 If you choose to go this route, make sure to add `.stripecli` to your `.gitignore` files.
 
-## Usage
+### Dollars vs. Cents
 
-    Commands:
-      stripe balance         # show currently available & pending balance amounts
-      stripe cards           # find, list, create, & delete cards for both customers & recipients
-      stripe charges         # find, list, create, capture, & refund charges
-      stripe coupons         # find, list, create, & delete coupons
-      stripe customers       # find, list, create, & delete customers
-      stripe events          # find & list events
-      stripe help [COMMAND]  # Describe available commands or one specific command
-      stripe invoices        # find, list, pay, & close invoices
-      stripe plans           # find, list, create, & delete plans
-      stripe recipients      # find, list, create, & delete recipients
-      stripe refunds         # find, list, & create refunds
-      stripe subscriptions   # find, list, create, cancel, & reactivate multiple subscriptions per customer
-      stripe tokens          # find & create tokens for bank accounts & credit cards
-      stripe transactions    # find & list balance transactions
-      stripe transfers       # find, list, & create transfers
+By default stripe-cli expects currency amounts to be specified in **dollars**. This behavior maybe unexpected to veteran Stripe users since the raw API expects **cents**.
+
+To change the expected currency units from **dollars** to **cents**, set the config option `dollar_amounts` to `false` in your `.stripecli` file
+
+    dollar_amounts = false
+
+or
+
+    [test]
+      dollar_amounts = false
+
+If not set, this option defaults to **true** meaning that `amounts` should be in **dollars**
+
+If you need to adjust this setting temporarily, there are global flags which maybe passed to any command
+
+    $ stripe charge create --no-dollar-amounts
+    Amount In Cents: __
+
+    $ stripe charge create --dollar-amounts
+    Amount In Dollars: __
 
 
+
+## General Features & Flexibility
+
 Any parameters accepted by the [stripe api](https://stripe.com/docs/api) are acceptable options to pass into commands, including metadata.
 
-    $ stripe charges create [--amount=AMOUNT][--description=DESC][--card-number=NUM][--card-cvc=CVC][--card-exp-month=MM][--card-exp-year=YYYY]
+    $ stripe charges create  --amount=9.98  --description=a\ must\ have  --number=4242424242424242  --cvc=123  --exp-month=10  --exp-year=2020
 
 or
 
-    $ stripe charges create [--amount=AMOUNT][--card=TOKEN_ID][--metadata=foo:bar details:"product# 4369"]
+    $ stripe charges create  --amount=16.72  --token=tok_abc123  --metadata=foo:bar meta:really\ meta\ data
 
 or
 
-    $ stripe charges create [--amount=AMOUNT][--customer=CUST_ID]
+    $ stripe charges create  --amount=1  --customer=cus_def456  --no-capture
 
 ### Interactive Menus
 
 Passing NO (or partial) arguments to any operation, will trigger an interactive menu
 
-    $ stripe charges create
-    Amount in dollars: __
+    $ stripe charge create
+    Amount In Dollars: __
 
 or
 
-    $ stripe charges create [--amount=AMOUNT]
+    $ stripe charge create  --amount=99
     Name on Card: __
 
+or
+
+    $ stripe token create card --card=number:4242424242424242 name:Uther\ Pendragon cvc:911 exp-month:02
+    Expiration Year: __
+
 ### cursor-based pagination
 
-for all ```list``` operations
+for all `list` operations
 
     Options:
       [--starting-after=OBJECT_ID]  # The ID of the last object in the previous paged result set.
@@ -119,10 +135,95 @@ e.g. fetching a second page
 
 ### Exception Recovery
 
-Api errors are rescued and their messages displayed for you to read.  No more ```barfing``` to ```stdout```
+Api errors are rescued and their messages displayed for you to read.  No more `barfing` to `stdout`
 
 ![error rescue example](./error_message_display.png)
 
+## Usage
+
+    Commands:
+      stripe balance         # show currently available & pending balance amounts
+      stripe cards           # find, list, create, & delete cards for both customers & recipients
+      stripe charges         # find, list, create, capture, & refund charges
+      stripe coupons         # find, list, create, & delete coupons
+      stripe customers       # find, list, create, & delete customers
+      stripe events          # find & list events
+      stripe help [COMMAND]  # Describe available commands or one specific command
+      stripe invoices        # find, list, pay, & close invoices
+      stripe plans           # find, list, create, & delete plans
+      stripe recipients      # find, list, create, & delete recipients
+      stripe refunds         # find, list, & create refunds
+      stripe subscriptions   # find, list, create, cancel, & reactivate multiple subscriptions per customer
+      stripe tokens          # find & create tokens for bank accounts & credit cards
+      stripe transactions    # find & list balance transactions
+      stripe transfers       # find, list, & create transfers
+
+## Command Documentation
+
+- [Charges](#charges)
+    - [Capture](#charge-capture)
+    - [Create](#charge-create)
+    - [Find](#charge-find)
+    - [List](#charges-list)
+    - [Refund](#charge-refund)
+- [Tokens](#tokens)
+    - [Create](#token-create)
+    - [Find](#token-find)
+- [Cards](#cards)
+    - [Create](#card-create)
+    - [Delete](#card-delete)
+    - [Find](#card-find)
+    - [List](#cards-list)
+- [Customers](#customers)
+    - [Create](#customer-create)
+    - [Delete](#customer-delete)
+    - [Find](#customer-find)
+    - [List](#customers-list)
+- [Subscriptions](#subscriptions)
+    - [Cancel](#subscription-cancel)
+    - [Create](#subscription-create)
+    - [Find](#subscription-find)
+    - [List](#subscriptions-list)
+    - [Reactivate](#subscription-reactivate)
+- [Invoices](#invoices)
+    - [Close](#invoice-close)
+    - [Find](#invoice-find)
+    - [List](#invoices-list)
+    - [Pay](#invoice-pay)
+    - [Upcoming](#invoice-upcoming)
+- [Plans](#plans)
+    - [Create](#plan-create)
+    - [Delete](#plan-delete)
+    - [Find](#plan-find)
+    - [List](#plans-list)
+- [Coupons](#coupons)
+    - [Create](#coupon-create)
+    - [Delete](#coupon-delete)
+    - [Find](#coupon-find)
+    - [List](#coupons-list)
+- [Events](#events)
+    - [Find](#event-find)
+    - [List](#events-list)
+- [BalanceTransactions](#balancetransactions)
+    - [Find](#transaction-find)
+    - [List](#transactions-list)
+- [Recipients](#recipients)
+    - [Create](#recipient-create)
+    - [Delete](#recipient-delete)
+    - [Find](#recipient-find)
+    - [List](#recipients-list)
+- [Refunds](#refunds)
+    - [Create](#refund-create)
+    - [Find](#refund-find)
+    - [List](#refunds-list)
+- [Transfers](#transfers)
+    - [Create](#transfer-create)
+    - [Find](#transfer-find)
+    - [List](#transfers-list)
+
+<!-- end toc -->
+
+
 ### Charges
 
     Commands:
@@ -133,6 +234,63 @@ Api errors are rescued and their messages displayed for you to read.  No more ``
       stripe charges list            # List charges (optionally by customer_id)
       stripe charges refund ID       # Refund a charge
 
+#### Charge Capture
+
+    Usage:
+      stripe charges capture ID
+
+#### Charge Create
+
+    Usage:
+      stripe charges create
+
+    Options:
+          [--customer=CUSTOMER]                           # The ID of an existing customer to charge
+          [--token | --card=CARD]                         # credit card Token or ID. May also be created interactively.
+          [--number | --card-number=CARD_NUMBER]          # credit card number. usually 16 digits long
+          [--exp-month | --card-exp-month=CARD_EXP_MONTH] # Two digit expiration month of card
+          [--exp-year | --card-exp-year=CARD_EXP_YEAR]    # Four digit expiration year of card
+          [--cvc | --card-cvc=CARD_CVC]                   # Three or four digit security code located on the back of card
+          [--name | --card-name=CARD_NAME]                # Cardholder's full name as displayed on card
+          [--amount=N]                                    # Charge amount in dollars
+          [--currency=CURRENCY]                           # 3-letter ISO code for currency
+                                                          # Default: usd
+          [--description=DESCRIPTION]                     # Arbitrary description of charge
+          [--capture], [--no-capture]                     # Whether or not to immediately capture the charge. Uncaptured charges expire in 7 days
+                                                          # Default: true
+          [--metadata=key:value]                          # A key/value store of additional user-defined data
+          [--statement-description=STATEMENT_DESCRIPTION] # Displayed alongside your company name on your customer's card statement (15 character max)
+          [--receipt-email=RECEIPT_EMAIL]                 # Email address to send receipt to. Overrides default email settings.
+
+#### Charge Find
+
+    Usage:
+      stripe charges find ID
+
+#### Charges List
+
+    Usage:
+      stripe charges list
+
+    Options:
+          [--starting-after=STARTING_AFTER]  # The ID of the last object in the previous paged result set. For cursor-based pagination.
+          [--ending-before=ENDING_BEFORE]    # The ID of the first object in the previous paged result set, when paging backwards through the list.
+          [--limit=LIMIT]                    # a limit on the number of resources returned, between 1 and 100
+          [--offset=OFFSET]                  # the starting index to be used, relative to the entire list
+          [--count=COUNT]                    # depricated: use limit
+          [--customer=CUSTOMER]              # a customer ID to filter results by
+
+#### Charge Refund
+
+    Usage:
+      stripe charges refund ID
+
+    Options:
+          [--amount=N]                                               # Refund amount in dollars. (Entire charge by default)
+          [--metadata=key:value]                                     # a key/value store of additional user-defined data
+          [--refund-application-fee], [--no-refund-application-fee]  # Whether or not to refund the application fee
+
+
 ### Tokens
 
     Commands:
@@ -140,6 +298,29 @@ Api errors are rescued and their messages displayed for you to read.  No more ``
       stripe tokens find ID         # Find a Token
       stripe tokens help [COMMAND]  # Describe subcommands or one specific subcommand
 
+#### Token Create
+
+    Usage:
+      stripe token create TYPE
+
+    Options:
+          [--card=key:value]                              # hash of card params. params may also be provided individually or added interactively.
+          [--number | --card-number=CARD_NUMBER]          # credit card number. usually 16 digits long
+          [--exp-month | --card-exp-month=CARD_EXP_MONTH] # Two digit expiration month of card
+          [--exp-year | --card-exp-year=CARD_EXP_YEAR]    # Four digit expiration year of card
+          [--cvc | --card-cvc=CARD_CVC]                   # Three or four digit security code located on the back of card
+          [--name | --card-name=CARD_NAME]                # Cardholder's full name as displayed on card
+          [--account | --bank-account=key:value]          # hash of account params. params may also be provided individually or added interactively.
+          [--country=COUNTRY]
+          [--routing-number=ROUTING_NUMBER]
+          [--account-number=ACCOUNT_NUMBER]
+
+#### Token Find
+
+    Usage:
+      stripe token find ID
+
+
 ### Cards
 
     Commands:
@@ -149,6 +330,49 @@ Api errors are rescued and their messages displayed for you to read.  No more ``
       stripe cards help [COMMAND]           # Describe subcommands or one specific subcommand
       stripe cards list --owner=OWNER       # List cards for OWNER (customer or recipient)
 
+#### Card Create
+
+    Usage:
+      stripe card create --customer, --recipient, --owner=OWNER
+
+    Options:
+          [--token | --card=CARD]                     # credit card Token or ID. May also be created interactively.
+          [--number | --card-number=CARD_NUMBER]
+          [--exp-month | --card-exp-month=EXP_MONTH]  # Two digit expiration month of card
+          [--exp-year | --card-exp-year=EXP_YEAR]     # Four digit expiration year of card
+          [--cvc | --card-cvc=CARD_CVC]               # Three or four digit security code located on the back of card
+          [--name | --card-name=CARD_NAME]            # Cardholder's full name as displayed on card
+          --customer, --recipient, --owner=OWNER      # id of customer or recipient receiving new card
+
+#### Card Delete
+
+    Usage:
+      stripe card delete ID --owner=OWNER
+
+    Options:
+          --owner=OWNER       # id of customer or recipient to search within
+
+#### Card Find
+
+    Usage:
+      stripe card find ID --owner=OWNER
+
+    Options:
+          --owner=OWNER       # id of customer or recipient to search within
+
+#### Cards List
+
+    Usage:
+      stripe cards list --owner=OWNER
+
+    Options:
+          [--starting-after=STARTING_AFTER]  # The ID of the last object in the previous paged result set. For cursor-based pagination.
+          [--ending-before=ENDING_BEFORE]    # The ID of the first object in the previous paged result set, when paging backwards through the list.
+          [--limit=LIMIT]                    # a limit on the number of resources returned, between 1 and 100
+          [--offset=OFFSET]                  # the starting index to be used, relative to the entire list
+          [--count=COUNT]                    # depricated: use limit
+          --owner=OWNER                      # id of customer or recipient to search within
+
 ### Customers
 
     Commands:
@@ -158,6 +382,50 @@ Api errors are rescued and their messages displayed for you to read.  No more ``
       stripe customers help [COMMAND]  # Describe subcommands or one specific subcommand
       stripe customers list            # List customers
 
+#### Customer Create
+
+    Usage:
+      stripe customer create
+
+    Options:
+          [--description=DESCRIPTION]                     # Arbitrary description to be displayed in Stripe Dashboard.
+          [--email=EMAIL]                                 # Customer's email address. Will be displayed in Stripe Dashboard.
+          [--plan=PLAN]                                   # The ID of a Plan this customer should be subscribed to. Requires a credit card.
+          [--coupon=COUPON]                               # The ID of a Coupon to be applied to all of Customer's recurring charges
+          [--quantity=QUANTITY]                           # A multiplier for the plan option. defaults to `1'
+          [--trial-end=TRIAL_END]                         # apply a trial period until this date. Override plan's trial period.
+          [--account-balance=ACCOUNT_BALANCE]             # customer's starting account balance in cents. A positive amount will be added to the next invoice while a negitive amount will act as a credit.
+          [--token | --card=CARD]                         # credit card Token or ID. May also be created interactively.
+          [--number | --card-number=CARD_NUMBER]          # credit card number. usually 16 digits long
+          [--exp-month | --card-exp-month=CARD_EXP_MONTH] # Two digit expiration month of card
+          [--exp-year | --card-exp-year=CARD_EXP_YEAR]    # Four digit expiration year of card
+          [--cvc | --card-cvc=CARD_CVC]                   # Three or four digit security code located on the back of card
+          [--name | --card-name=CARD_NAME]                # Cardholder's full name as displayed on card
+          [--metadata=key:value]                          # a key/value store of additional user-defined data
+
+#### Customer Delete
+
+    Usage:
+      stripe customer delete ID
+
+#### Customer Find
+
+    Usage:
+      stripe customer find ID
+
+#### Customers List
+
+    Usage:
+      stripe customers list
+
+    Options:
+          [--starting-after=STARTING_AFTER]  # The ID of the last object in the previous paged result set. For cursor-based pagination.
+          [--ending-before=ENDING_BEFORE]    # The ID of the first object in the previous paged result set, when paging backwards through the list.
+          [--limit=LIMIT]                    # a limit on the number of resources returned, between 1 and 100
+          [--offset=OFFSET]                  # the starting index to be used, relative to the entire list
+          [--count=COUNT]                    # depricated: use limit
+
+
 ### Subscriptions
 
     Commands:
@@ -168,6 +436,63 @@ Api errors are rescued and their messages displayed for you to read.  No more ``
       stripe subscriptions list --customer=CUSTOMER           # List subscriptions for CUSTOMER customer
       stripe subscriptions reactivate ID --customer=CUSTOMER  # reactivate auto-renewal if `cancel-at-period-end` was set to true
 
+#### Subscription Cancel
+
+    Usage:
+      stripe subscription cancel ID c, --customer=CUSTOMER
+
+    Options:
+          [--at-period-end], [--no-at-period-end]  # delay cancellation until end of current period
+                                                   # default: false
+          c, --customer=CUSTOMER                   # id of customer to search within
+
+#### Subscription Create
+
+    Usage:
+      stripe subscription create c, --customer=CUSTOMER
+
+    Options:
+          [--plan=PLAN]                                   # the plan to assign to CUSTOMER customer
+          [--coupon=COUPON]                               # id of a coupon to apply
+          [--trial-end=TRIAL_END]                         # apply a trial period until this date. Override plan's trial period.
+          [--token | --card=CARD]                         # credit card Token or ID. May also be created interactively.
+          [--number | --card-number=CARD_NUMBER]          # credit card number. usually 16 digits long
+          [--exp-month | --card-exp-month=CARD_EXP_MONTH] # Two digit expiration month of card
+          [--exp-year | --card-exp-year=CARD_EXP_YEAR]    # Four digit expiration year of card
+          [--cvc | --card-cvc=CARD_CVC]                   # Three or four digit security code located on the back of card
+          [--name | --card-name=CARD_NAME]                # Cardholder's full name as displayed on card
+          [--metadata=key:value]                          # a key/value store of additional user-defined data
+          c, --customer=CUSTOMER                          # ID of customer receiving the new subscription
+
+#### Subscription Find
+
+    Usage:
+      stripe subscription find ID c, --customer=CUSTOMER
+
+    Options:
+          c, --customer=CUSTOMER  # ID of customer to search within
+
+#### Subscriptions List
+
+    Usage:
+      stripe subscriptions list c, --customer=CUSTOMER
+
+    Options:
+          [--starting-after=STARTING_AFTER]  # The ID of the last object in the previous paged result set. For cursor-based pagination.
+          [--ending-before=ENDING_BEFORE]    # The ID of the first object in the previous paged result set, when paging backwards through the list.
+          [--limit=LIMIT]                    # a limit on the number of resources returned, between 1 and 100
+          [--offset=OFFSET]                  # the starting index to be used, relative to the entire list
+          [--count=COUNT]                    # depricated: use limit
+          c, --customer=CUSTOMER             # ID of customer to search within
+
+#### Subscription Reactivate
+
+    Usage:
+      stripe subscription reactivate ID c, --customer=CUSTOMER
+
+    Options:
+          c, --customer=CUSTOMER  # id of customer to search within
+
 ### Invoices
 
     Commands:
@@ -178,6 +503,40 @@ Api errors are rescued and their messages displayed for you to read.  No more ``
       stripe invoices pay ID             # trigger an open invoice to be paid immediately
       stripe invoices upcoming CUSTOMER  # find the upcoming invoice for CUSTOMER
 
+#### Invoice Close
+
+    Usage:
+      stripe invoice close ID
+
+#### Invoice Find
+
+    Usage:
+      stripe invoice find ID
+
+#### Invoices List
+
+    Usage:
+      stripe invoice list
+
+    Options:
+          [--starting-after=STARTING_AFTER]  # The ID of the last object in the previous paged result set. For cursor-based pagination.
+          [--ending-before=ENDING_BEFORE]    # The ID of the first object in the previous paged result set, when paging backwards through the list.
+          [--limit=LIMIT]                    # a limit on the number of resources returned, between 1 and 100
+          [--offset=OFFSET]                  # the starting index to be used, relative to the entire list
+          [--count=COUNT]                    # depricated: use limit
+          [--customer=CUSTOMER]              # a customer ID to filter results by
+
+#### Invoice Pay
+
+    Usage:
+      stripe invoice pay ID
+
+#### Invoice Upcoming
+
+    Usage:
+      stripe invoice upcoming CUSTOMER
+
+
 ### Plans
 
     Commands:
@@ -187,6 +546,19 @@ Api errors are rescued and their messages displayed for you to read.  No more ``
       stripe plans help [COMMAND]  # Describe subcommands or one specific subcommand
       stripe plans list            # List plans
 
+#### Plan Create
+
+
+#### Plan Delete
+
+
+#### Plan Find
+
+
+#### Plans List
+
+
+
 ### Coupons
 
     Commands:
@@ -196,6 +568,19 @@ Api errors are rescued and their messages displayed for you to read.  No more ``
       stripe coupons help [COMMAND]  # Describe subcommands or one specific subcommand
       stripe coupons list            # List coupons
 
+#### Coupon Create
+
+
+#### Coupon Delete
+
+
+#### Coupon Find
+
+
+#### Coupons List
+
+
+
 ### Events
 
     Commands:
@@ -203,6 +588,13 @@ Api errors are rescued and their messages displayed for you to read.  No more ``
       stripe events help [COMMAND]  # Describe subcommands or one specific subcommand
       stripe events list            # List events
 
+#### Event Find
+
+
+#### Events List
+
+
+
 ### BalanceTransactions
 
     Commands:
@@ -210,6 +602,13 @@ Api errors are rescued and their messages displayed for you to read.  No more ``
       stripe transactions help [COMMAND]  # Describe subcommands or one specific subcommand
       stripe transactions list [TYPE]     # List transactions, optionaly filter by type:(charge refund adjustment application_fee application_fee_refund transfer transfer_failure)
 
+#### Transaction Find
+
+
+#### Transactions List
+
+
+
 ### Recipients
 
     Commands:
@@ -219,6 +618,19 @@ Api errors are rescued and their messages displayed for you to read.  No more ``
       stripe recipients help [COMMAND]  # Describe subcommands or one specific subcommand
       stripe recipients list            # List recipients
 
+#### Recipient Create
+
+
+#### Recipient Delete
+
+
+#### Recipient Find
+
+
+#### Recipients List
+
+
+
 ### Refunds
 
 Though ```refund```  is still a supported operation of the ```charges``` command. The ```refunds``` command offers additional functionality.
@@ -229,6 +641,16 @@ Though ```refund```  is still a supported operation of the ```charges``` command
       stripe refunds help [COMMAND]           # Describe subcommands or one specific subcommand
       stripe refunds list --charge=CHARGE     # List refunds for CHARGE charge
 
+#### Refund Create
+
+
+#### Refund Find
+
+
+#### Refunds List
+
+
+
 ### Transfers
 
     Commands:
@@ -237,7 +659,13 @@ Though ```refund```  is still a supported operation of the ```charges``` command
       stripe transfers help [COMMAND]  # Describe subcommands or one specific subcommand
       stripe transfers list            # List transfers, optionaly filter by recipient or transfer status: ( pending paid failed )
 
-#### Easter Egg Alert!
+#### Transfer Create
+
+#### Transfer Find
+
+#### Transfers List
+
+#### Easter Egg
 
 You can pass the `--balance` flag into `transfer create` to automatically set transfer `amount` equal to your currently available balance.
 
@@ -245,10 +673,10 @@ example:
 
     $ stripe transfer create --balance --recipient=self
 
-> No, its not magic.  The `--balance` flag just triggers a 'preflight' api call to retrieve your current balance and assigns that to the `--amount` option
 
 ## Road Map
 
+1. complete command documentation in this readme
 1. `update` command operations
 1. support for `disputes` & dispute handling
 1. support creating/updating config file through cli
@@ -258,4 +686,4 @@ example:
 
 Pull requests are always welcome and appriciated.
 
-Please report issues, offer suggestions, and voice concerns in the issues tracker.
+Please report issues, offer suggestions, and voice concerns in the issues tracker.

data/changelog.md

@@ -0,0 +1,75 @@
+# Stripe-CLI Project Change Log
+
+## 1.6.3
+
+ - new `dollar_amounts` config setting for toggling expected currency units between **dollars** and **cents**
+ - `--no-dollar-amounts` global option flag
+ - `--dollar-amounts` global option flag
+
+## 1.6.1
+
+ - extensive option alias support throughout, with more on the way
+ - more extensive documentation in README, including subcommand descriptions. (still incomplete)
+ - add TOC in README
+
+## 1.6.0
+
+ - token creation correctly handles credit card params in any combination of individual options and --card=key:value pairs and still collects any missing params via interactive menu.
+ - any operation that accepts a credit card ID or token also accepts credit card parameters directly and incorporates the credit card interactive menu.
+ - improved option descriptions in all operations of all commands
+
+## 1.5.2
+
+ - tack **'/Stripe-CLI vX.X.X'** onto user-agent header of every api request
+   - **Disclaimer:** though I believe it to be completely harmless in this instance, this feature involves monkey-patching the `Stripe` module with an `alias_method_chain` style wrapper around `Stripe#request_headers`
+   - The Stripe Dashboard depends on the user-agent to distinguish the **source** of each api request
+   - this helps differentiate between requests made by application code and those made using the Stripe-CLI gem
+
+
+## 1.5.1
+
+ - fix unreported bug where Stripe::ListObjects were not displayed as simple arrays by awesome_print
+   - only present in conjunction with stripe-ruby version 1.14 and up
+   - due to a change in stripe-ruby by which `Stripe::StripeObject#to_hash` now calls itself recursivly
+   - resort to using `Object#instance_variable_get` to peek at a StripeObject's `@values` variable which already contains a hash of its attributes
+     - I am open to suggestions for a less brittle solution
+
+## 1.5.0
+
+ - Refunds as a top-level command
+
+## 1.4.6
+
+ - subscriptions `reactivate` subcommand
+ - `--at-period-end` flag added to `subscriptions cancel`
+ - `--refund-application-fee` flag added to `charges refund`
+ - add `--metadata` to the remaining subcommands that need it
+
+## 1.4.4
+
+ - `--receipt_email` and `--statement_description` options added to `charges create`
+
+## 1.4.3
+
+ - top-level `version` command for printing current gem version
+   - hidden from standard `help` banner
+   - aliased as `-v` and `--version`
+
+## 1.4.1
+
+ - per project config files (.stripecli)
+
+## 1.4.0
+
+ - credit cards as a top-level command
+   - for customers and recipients
+   - w/ actions: find, list, create, & delete
+
+## 1.3.0
+
+  - introduce multiple subscriptions per customer
+    - w/ actions: cancel, create, find, & list
+
+## 1.2.2
+
+  - introduce optional cursor-based pagination options to all `list` operations

data/example-configuration.stripecli

@@ -0,0 +1,14 @@
+default = test
+version = "2014-07-22"
+dollar_amounts = false
+
+[test]
+  key = sk_test_abc123def456ghi789jklmno
+
+[live]
+  key = sk_live_onmlkj987ihg654fed321cba
+
+[new-api]
+  key = sk_test_abc123def456ghi789jklmno
+  version = "2014-09-08"
+  dollar_amounts = true

data/lib/stripe/cli.rb

@@ -13,14 +13,14 @@ module Stripe
 
   # `alias_method_chain' style patch to tweek the user-agent header sent with every API request
   # Doing this adds context to request data that can be viewed using the Stripe Dashboard
-  # Differentiating requests made by application code from those made using the Stripe-CLI gem
+  # differentiating requests made by application code from those made using the Stripe-CLI gem
   class<<self
-    def add_stripe_cli_to_user_agent_string api_key
+    def cat_user_agent_string api_key
       user_agent = original_request_headers(api_key)[:user_agent]
       original_request_headers(api_key).update(:user_agent => user_agent<<"/Stripe-CLI v#{Stripe::CLI::VERSION}")
     end
     alias_method :original_request_headers, :request_headers
-    alias_method :request_headers, :add_stripe_cli_to_user_agent_string
-    private :request_headers
+    alias_method :request_headers, :cat_user_agent_string
+    private :cat_user_agent_string
   end
 end

data/lib/stripe/cli/command.rb

@@ -9,6 +9,7 @@ module Stripe
       class_option :key, :aliases => :k
       class_option :env, :aliases => :e
       class_option :version, :aliases => :v
+      class_option :dollar_amounts, :type => :boolean
 
       protected
 
@@ -24,6 +25,13 @@ module Stripe
         @env ||= options.delete(:env) || config['default']
       end
 
+      def dollar_amounts
+        convert_amount_to_dollars = options.delete(:dollar_amounts)
+        convert_amount_to_dollars.nil? ?
+        stored_api_option('dollar_amounts') == 'false' ?
+        false : true : convert_amount_to_dollars
+      end
+
       def stored_api_option option
         if File.exists?(config_file)
           if environment

data/lib/stripe/cli/commands/cards.rb

@@ -28,7 +28,7 @@ module Stripe
 
         desc "create", "create a new card for OWNER (customer or recipient)"
         option :card, :aliases => "--token", :desc => "credit card Token or ID. May also be created interactively."
-        option :card_number, :aliases => "--number"
+        option :card_number, :aliases => "--number", :desc => "credit card number. usually 16 digits long"
         option :card_exp_month, :aliases => "--exp-month", :desc => "Two digit expiration month of card"
         option :card_exp_year, :aliases => "--exp-year", :desc => "Four digit expiration year of card"
         option :card_cvc, :aliases => "--cvc", :desc => "Three or four digit security code located on the back of card"

data/lib/stripe/cli/commands/charges.rb

@@ -25,7 +25,7 @@ module Stripe
         option :metadata, :type => :hash, :desc => "a key/value store of additional user-defined data"
         option :refund_application_fee, :type => :boolean, :default => false, :desc => "Whether or not to refund the application fee"
         def refund charge_id
-          options[:amount] = (Float(options[:amount]) * 100).to_i if options[:amount]
+          options[:amount] = convert_amount(options[:amount]) if options[:amount]
           if charge = retrieve_charge(charge_id)
             request charge.refunds, :create, options
           end
@@ -39,21 +39,20 @@ module Stripe
         desc "create", "Create a charge"
         option :customer, :desc => "The ID of an existing customer to charge"
         option :card, :aliases => "--token", :desc => "credit card Token or ID. May also be created interactively."
-        option :card_number, :aliases => "--number"
+        option :card_number, :aliases => "--number", :desc => "credit card number. usually 16 digits long"
         option :card_exp_month, :aliases => "--exp-month", :desc => "Two digit expiration month of card"
         option :card_exp_year, :aliases => "--exp-year", :desc => "Four digit expiration year of card"
         option :card_cvc, :aliases => "--cvc", :desc => "Three or four digit security code located on the back of card"
         option :card_name, :aliases => "--name", :desc => "Cardholder's full name as displayed on card"
         option :amount, :type => :numeric, :desc => "Charge amount in dollars"
-        option :currency, :default => "usd"
+        option :currency, :default => "usd", :desc => "3-letter ISO code for currency"
         option :description, :desc => "Arbitrary description of charge"
         option :capture, :type => :boolean, :default => true, :desc => "Whether or not to immediately capture the charge. Uncaptured charges expire in 7 days"
         option :metadata, :type => :hash, :desc => "A key/value store of additional user-defined data"
         option :statement_description, :desc => "Displayed alongside your company name on your customer's card statement (15 character max)"
         option :receipt_email, :desc => "Email address to send receipt to. Overrides default email settings."
         def create
-          options[:amount] ||= ask('Amount in dollars:')
-          options[:amount] = (Float(options[:amount]) * 100).to_i
+          options[:amount] = convert_amount(options[:amount])
 
           options[:card] ||= credit_card( options ) unless options[:customer]
 

data/lib/stripe/cli/commands/customers.rb

@@ -34,7 +34,7 @@ module Stripe
         option :trial_end, :desc => "apply a trial period until this date. Override plan's trial period."
         option :account_balance, :desc => "customer's starting account balance in cents. A positive amount will be added to the next invoice while a negitive amount will act as a credit."
         option :card, :aliases => "--token", :desc => "credit card Token or ID. May also be created interactively."
-        option :card_number, :aliases => "--number"
+        option :card_number, :aliases => "--number", :desc => "credit card number. usually 16 digits long"
         option :card_exp_month, :aliases => "--exp-month", :desc => "Two digit expiration month of card"
         option :card_exp_year, :aliases => "--exp-year", :desc => "Four digit expiration year of card"
         option :card_cvc, :aliases => "--cvc", :desc => "Three or four digit security code located on the back of card"

data/lib/stripe/cli/commands/plans.rb

@@ -2,6 +2,7 @@ module Stripe
   module CLI
     module Commands
       class Plans < Command
+        include Stripe::Utils
 
         desc "list", "List plans"
         option :starting_after, :desc => "The ID of the last object in the previous paged result set. For cursor-based pagination."
@@ -33,8 +34,7 @@ module Stripe
         option :trial_period_days, :type => :numeric, :default => 0, :desc => "Number of days to delay a customer's initial bill"
         option :metadata, :type => :hash, :desc => "a key/value store of additional user-defined data"
         def create
-          options[:amount] ||= ask('Amount in dollars:')
-          options[:amount]   = (Float(options[:amount]) * 100).to_i
+          options[:amount]   = convert_amount(options[:amount])
           options[:name]   ||= ask('Plan name:')
           options[:id]     ||= ask('Plan id:')
 

data/lib/stripe/cli/commands/recipients.rb

@@ -38,7 +38,7 @@ module Stripe
         option :account_number
         option :routing_number
         option :card, :aliases => "--token", :desc => "credit card Token or ID. May also be created interactively."
-        option :card_number, :aliases => "--number"
+        option :card_number, :aliases => "--number", :desc => "credit card number. usually 16 digits long"
         option :card_exp_month, :aliases => "--exp-month", :desc => "Two digit expiration month of card"
         option :card_exp_year, :aliases => "--exp-year", :desc => "Four digit expiration year of card"
         option :card_cvc, :aliases => "--cvc", :desc => "Three or four digit security code located on the back of card"

data/lib/stripe/cli/commands/refunds.rb

@@ -31,7 +31,7 @@ module Stripe
         option :refund_application_fee, :type => :boolean, :default => false, :desc => "Whether or not to refund the application fee"
         option :charge, :aliases => :c, :required => true, :desc => "Id of charge to apply refund"
         def create
-          options[:amount] = (Float(options[:amount]) * 100).to_i if options[:amount]
+          options[:amount] = convert_amount(options[:amount]) if options[:amount]
           if charge = retrieve_charge(options.delete :charge)
             super charge.refunds, options
           end

data/lib/stripe/cli/commands/subscriptions.rb

@@ -31,7 +31,7 @@ module Stripe
         option :coupon, :desc => "id of a coupon to apply"
         option :trial_end, :desc => "apply a trial period until this date. Override plan's trial period."
         option :card, :aliases => "--token", :desc => "credit card Token or ID. May also be created interactively."
-        option :card_number, :aliases => "--number"
+        option :card_number, :aliases => "--number", :desc => "credit card number. usually 16 digits long"
         option :card_exp_month, :aliases => "--exp-month", :desc => "Two digit expiration month of card"
         option :card_exp_year, :aliases => "--exp-year", :desc => "Four digit expiration year of card"
         option :card_cvc, :aliases => "--cvc", :desc => "Three or four digit security code located on the back of card"

data/lib/stripe/cli/commands/tokens.rb

@@ -11,7 +11,7 @@ module Stripe
 
         desc "create TYPE", "create a new token of type TYPE(card or account)"
         option :card, :type => :hash, :default => {}, :desc => "hash of card params. may also be provided individually or added interactively."
-        option :card_number, :aliases => "--number"
+        option :card_number, :aliases => "--number", :desc => "credit card number. usually 16 digits long"
         option :card_exp_month, :aliases => "--exp-month", :desc => "Two digit expiration month of card"
         option :card_exp_year, :aliases => "--exp-year", :desc => "Four digit expiration year of card"
         option :card_cvc, :aliases => "--cvc", :desc => "Three or four digit security code located on the back of card"

data/lib/stripe/cli/commands/transfers.rb

@@ -2,6 +2,7 @@ module Stripe
   module CLI
     module Commands
       class Transfers < Command
+        include Stripe::Utils
 
         desc "list", "List transfers, optionaly filter by recipient or transfer status: ( pending paid failed )"
         option :starting_after, :desc => "The ID of the last object in the previous paged result set. For cursor-based pagination."
@@ -33,8 +34,7 @@ module Stripe
           if options.delete(:balance) == true
             options[:amount] = Stripe::Balance.retrieve(api_key).available.first.amount
           else
-            options[:amount] ||= ask('Amount in Dollars:')
-            options[:amount] = (Float(options[:amount]) * 100).to_i
+            options[:amount] = convert_amount(options[:amount])
           end
 
           if options.delete(:self) == true

data/lib/stripe/cli/version.rb

@@ -1,5 +1,5 @@
 module Stripe
   module CLI
-    VERSION = "1.6.1"
+    VERSION = "1.6.3"
   end
 end

data/lib/stripe/utils.rb

@@ -7,10 +7,10 @@ module Stripe
       card = options.delete(:card) || {}
       {
         :name      => card["name"]      || options.delete(:card_name)      || ask('Name on Card:'),
-        :number    => card["number"]    || options.delete(:card_number)    || ask('Card number:'),
+        :number    => card["number"]    || options.delete(:card_number)    || ask('Card Number:'),
         :cvc       => card["cvc"]       || options.delete(:card_cvc)       || ask('CVC code:'),
-        :exp_month => card["exp-month"] || options.delete(:card_exp_month) || ask('expiration month:'),
-        :exp_year  => card["exp-year"]  || options.delete(:card_exp_year)  || ask('expiration year:')
+        :exp_month => card["exp-month"] || options.delete(:card_exp_month) || ask('Expiration Month:'),
+        :exp_year  => card["exp-year"]  || options.delete(:card_exp_year)  || ask('Expiration Year:')
       }
     end
 
@@ -23,6 +23,14 @@ module Stripe
       }
     end
 
+    def convert_amount amount
+      if dollar_amounts
+        (Float(amount||ask('Amount In Dollars:')) * 100).to_i
+      else
+        amount||ask('Amount In Cents:')
+      end
+    end
+
     def retrieve_customer id
       begin
         ::Stripe::Customer.retrieve(id, api_key)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stripe-cli
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.6.3
 platform: ruby
 authors:
 - Alex MacCaw
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-04 00:00:00.000000000 Z
+date: 2014-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -162,7 +162,8 @@ files:
 - README.md
 - Rakefile
 - bin/stripe
-- example.conf
+- changelog.md
+- example-configuration.stripecli
 - lib/stripe/cli.rb
 - lib/stripe/cli/command.rb
 - lib/stripe/cli/commands.rb

data/example.conf

@@ -1,9 +0,0 @@
-default = "test"
-version = "2013-08-13"
-
-[test]
-  key = "test_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
-
-[live]
-  key = "live_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
-  version = "2013-02-13"