Skip to content
This repository was archived by the owner on Feb 7, 2018. It is now read-only.

How to access your stripe data on dashDB

Jump to bottom
Patrick Titzler edited this page Sep 10, 2015 · 22 revisions

Accessing your Stripe.com data in dashDB

To access your stripe data in dashDB you can use the DashDB web console in Bluemix or connect your favorite third party application to the database.

Accessing your stripe data using the dashDB web console

  1. Direct your web browser to https://console.ng.bluemix.net/ and log in using your IBM ID.
  2. Open the DASHBOARD and locate the dashDB service that your data pipes application is bound to. The service is named pipes-dashdb-service by default. Locate the dashDB service instance for the pipes application
  3. Double click on the dashDB service icon.
  4. Click Launch. The dashDB: Home screen is displayed in a new browser window. Open the dashDB home screen
  5. Select the Tables tab from the menu on the left hand side. Locate the dashDB service instance for the pipes application
  6. Select the DASH_____ schema and open the Table Name dropdown. Your stripe data is stored in tables named st_<stripe_object_type>. Refer to the reference below for detailed information. Stripe data tables in dashDB

Accessing your Stripe.com data using a third-party tool

  1. Direct your web browser to https://console.ng.bluemix.net/ and log in using your IBM ID.
  2. Open the DASHBOARD and locate the pipes application. Locate the pipes application on the Bluemix dashboard
  3. Double click on the application icon.
  4. Locate the dashDB service entry icon and click on the Show Credentials link. Access the dashDB connectivity information
  5. Use the displayed information in your favorite third-party application to access your stripe data, which is stored in tables named st_<stripe_object_type>. Refer to the reference below for detailed information. View dashDB connectivity information

Stripe data reference

The pipes application utilizes the Stripe API to fetch billing information from your account. This information is represented by objects, which are documented at https://stripe.com/docs/api. Each Stripe object maps to one or more tables in your dashDB on Bluemix.

Notes:

  • DashDB table names and column names are defined using lower case characters.
  • Unique stripe identifiers are highlighted in bold font.
  • DashDB column data types are derived by sampling your stripe data. Therefore the actual data type in your tables might be slightly different.
  • Columns are listed in this reference in alphabetical order.

Customer

  • Description: Identifies a customer
  • Table name: DASH___.st_customer
  • Referenced tables:
    • DASH___.st_customer_overflow (review for DataWorks error or warning messages)
    • DASH___.st_customer_sources_data
    • DASH___.st_customer_subscriptions_data
  • Stripe object type definition:
  • Stripe data columns
