cbstripe

Class Stripe

lucee.Component
    extended by cbstripe.Stripe
Class Attributes:
  • synchronized : false
  •  
  • accessors : true
  •  
  • persistent : false
  •  
    Property Summary
    type property default serializable required
    any gatewayBaseUrl


    • access = public
    • returntype = any
    true false
    any secretKey


    • access = public
    • returntype = any
    true false
    Constructor Summary
    init([string gatewayBaseUrl='https://api.stripe.com/v1/'], [string secretKey=''])
    Method Summary
    any cancelSubscription([any id], [any plan], [any at_period_end='false'])
    any createCard(string number, any exp_month, any exp_year, [any cvc=''], [any name=''], [any address_line1=''], [any address_line2=''], [any address_zip=''], [any address_state=''], [any address_country=''])
    any createCharge(any money, any card, [string description=''])
    any createCoupon([any id], [any percent_off], [any duration], [any duration_in_months=''], [any max_redemptions=''], [any redeem_by=''])
    any createCustomer([any card], [string coupon=''], [string email=''], [string description=''], [string plan=''], [any trial_end=''])
    any createInvoiceItem(any customer, Money money, any description)
    any createMoney(numeric cents, [any currency='usd'])
    any createPlan(string id, Money money, any interval, any name, [any trial_period_days])
    any createToken(any card, [Money money])
    any dateToUTC(any date)
    any deleteCoupon(string id)
    any deleteInvoiceItem(string id)
    any deletePlan(string id)
    any doHttp([string url], [struct payload], [string method='post'])
    string getGatewayBaseUrl()
    string getSecretKey()
    any getVersion()
    any listCharges([numeric count='10'])
    any listCoupons([numeric count='10'])
    any listCustomers([numeric count='10'])
    any listInvoiceItems([numeric count='10'])
    any listInvoices([numeric count='10'])
    any listPlans([numeric count='10'])
    any process([string gatewayUrl], [struct payload], [any method='post'])
    any refundCharge(string id, [numeric amount])
    any retrieveCharge(string id)
    any retrieveCoupon(string id)
    any retrieveCustomer(string id)
    any retrieveInvoice(string id)
    any retrieveInvoiceItem(string id)
    any retrievePlan(string id)
    any retrieveToken(string id)
    any retrieveUpcomingInvoice(string customer)
    any setGatewayBaseUrl(any gatewayBaseUrl)
    any setSecretKey(any secretKey)
    any updateCustomer(string id, [string email], [string description])
    any updateInvoiceItem(string id, Money money, string description)
    any updateSubscription([any id], [any plan], [any prorate='true'], [any trial_end=''], [any card=''])
    any UTCToDate([any utcDate])
     
    Methods inherited from class lucee.Component
    None

    Constructor Detail

    init

    public init([string gatewayBaseUrl='https://api.stripe.com/v1/'], [string secretKey=''])

    Parameters:
    gatewayBaseUrl
    secretKey

    Property Detail

    gatewayBaseUrl

    property any gatewayBaseUrl

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    secretKey

    property any secretKey

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    Method Detail

    cancelSubscription

    public any cancelSubscription([any id], [any plan], [any at_period_end='false'])

    Parameters:
    id
    plan
    at_period_end

    createCard

    public any createCard(string number, any exp_month, any exp_year, [any cvc=''], [any name=''], [any address_line1=''], [any address_line2=''], [any address_zip=''], [any address_state=''], [any address_country=''])

    Parameters:
    number
    exp_month
    exp_year
    cvc
    name
    address_line1
    address_line2
    address_zip
    address_state
    address_country

    createCharge

    public any createCharge(any money, any card, [string description=''])

    Parameters:
    money
    card
    description

    createCoupon

    public any createCoupon([any id], [any percent_off], [any duration], [any duration_in_months=''], [any max_redemptions=''], [any redeem_by=''])

    Parameters:
    id
    percent_off
    duration
    duration_in_months
    max_redemptions
    redeem_by

    createCustomer

    public any createCustomer([any card], [string coupon=''], [string email=''], [string description=''], [string plan=''], [any trial_end=''])

    Parameters:
    card
    coupon
    email
    description
    plan
    trial_end

    createInvoiceItem

    public any createInvoiceItem(any customer, Money money, any description)

    Parameters:
    customer
    money
    description

    createMoney

    public any createMoney(numeric cents, [any currency='usd'])

    Parameters:
    cents
    currency

    createPlan

    public any createPlan(string id, Money money, any interval, any name, [any trial_period_days])

    Parameters:
    id
    money
    interval
    name
    trial_period_days

    createToken

    public any createToken(any card, [Money money])

    Parameters:
    card
    money

    dateToUTC

    public any dateToUTC(any date)

    Parameters:
    date

    deleteCoupon

    public any deleteCoupon(string id)

    Parameters:
    id

    deleteInvoiceItem

    public any deleteInvoiceItem(string id)

    Parameters:
    id

    deletePlan

    public any deletePlan(string id)

    Parameters:
    id

    doHttp

    public any doHttp([string url], [struct payload], [string method='post'])

    Parameters:
    url
    payload
    method

    getGatewayBaseUrl

    public string getGatewayBaseUrl()


    getSecretKey

    public string getSecretKey()


    getVersion

    public any getVersion()


    listCharges

    public any listCharges([numeric count='10'])

    Parameters:
    count

    listCoupons

    public any listCoupons([numeric count='10'])

    Parameters:
    count

    listCustomers

    public any listCustomers([numeric count='10'])

    Parameters:
    count

    listInvoiceItems

    public any listInvoiceItems([numeric count='10'])

    Parameters:
    count

    listInvoices

    public any listInvoices([numeric count='10'])

    Parameters:
    count

    listPlans

    public any listPlans([numeric count='10'])

    Parameters:
    count

    process

    public any process([string gatewayUrl], [struct payload], [any method='post'])

    Parameters:
    gatewayUrl
    payload
    method

    refundCharge

    public any refundCharge(string id, [numeric amount])

    Parameters:
    id
    amount

    retrieveCharge

    public any retrieveCharge(string id)

    Parameters:
    id

    retrieveCoupon

    public any retrieveCoupon(string id)

    Parameters:
    id

    retrieveCustomer

    public any retrieveCustomer(string id)

    Parameters:
    id

    retrieveInvoice

    public any retrieveInvoice(string id)

    Parameters:
    id

    retrieveInvoiceItem

    public any retrieveInvoiceItem(string id)

    Parameters:
    id

    retrievePlan

    public any retrievePlan(string id)

    Parameters:
    id

    retrieveToken

    public any retrieveToken(string id)

    Parameters:
    id

    retrieveUpcomingInvoice

    public any retrieveUpcomingInvoice(string customer)

    Parameters:
    customer

    setGatewayBaseUrl

    public any setGatewayBaseUrl(any gatewayBaseUrl)

    Parameters:
    gatewayBaseUrl

    setSecretKey

    public any setSecretKey(any secretKey)

    Parameters:
    secretKey

    updateCustomer

    public any updateCustomer(string id, [string email], [string description])

    Parameters:
    id
    email
    description

    updateInvoiceItem

    public any updateInvoiceItem(string id, Money money, string description)

    Parameters:
    id
    money
    description

    updateSubscription

    public any updateSubscription([any id], [any plan], [any prorate='true'], [any trial_end=''], [any card=''])

    Parameters:
    id
    plan
    prorate
    trial_end
    card

    UTCToDate

    public any UTCToDate([any utcDate])

    Parameters:
    utcDate