API Documentation
\
ctala
Baremetrics

\ctala\BaremetricsBareMetrics

Summary

Methods
Properties
Constants
__construct()
setOps()
checkAuth()
listResources()
getAccount()
createPlan()
getPlans()
deletePlan()
listCustomers()
showCustomer()
listCustomerEvents()
updateCustomer()
createCustomer()
deleteCustomer()
listSubscriptions()
showSubscriptions()
updateSubscription()
cancelSubscription()
createSubscription()
deleteSubscription()
listCharges()
showCharge()
createCharge()
showSummary()
checkResponse()
$curl
$url
LIVE_API_URL
SANDBOX_API_URL
API_VERSION
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Constants

LIVE_API_URL

LIVE_API_URL = https://api.baremetrics.com

SANDBOX_API_URL

SANDBOX_API_URL = https://api-sandbox.baremetrics.com

API_VERSION

API_VERSION = v1

Properties

$curl

$curl :

Type

$url

$url :

Type

Methods

__construct()

__construct(\ctala\Baremetrics\type  bearerKey, \ctala\Baremetrics\type  sandbox = false,  ops = array())

Parameters

\ctala\Baremetrics\type bearerKey
\ctala\Baremetrics\type sandbox
ops

setOps()

setOps(\ctala\Baremetrics\type  ops = array())

Parameters

\ctala\Baremetrics\type ops

checkAuth()

checkAuth()

listResources()

listResources()

getAccount()

getAccount()

createPlan()

createPlan( sourceId,  ops = array())

Parameters

sourceId
ops

getPlans()

getPlans( sourceId)

Parameters

sourceId

deletePlan()

deletePlan( sourceId,  oid)

Parameters

sourceId
oid

listCustomers()

listCustomers( sourceId)

Parameters

sourceId

showCustomer()

showCustomer( sourceId,  oid)

Parameters

sourceId
oid

listCustomerEvents()

listCustomerEvents( sourceId,  oid)

Parameters

sourceId
oid

updateCustomer()

updateCustomer( sourceId,  oid,  userData = array())

Parameters

sourceId
oid
userData

createCustomer()

createCustomer( sourceId,  userData = array())

Parameters

sourceId
userData

deleteCustomer()

deleteCustomer( sourceId,  oid)

Parameters

sourceId
oid

listSubscriptions()

listSubscriptions( sourceId,  query = array())

Parameters

sourceId
query

showSubscriptions()

showSubscriptions( sourceId,  oid)

Parameters

sourceId
oid

updateSubscription()

updateSubscription( sourceId,  subscriptionOid,  planOid,  planParams = array())

Parameters

sourceId
subscriptionOid
planOid
planParams

cancelSubscription()

cancelSubscription( sourceId,  oid,  params = array())

Parameters

sourceId
oid
params

createSubscription()

createSubscription( sourceId,  params = array())

Parameters

sourceId
params

deleteSubscription()

deleteSubscription( sourceId,  oid)

Parameters

sourceId
oid

listCharges()

listCharges( sourceId)

Parameters

sourceId

showCharge()

showCharge( sourceId,  oid)

Parameters

sourceId
oid

createCharge()

createCharge( sourceId,  params = array())

Parameters

sourceId
params

showSummary()

showSummary( start_date = null,  end_date = null)

Parameters

start_date
end_date

checkResponse()

checkResponse()