Skip to content

Commit e21c449

Browse files
jnr0790Juan RomeroAmruta-Ranade
authored
update docs with details about amount column changes in charges stream (#14917)
* update docs with details about amount column changes in charges stream * update docs with details about amount column changes in charges stream Co-authored-by: Juan Romero <[email protected]> Co-authored-by: Amruta Ranade <[email protected]>
1 parent 0363de2 commit e21c449

File tree

1 file changed

+38
-39
lines changed

1 file changed

+38
-39
lines changed

docs/integrations/sources/stripe.md

Lines changed: 38 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -2,34 +2,35 @@
22

33
This page guides you through the process of setting up the Stripe source connector.
44

5-
## Prerequisites
5+
## Prerequisites
66

7-
* Your [Stripe `Account ID`](https://dashboard.stripe.com/settings/account)
8-
* Your [Stripe `Secret Key`](https://dashboard.stripe.com/apikeys)
7+
- Your [Stripe `Account ID`](https://dashboard.stripe.com/settings/account)
8+
- Your [Stripe `Secret Key`](https://dashboard.stripe.com/apikeys)
99

10-
## Set up the Stripe source connector
10+
## Set up the Stripe source connector
1111

1212
1. Log into your [Airbyte Cloud](https://cloud.airbyte.io/workspaces) or Airbyte OSS account.
13-
2. Click **Sources** and then click **+ New source**.
13+
2. Click **Sources** and then click **+ New source**.
1414
3. On the Set up the source page, select **Stripe** from the Source type dropdown.
1515
4. Enter a name for your source.
1616
5. For **Account ID**, enter your [Stripe `Account ID`](https://dashboard.stripe.com/settings/account).
1717
6. For **Secret Key**, enter your [Stripe `Secret Key`](https://dashboard.stripe.com/apikeys)
18-
19-
We recommend creating a secret key specifically for Airbyte to control which resources Airbyte can access. For ease of use, we recommend granting read permission to all resources and configuring which resource to replicate in the Airbyte UI. You can also use the API keys for the [test mode](https://stripe.com/docs/keys#obtain-api-keys) to try out the Stripe integration with Airbyte.
18+
19+
We recommend creating a secret key specifically for Airbyte to control which resources Airbyte can access. For ease of use, we recommend granting read permission to all resources and configuring which resource to replicate in the Airbyte UI. You can also use the API keys for the [test mode](https://stripe.com/docs/keys#obtain-api-keys) to try out the Stripe integration with Airbyte.
2020

2121
7. For **Replication start date**, enter the date in YYYY-MM-DDTHH:mm:ssZ format. The data added on and after this date will be replicated. If this field is blank, Airbyte will replicate all data.
2222
8. For **Lookback Window in days (Optional)**, select the number of days the value in days prior to the start date that you to sync your data with. If your data is updated after setting up this connector, you can use the this option to reload data from the past N days. Example: If the Replication start date is set to `2021-01-01T00:00:00Z`, then:
23-
- If you leave the Lookback Window in days parameter to its the default value of 0, Airbyte will sync data from the Replication start date `2021-01-01T00:00:00Z`
24-
- If the Lookback Window in days value is set to 1, Airbyte will consider the Replication start date to be `2020-12-31T00:00:00Z`
25-
- If the Lookback Window in days value is set to 7, Airbyte will sync data from `2020-12-31T00:00:00Z`
23+
- If you leave the Lookback Window in days parameter to its the default value of 0, Airbyte will sync data from the Replication start date `2021-01-01T00:00:00Z`
24+
- If the Lookback Window in days value is set to 1, Airbyte will consider the Replication start date to be `2020-12-31T00:00:00Z`
25+
- If the Lookback Window in days value is set to 7, Airbyte will sync data from `2020-12-31T00:00:00Z`
2626
9. Click **Set up source**.
2727

2828
## Supported sync modes
2929

3030
The Stripe source connector supports the following [sync modes](https://docs.airbyte.com/cloud/core-concepts#connection-sync-modes):
31-
- Full Refresh
32-
- Incremental
31+
32+
- Full Refresh
33+
- Incremental
3334

3435
:::note
3536
Since the Stripe API does not allow querying objects which were updated since the last sync, the Stripe connector uses the `created` field to query for new data in your Stripe account.
@@ -39,30 +40,29 @@ Since the Stripe API does not allow querying objects which were updated since th
3940

4041
The Stripe source connector supports the following streams:
4142

42-
* [Balance Transactions](https://stripe.com/docs/api/balance_transactions/list) \(Incremental\)
43-
* [Bank accounts](https://stripe.com/docs/api/customer_bank_accounts/list)
44-
* [Charges](https://stripe.com/docs/api/charges/list) \(Incremental\)
45-
* [Checkout Streams](https://stripe.com/docs/api/checkout/sessions/list)
46-
* [Checkout Streams Line Items](https://stripe.com/docs/api/checkout/sessions/line_items)
47-
* [Coupons](https://stripe.com/docs/api/coupons/list) \(Incremental\)
48-
* [Customer Balance Transactions](https://stripe.com/docs/api/customer_balance_transactions/list)
49-
* [Customers](https://stripe.com/docs/api/customers/list) \(Incremental\)
50-
* [Disputes](https://stripe.com/docs/api/disputes/list) \(Incremental\)
51-
* [Events](https://stripe.com/docs/api/events/list) \(Incremental\)
52-
* [Invoice Items](https://stripe.com/docs/api/invoiceitems/list) \(Incremental\)
53-
* [Invoice Line Items](https://stripe.com/docs/api/invoices/invoice_lines)
54-
* [Invoices](https://stripe.com/docs/api/invoices/list) \(Incremental\)
55-
* [PaymentIntents](https://stripe.com/docs/api/payment_intents/list) \(Incremental\)
56-
* [Payouts](https://stripe.com/docs/api/payouts/list) \(Incremental\)
57-
* [Promotion Code](https://stripe.com/docs/api/promotion_codes/list) \(Incremental\)
58-
* [Plans](https://stripe.com/docs/api/plans/list) \(Incremental\)
59-
* [Products](https://stripe.com/docs/api/products/list) \(Incremental\)
60-
* [Refunds](https://stripe.com/docs/api/refunds/list) \(Incremental\)
61-
* [Subscription Items](https://stripe.com/docs/api/subscription_items/list)
62-
* [Subscriptions](https://stripe.com/docs/api/subscriptions/list) \(Incremental\)
63-
* [Transfers](https://stripe.com/docs/api/transfers/list) \(Incremental\)
64-
* [ExternalAccountBankAccounts](https://stripe.com/docs/api/external_account_bank_accounts/list)\(Full Refresh\)
65-
* [ExternalAccountCards](https://stripe.com/docs/api/external_account_cards/list)\(Full Refresh\)
43+
- [Balance Transactions](https://stripe.com/docs/api/balance_transactions/list) \(Incremental\)
44+
- [Bank accounts](https://stripe.com/docs/api/customer_bank_accounts/list)
45+
- [Charges](https://stripe.com/docs/api/charges/list) \(Incremental\)
46+
- The `amount` column defaults to the smallest currency unit. (See [charge object](https://stripe.com/docs/api/charges/object) for more details)
47+
- [Checkout Streams](https://stripe.com/docs/api/checkout/sessions/list)
48+
- [Checkout Streams Line Items](https://stripe.com/docs/api/checkout/sessions/line_items)
49+
- [Coupons](https://stripe.com/docs/api/coupons/list) \(Incremental\)
50+
- [Customer Balance Transactions](https://stripe.com/docs/api/customer_balance_transactions/list)
51+
- [Customers](https://stripe.com/docs/api/customers/list) \(Incremental\)
52+
- [Disputes](https://stripe.com/docs/api/disputes/list) \(Incremental\)
53+
- [Events](https://stripe.com/docs/api/events/list) \(Incremental\)
54+
- [Invoice Items](https://stripe.com/docs/api/invoiceitems/list) \(Incremental\)
55+
- [Invoice Line Items](https://stripe.com/docs/api/invoices/invoice_lines)
56+
- [Invoices](https://stripe.com/docs/api/invoices/list) \(Incremental\)
57+
- [PaymentIntents](https://stripe.com/docs/api/payment_intents/list) \(Incremental\)
58+
- [Payouts](https://stripe.com/docs/api/payouts/list) \(Incremental\)
59+
- [Promotion Code](https://stripe.com/docs/api/promotion_codes/list) \(Incremental\)
60+
- [Plans](https://stripe.com/docs/api/plans/list) \(Incremental\)
61+
- [Products](https://stripe.com/docs/api/products/list) \(Incremental\)
62+
- [Refunds](https://stripe.com/docs/api/refunds/list) \(Incremental\)
63+
- [Subscription Items](https://stripe.com/docs/api/subscription_items/list)
64+
- [Subscriptions](https://stripe.com/docs/api/subscriptions/list) \(Incremental\)
65+
- [Transfers](https://stripe.com/docs/api/transfers/list) \(Incremental\)
6666

6767
### Data type mapping
6868

@@ -93,17 +93,16 @@ The Stripe connector should not run into Stripe API limitations under normal usa
9393
| 0.1.23 | 2021-11-08 | [7729](https://github.com/airbytehq/airbyte/pull/7729) | Correct `payment_intents` schema |
9494
| 0.1.22 | 2021-11-05 | [7345](https://github.com/airbytehq/airbyte/pull/7345) | Add 3 new streams |
9595
| 0.1.21 | 2021-10-07 | [6841](https://github.com/airbytehq/airbyte/pull/6841) | Fix missing `start_date` argument + update json files for SAT |
96-
| 0.1.20 | 2021-09-30 | [6017](https://github.com/airbytehq/airbyte/pull/6017) | Add lookback\_window\_days parameter |
96+
| 0.1.20 | 2021-09-30 | [6017](https://github.com/airbytehq/airbyte/pull/6017) | Add lookback_window_days parameter |
9797
| 0.1.19 | 2021-09-27 | [6466](https://github.com/airbytehq/airbyte/pull/6466) | Use `start_date` parameter in incremental streams |
9898
| 0.1.18 | 2021-09-14 | [6004](https://github.com/airbytehq/airbyte/pull/6004) | Fix coupons and subscriptions stream schemas by removing incorrect timestamp formatting |
9999
| 0.1.17 | 2021-09-14 | [6004](https://github.com/airbytehq/airbyte/pull/6004) | Add `PaymentIntents` stream |
100100
| 0.1.16 | 2021-07-28 | [4980](https://github.com/airbytehq/airbyte/pull/4980) | Remove Updated field from schemas |
101-
| 0.1.15 | 2021-07-21 | [4878](https://github.com/airbytehq/airbyte/pull/4878) | Fix incorrect percent\_off and discounts data filed types |
101+
| 0.1.15 | 2021-07-21 | [4878](https://github.com/airbytehq/airbyte/pull/4878) | Fix incorrect percent_off and discounts data filed types |
102102
| 0.1.14 | 2021-07-09 | [4669](https://github.com/airbytehq/airbyte/pull/4669) | Subscriptions Stream now returns all kinds of subscriptions \(including expired and canceled\) |
103103
| 0.1.13 | 2021-07-03 | [4528](https://github.com/airbytehq/airbyte/pull/4528) | Remove regex for acc validation |
104104
| 0.1.12 | 2021-06-08 | [3973](https://github.com/airbytehq/airbyte/pull/3973) | Add `AIRBYTE_ENTRYPOINT` for Kubernetes support |
105105
| 0.1.11 | 2021-05-30 | [3744](https://github.com/airbytehq/airbyte/pull/3744) | Fix types in schema |
106106
| 0.1.10 | 2021-05-28 | [3728](https://github.com/airbytehq/airbyte/pull/3728) | Update data types to be number instead of int |
107107
| 0.1.9 | 2021-05-13 | [3367](https://github.com/airbytehq/airbyte/pull/3367) | Add acceptance tests for connected accounts |
108108
| 0.1.8 | 2021-05-11 | [3566](https://github.com/airbytehq/airbyte/pull/3368) | Bump CDK connectors |
109-

0 commit comments

Comments
 (0)