How to access your stripe data on dashDB

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.
3. Double click on the dashDB service icon.
4. Click Launch. The dashDB: Home screen is displayed in a new browser window.
5. Select the Tables tab from the menu on the left hand side.
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.

---

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.
3. Double click on the application icon.
4. Locate the dashDB service entry icon and click on the Show Credentials link.
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.

---

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. Note that table names and column names are defined using lower case characters.

Customer

• Description: Identifies a customer
• Table name: DASH___.st_customer
• Referenced tables:
  • DASH___.st_customer_sources_data
  • DASH___.st_customer_subscriptions_data
  • DASH___.st_customer_overflow
• Stripe object type definition:
  • https://stripe.com/docs/api#customer_object
• Stripe data columns

Column name	Data type	Description
id	VARCHAR	unique customer ID (assigned by stripe)
email	VARCHAR	customer's email address
created	BIGINT	date when the customer account was created
description	VARCHAR	customer description
account_balance	BIGINT	customer's current outstanding balance
default_source	VARCHAR	ID of default payment source
delinquent	INTEGER	? = the latest charge for the customer's invoice has failed
metadata	TBD	optional information about the customer

• Metada columns

Column name	Data type	Description
_id	VARCHAR	ignore/internal data pipe use only
_rev	VARCHAR	ignore/internal data pipe use only
live_mode	INTEGER	0 = this is test data
object	VARCHAR	value is always "customer"
sources_has_more	INTEGER	0 if not all of the customer's payment sources have been loaded into the DASH___.st_sources_data table
sources_object	VARCHAR	value is always "list"
sources_total_count	BIGINT	total number of payment sources this customer has provided
sources_url	VARCHAR	stripe API URL that can be used to fetch the customer's payment source
subscriptions_has_more	INTEGER	0 if not all of the customer's subscriptions have been loaded into the DASH___.st_customer_subscriptions_data table
subscriptions_object	VARCHAR	value is always "list"
subscriptions_total_count	BIGINT	total number of payment sources this customer has provided
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
• Stripe object type definition:
  • https://stripe.com/docs/api#card_object
• Stripe data columns

Column name	Data type	Description
id	VARCHAR	unique card ID (assigned by stripe)
brand	VARCHAR	card brand
exp_month	BIGINT	card's expiration month
exp_year	BIGINT	card's expiration year
funding	VARCHAR	card funding type
last4	VARCHAR	last 4 digits of card number
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
country	VARCHAR	card's billing country code
cvc_check	VARCHAR	refer to stripe doc
dynamic_last4	VARCHAR	see stripe doc
name	VARCHAR	cardholder name
tokenization_method	VARCHAR	refer to stripe doc
fingerprint	VARCHAR	refer to stripe doc
recipient	VARCHAR	refer to stripe doc
customer	VARCHAR	refer to stripe doc
metadata	TBD	optional information about the card

• Metada columns

Column name	Data type	Description
_id	VARCHAR	foreign key id in DASH__.st_customer
array_index	INTEGER	ignore/internal data pipe use only

Subscriptions

• Description: Identifies to which plans a customer has subscribed to
• Table name: DASH___.st_customer_subscriptions_data
• Stripe object type definitions:
  • https://stripe.com/docs/api#subscription_object
  • https://stripe.com/docs/api#plan_object
• Stripe data columns

Column name	Data type	Description
id	VARCHAR	unique subscription ID
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	customer's ID (references DASH___.st_customer.id)
plan_created	BIGINT	date when the subscription plan was created
plan_currency	VARCHAR	subscription plan currency
plan_id	VARCHAR	unique subscription plan ID in DASH___.st_plan.id
plan_interval	VARCHAR	subscription plan billing interval
plan_interval_count	BIGINT	subscription plan interval count
plan_amount	BIGINT	subscription plan amount
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	?TODO?	optional information about the subscription plan
trial_start	BIGINT	trial begin date
trial_end	BIGINT	trial end date
quantity	BIGINT	number of subscriptions
start	BIGINT	subscription start date
status	VARCHAR	see https://stripe.com/docs/api#subscription_object
ended_at	?TODO?	the end of the subscription (if it has ended)
disount	?TODO?	discount applied to this subscription
tax_percent	?TODO?	tax rate for this subscription (in percent)
application_fee_percent	?TODO?	see https://stripe.com/docs/api#subscription_object
canceled_at	?TODO?	date when the subscription has been canceled
metadata	?TODO?	optional information about this subscription

• Metada columns

Column name	Data type	Description
_id	VARCHAR	foreign key id in DASH__.st_customer
array_index	INTEGER	ignore/internal data pipe use only
object	varchar	value is always "subscription"
plan_livemode	INTEGER	0 = this plan is test data
plan_object	VARCHAR	value is always "plan"

Subscription plan

• Description: Identifies available subscription plans
• Table name: DASH___.st_plan
• Stripe object type definition:
  • https://stripe.com/docs/api#plan_object
• Stripe data columns

Column name	Data type	Description
id	VARCHAR	unique subcription
name	VARCHAR	subscription plan name
amount	BIGINT	subscription plan amount (in currency)
statement_descriptor	VARCHAR	subscription plan descriptor
created	BIGINT	date when the subscription plan was created
currency	VARCHAR	subscription plan currency
interval	VARCHAR	subscription plan billing interval
interval_count	BIGINT	subscription plan interval count
metadata	?TODO?	optional information about the subscription plan
trial_period_days	BIGINT	number of trial period days

• 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"
livemode	INTEGER	0 = this is test data

Invoice

• Description: TODO
• Table name: DASH___.st_invoice
• Stripe object type definition:
  • https://stripe.com/docs/api#invoice_object
• Stripe data columns

Column name	Data type	Description
TODO	VARCHAR	TODO

• Metadata columns

Column name	Data type	Description
TODO	VARCHAR	TODO

Account

• Descriptions: Contains information about your stripe.com account
• Table name: DASH___.st_account
• Stripe object type definition:
  • https://stripe.com/docs/api#account_object
• Stripe data columns

Column name	Data type	Description
TODO	VARCHAR	TODO

• Metadata columns

Column name	Data type	Description
TODO	VARCHAR	TODO

Coupon

• Description: Defines discounts that customers can apply
• Table name: DASH___.st_coupon
• Stripe object type definition:
  • https://stripe.com/docs/api#coupon_object
• Stripe data columns

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	?TODO?	optional information about 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

• 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

• Description: A discount is a coupon that has been applied to a customer.
• Table name: DASH___.st_discount
• Stripe object type definition:
  • https://stripe.com/docs/api#discount_object
  • https://stripe.com/docs/api#coupon_object
• Stripe data columns

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	?TODO?	optional information about 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

• 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

• Description: TODO
• Table name: DASH___.st_event
• Stripe object type definition:
  • https://stripe.com/docs/api#event_object
• Stripe data columns

Column name	Data type	Description
TODO	VARCHAR	https://stripe.com/docs/api#event_object

• Metadata columns

Column name	Data type	Description
TODO	VARCHAR	https://stripe.com/docs/api#event_object