Column name Data type Description
account_balance BIGINT customer's current outstanding balance
created BIGINT date when the customer account was created
currency VARCHAR the currency in which the customer can be billed in
default_source VARCHAR ID of default payment source (see https://stripe.com/docs/api#card_object)
delinquent INTEGER 0 = the latest charge for the customer's invoice did not fail
description VARCHAR customer description
discount_coupon_created BIGINT date when the coupon was created
discount_coupon_duration VARCHAR 'forever', 'once', or 'repeating'
discount_coupon_id VARCHAR ID of the applied coupon (see https://stripe.com/docs/api#discount_object)
discount_coupon_livemode INTEGER 0 = this is a test data discount
discount_coupon_max_redemptions BIGINT maximum times the discount can be applied
discount_coupon_percent_off BIGINT customer discount (in %)
discount_coupon_redeem_by BIGINT discount expiration date
discount_coupon_times_redeemed BIGINT number of times the discount has been applied
discount_coupon_valid INTEGER 1 = the discount is still valid
discount_customer BIGINT same as id
discount_start BIGINT date that the discount was applied
email VARCHAR customer's email address
id VARCHAR unique customer ID (assigned by stripe)
live_mode INTEGER 0 = this is a test data customer
metadata* varies optional information about this customer; the number of metadata columns depends on the number of metadata properties that have been defined for the customer
sources_has_more INTEGER 0 = all of this customer's payment sources have been loaded into the DASH___.st_sources_data table
sources_total_count BIGINT total number of payment sources this customer has provided
subscriptions_has_more INTEGER 0 = all of the customer's subscriptions have been loaded into the DASH___.st_customer_subscriptions_data table
subscriptions_total_count BIGINT total number of active subscriptions for this customer
  • Stripe metadata columns
Column name Data type Description
_id VARCHAR ignore/internal data pipe use only
_rev VARCHAR ignore/internal data pipe use only
discount_coupon_object VARCHAR value is always "coupon"
discount_object VARCHAR value is always "discount"
object VARCHAR value is always "customer"
sources_object VARCHAR value is always "list"
sources_url VARCHAR stripe API URL that can be used to fetch the customer's payment source
subscriptions_object VARCHAR value is always "list"
subscriptions_url VARCHAR stripe API URL that can be used to fetch the customer's payment source

Customer payment sources

  • Description: contains the payment sources (credit cards, debit cards, ...) customers have provided
  • Table name: DASH___.st_customer_sources_data
  • Referenced tables:
    • DASH___.st_customer
    • DASH___.st_customer_subscriptions_data
  • Stripe object type definition:
  • Stripe data columns
Column name Data type Description
adress_city VARCHAR card's billing city
adress_country VARCHAR card's billing country
adress_line1 VARCHAR card's 1st address line
adress_line1_check VARCHAR see stripe doc
adress_line2 VARCHAR card's 2nd address line
adress_state VARCHAR card's billing state
adress_zip VARCHAR card's billing ZIP code
adress_zip_check VARCHAR refer to stripe doc
brand VARCHAR card brand
country VARCHAR card's billing country code
customer VARCHAR unique customer ID (assigned by stripe); same as id column in table st_customer
cvc_check VARCHAR refer to stripe doc
dynamic_last4 VARCHAR see stripe doc
exp_month BIGINT card's expiration month
exp_year BIGINT card's expiration year
fingerprint VARCHAR refer to stripe doc
funding VARCHAR card funding type
id VARCHAR unique card ID (assigned by stripe)
last4 VARCHAR last 4 digits of card number
metadata* varies optional information about this card; the number of metadata columns depends on the number of metadata properties that have been defined for the card
name VARCHAR cardholder name
recipient VARCHAR refer to stripe doc
tokenization_method VARCHAR refer to stripe doc
  • Stripe metadata columns
Column name Data type Description
_id VARCHAR ignore/internal data pipe use only
array_index INTEGER ignore/internal data pipe use only
object VARCHAR value is always "card"

Subscriptions

Column name Data type Description
application_fee_percent ?TODO? see https://stripe.com/docs/api#subscription_object
canceled_at ?TODO? date when the subscription has been canceled
cancel_at_period_end INTEGER see https://stripe.com/docs/api#subscription_object
current_period_end BIGINT see https://stripe.com/docs/api#subscription_object
current_period_start BIGINT see https://stripe.com/docs/api#subscription_object
customer VARCHAR unique customer ID (assigned by stripe); same as id column in table st_customer
discount ?TODO? discount applied to this subscription
ended_at ?TODO? the end of the subscription (if it has ended)
id VARCHAR unique subscription ID (assigned by stripe)
metadata* varies optional information about this subscription; the number of metadata columns depends on the number of metadata properties that have been defined for the subscription
plan_amount BIGINT subscription plan amount
plan_created BIGINT date when the subscription plan was created
plan_currency VARCHAR subscription plan currency
plan_id VARCHAR unique plan ID (assigned by stripe); same as id column in table st_plan
plan_interval VARCHAR subscription plan billing interval
plan_interval_count BIGINT subscription plan interval count
plan_livemode INTEGER 0 = this plan is test data
plan_name VARCHAR subscription plan name
plan_statement_descriptor VARCHAR subscription plan descriptor
plan_trial_period_days BIGINT number of trial period days
plan_metadata* varies optional information about this subscription plan; the number of plan_metadata columns depends on the number of metadata properties that have been defined for the subscription plan
quantity BIGINT number of subscriptions
start BIGINT subscription start date
status VARCHAR see https://stripe.com/docs/api#subscription_object
tax_percent BIGINT tax rate for this subscription (in percent)
trial_end BIGINT trial end date
trial_start BIGINT trial begin date
  • Stripe metadata columns
Column name Data type Description
_id VARCHAR ignore/internal data pipe use only
array_index INTEGER ignore/internal data pipe use only
object varchar value is always "subscription"
plan_object VARCHAR value is always "plan"

Subscription plan

Column name Data type Description
amount BIGINT subscription plan amount (in currency)
created BIGINT date when the subscription plan was created
currency VARCHAR subscription plan currency
id VARCHAR unique subscription plan ID (assigned by stripe)
interval VARCHAR subscription plan billing interval
interval_count BIGINT subscription plan interval count
livemode INTEGER 0 = this is test data
metadata* varies optional information about this subscription plan; the number of metadata columns depends on the number of metadata properties that have been defined for the subscription plan
name VARCHAR subscription plan name
statement_descriptor VARCHAR subscription plan descriptor
trial_period_days BIGINT number of trial period days
  • Stripe metadata columns
Column name Data type Description
_id VARCHAR ignore/internal data pipe use only
_rev VARCHAR ignore/internal data pipe use only
object varchar value is always "plan"

Invoice

Column name Data type Description
TODO VARCHAR TODO
  • Stripe metadata columns
Column name Data type Description
TODO VARCHAR TODO

Invoice Item

  • Description: See stripe documentation
  • Table name: DASH___.st_invoiceitem
  • Referenced tables:
    • DASH___.st_customer
    • DASH___.st_invoice
    • DASH___.st_invoiceitem_overflow
  • Stripe object type definition:
  • Stripe data columns
Column name Data type Description
amount BIGINT amount
currency VARCHAR currency of amount
customer VARCHAR unique customer ID (assigned by stripe); same as id column in table st_customer
date BIGINT invoice item date
description VARCHAR invoice item description
discountable INTEGER 1 = yes
id VARCHAR unique invoice item ID (assigned by stripe), same as _id_column in table st_invoice
livemode INTEGER 0 = this is a test data invoice item
period start BIGINT ?
period end BIGINT ?
proration INTEGER ?
  • Stripe metadata columns
Column name Data type Description
_id VARCHAR ignore/internal data pipe use only
_rev VARCHAR ignore/internal data pipe use only
object VARCHAR value is always "invoiceitem"

Account

Column name Data type Description
TODO VARCHAR TODO
  • Stripe metadata columns
Column name Data type Description
TODO VARCHAR TODO

Coupon

Column name Data type Description
id VARCHAR unique coupon ID (assigned by stripe)
created BIGINT coupon creation date
duration VARCHAR unit indicating for how long the coupon is valid
duration_in_month BIGINT the duration for multi-month coupons
max_redemptions BIGINT number of times this coupon can be applied
percent_off BIGINT discount to be applied in percent
amount_off BIGINT discount to be applied in currency
currency VARCHAR the currency of amount_off
metadata* varies optional information about this coupon; the number of metadata columns depends on the number of metadata properties that have been defined for the coupon
times_redeemed BIGINT number of times the coupon has been used
valid INTEGER indicates whether the coupon can still be applied
redeem_by BIGINT expiration date
  • Stripe metadata columns
Column name Data type Description
_id VARCHAR ignore/internal data pipe use only
_rev VARCHAR ignore/internal data pipe use only
object VARCHAR value is always "coupon"
livemode INTEGER 0 = this is test data

Discount

Column name Data type Description
customer VARCHAR customer ID to which this discount has been applied
coupon_id VARCHAR unique coupon ID (assigned by stripe)
coupon_created BIGINT coupon creation date
coupon_duration VARCHAR unit indicating for how long the coupon is valid
coupon_duration_in_month BIGINT the duration for multi-month coupons
coupon_max_redemptions BIGINT number of times this coupon can be applied
coupon_percent_off BIGINT discount to be applied in percent
coupon_amount_off BIGINT discount to be applied in currency
coupon_currency VARCHAR the currency of amount_off
coupon_metadata* varies optional information about this coupon; the number of coupon_metadata columns depends on the number of metadata properties that have been defined for the coupon
coupon_times_redeemed BIGINT number of times the coupon has been used
coupon_valid INTEGER indicates whether the coupon can still be applied
coupon_redeem_by BIGINT expiration date
subscription VARCHAR indicates to which subscription the coupon was applied to
start BIGINT date when the coupon was applied
end BIGINT see https://stripe.com/docs/api#discount_object
  • Stripe metadata columns
Column name Data type Description
object VARCHAR value is always "discount"
coupon_object VARCHAR value is always "coupon"
coupon_livemode INTEGER 0 = this is test data

Event

Column name Data type Description
TODO VARCHAR https://stripe.com/docs/api#event_object
  • Stripe metadata columns
Column name Data type Description
TODO VARCHAR https://stripe.com/docs/api#event_object
Clone this wiki locally