R/balance.R

In RStripe: A Convenience Interface for the Stripe Payment API

# --------------------------------------------------
# Balance
# --------------------------------------------------

#' Retrieve Stripe Account Balance.
#'
#' Retrieve the balance of your stripe account.
#'
#' @param api_key Your Stripe API Key
#'
#' @return A data frame with your account balance
#'
#' @export
#'
stripe_retrieve_balance <- function(api_key) {
    link <- paste0("https://api.stripe.com/v1/balance")
    .get(api_key, link)
}

#' Retrieve a Stripe Account Balance transaction.
#'
#' Retrieve information about a transaction on your account.
#'
#' @param api_key Your Stripe API Key
#'
#' @param transaction_id A stripe you want to get information about.
#'
#' @return A data frame with balance transaction information if succeeded.
#'
#' @export
#'
stripe_retrieve_balance_transaction <- function(api_key, transaction_id) {
    link <- paste0("https://api.stripe.com/v1/balance/history/", transaction_id)
    .get(api_key, link)
}

#' Retrieve a Stripe Account Balance History.
#'
#' Retrieve the history of your account balance.
#'
#' @param api_key Your Stripe API Key
#'
#' @param args optional list which can include
#' \describe{
#'    \item{available_on}{\emph{optional:} Filter on date with unix timestamp.}
#'    \item{ending_before}{\emph{optional:} An object id which will show objects before}
#'    \item{limit}{\emph{optional:} A number 1 to 100 to limit the items.  Default is 10}
#'    \item{source}{\emph{optional:} Only returns transactions aassociated with ID.}
#'    \item{transfer}{\emph{optional:} Only returns transactions aassociated with transfer.}
#'    \item{starting_after}{\emph{optional:} An object id which will show objects starting here}
#'    \item{type}{\emph{optional:} Type: 'charge', 'refund', 'adjustment', 'application_fee'
#'                'application_fee_refund', 'transfer', or 'transfer_failure'}
#'    \item{currency}{\emph{optional:} 3 letter ISO}
#' }
#'
#' @return A data frame with balance history information if succeeded.
#'
#' @export
#'
stripe_balance_history <- function(api_key, args=NULL) {
    args <- .convert_to_url(args)
    link <- paste0("https://api.stripe.com/v1/balance/history", args)
    .get(api_key, link)
}