Skip to content

Commit 4871334

Browse files
markzegarellimarkzegarelli
committed
DOC-48 added missing objects, removed changelog section
1 parent 488e7aa commit 4871334

File tree

1 file changed

+81
-55
lines changed
  • src/connections/sources/catalog/cloud-apps/stripe

1 file changed

+81
-55
lines changed

‎src/connections/sources/catalog/cloud-apps/stripe/index.md

Lines changed: 81 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,17 @@ Collections are the groupings of resources we pull from your source. In your war
4444
| `invoice_items` | object | Sometimes you want to add a charge or credit to a customer but only actually charge the customer's card at the end of a regular billing cycle. This is useful for combining several charges to minimize per-transaction fees or having Stripe tabulate your usage-based billing totals. For more info, see [Stripe's API docs](https://stripe.com/docs/api#invoiceitems) |
4545
| `invoice_lines` | object | When retrieving an invoice, you'll get a lines property containing the total count of line items and the first handful of those items For more info, see [Stripe's API docs](https://stripe.com/docs/api#invoice_lines) |
4646
| `invoices` | object | Invoices are statements of what a customer owes for a particular billing period, including subscriptions, invoice items, and any automatic proration adjustments if necessary. For more info, see [Stripe's API docs](https://stripe.com/docs/api#invoices) |
47+
| `orders` | object | |
48+
| `order_returns` | object | |
49+
| `order_shipping_methods` | object | |
4750
| `payment_intents` | object | A PaymentIntent tracks the process of collecting a payment from your customer. A PaymentIntent transitions through multiple statuse throughout its lifetime and ultimately creates at most one successful charge. For more info, see [Stripe's API docs](https://stripe.com/docs/api/payment_intents) |
4851
| `payment_methods` | object | PaymentMethod objects represent your customer's payment instruments. They can be used with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or saved to Customer objects to store instrument details for future payments. For more info, see [Stripe's API docs](https://stripe.com/docs/payments/payment-methods) |
4952
| plans | object | A subscription plan contains the pricing information for different products and feature levels on your site. For more info, see [Stripe's API docs](https://stripe.com/docs/api#plans) |
5053
| refunds | object | Refund objects allow you to refund a charge that has previously been created but not yet refunded. Funds will be refunded to the credit or debit card that was originally charged. The fees you were originally charged are also refunded. For more info, see [Stripe's API docs](https://stripe.com/docs/api#refunds) |
54+
| `products` | object | |
55+
| `skus` | object | |
5156
| `subscriptions` | object | Subscriptions allow you to charge a customer's card on a recurring basis. A subscription ties a customer to a particular plan you've created. For more info, see [Stripe's API docs](https://stripe.com/docs/api#subscriptions) |
57+
| `subscription_items` | object | |
5258
| `transfer_reversals` | object | A previously created transfer can be reversed if it has not yet been paid out. Funds will be refunded to your available balance, and the fees you were originally charged on the transfer will be refunded. You may not reverse automatic Stripe transfers. For more info, see [Stripe's API docs](https://stripe.com/docs/api#transfer_reversals) |
5359
| `transfers` | object | When Stripe sends you money or you initiate a transfer to a bank account, debit card, or connected Stripe account, a transfer object will be created. You can retrieve individual transfers as well as list all transfers. For more info, see [Stripe's API docs](https://stripe.com/docs/api#transfers) |
5460

@@ -279,6 +285,46 @@ Below are tables outlining the properties included in the collections listed abo
279285
| `type` | A string identifying the type of the source of this line item, either an `InvoiceItem` or a `Subscription` |
280286
| `item_id` | If id is prefixed with `ii_` then this is the line item's UUID, if any |
281287

288+
### orders
289+
290+
| Property Name | Description |
291+
| ------------------------- | ------------------------------------------------------------ |
292+
| `amount` | |
293+
| `amount_returned` | |
294+
| `application` | |
295+
| `application_fee` | |
296+
| `charge_id` | |
297+
| `currency` | |
298+
| `customer_id` | |
299+
| `email` | |
300+
| `livemode` | |
301+
| `selected_shipping_method`| |
302+
| `status` | |
303+
304+
### order_returns
305+
306+
| Property Name | Description |
307+
| ------------------------- | ------------------------------------------------------------ |
308+
| `amount` | |
309+
| `currency` | |
310+
| `description` | |
311+
| `parent_id` | |
312+
| `quantity` | |
313+
| `type` | |
314+
| `livemode` | |
315+
| `order_id` | |
316+
317+
### order_shipping_methods
318+
319+
| Property Name | Description |
320+
| ------------------------- | ------------------------------------------------------------ |
321+
| `order_id` | |
322+
| `shipping_id` | |
323+
| `amount` | |
324+
| `currency` | |
325+
| `description` | |
326+
327+
282328
### payment_intents
283329

284330
| Property Name | Description |
@@ -337,6 +383,21 @@ Below are tables outlining the properties included in the collections listed abo
337383
| `interval_count` | The number of intervals (specified in the interval property) between subscription billings |
338384
| `trial_period_days` | Default number of trial days when subscribing a customer to this plan using trial_from_plan=true |
339385

386+
### products
387+
388+
| Property Name | Description |
389+
| ----------------- | ------------------------------------------------------------ |
390+
| `active` | |
391+
| `attributes` | |
392+
| `caption` | |
393+
| `deactivate_on` | |
394+
| `description` | |
395+
| `images` | |
396+
| `livemode` | |
397+
| `name` | |
398+
| `shippable` | |
399+
| `url` | |
400+
340401
### refunds
341402

342403
| Property Name | Description |
@@ -348,6 +409,19 @@ Below are tables outlining the properties included in the collections listed abo
348409
| `receipt_number` | This is the transaction number that appears on email receipts sent for this refund |
349410
| `reason` | Reason for the refund |
350411

412+
### skus
413+
414+
| Property Name | Description |
415+
| ----------------- | ------------------------------------------------------------ |
416+
| `product_id` | |
417+
| `active` | |
418+
| `currency` | |
419+
| `image` | |
420+
| `livemode` | |
421+
| `price` | |
422+
423+
###
424+
351425
### subscriptions
352426

353427
| Property Name | Description |
@@ -367,6 +441,13 @@ Below are tables outlining the properties included in the collections listed abo
367441
| `trial_end` | If the subscription has a trial, the end of that trial. |
368442
| `trial_start` | If the subscription has a trial, the beginning of that trial. |
369443

444+
### subscription_items
445+
446+
| Property Name | Description |
447+
| ----------------- | ------------------------------------------------------------ |
448+
| `subscription_id` | |
449+
| `quantity` | |
450+
370451
### transfer_reversals
371452

372453
| Property Name | Description |
@@ -391,58 +472,3 @@ Below are tables outlining the properties included in the collections listed abo
391472
| `reversed` | Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false |
392473
| `source_transaction` | ID of the charge or payment that was used to fund the transfer. If null, the transfer was funded from the available balance |
393474

394-
## V2 Changelog
395-
In September 2017, Segment will upgrade all Stripe sources to sync incrementally, using the [List Events](https://stripe.com/docs/api#list_events) endpoint to sync changes to Stripe objects. There are a few benefits to this approach…
396-
397-
- **Faster sync times:** for larger accounts, we've seen performance improve by 10x
398-
- **Additional Object Properties:** Events provide additional metadata about objects, like their creation time and deletion time
399-
- **Reduced load on the Stripe API:** Our new Stripe source helps cut down load on our partner's API, and reduces unnecessary data transfer
400-
401-
### How It Works
402-
1. The Stripe Source will run a full sync of all objects, using the `List All` endpoints for `Charges`, `Customers`, `Refunds`, etc.
403-
2. After the first sync completes, the source will automatically switch into incremental mode.
404-
1. When the source is scheduled to run, it will query for all events since the last sync completed. An event can be an object (e.g. a customer) being `created`, `updated`, or `deleted`
405-
2. The Segment source will materialize the event stream into the latest state of the object. So the `charges` table will always reflect the latest `charge.updated` event.
406-
407-
### Changelog
408-
409-
**30-May-2019**
410-
411-
| **Collection** | **Changes** |
412-
| ------ | -------------------------------------- |
413-
| charges | **New Properties**<ul><li>payment_method_id</li><li>payment_intent_id</li></ul> |
414-
| invoice_lines | ***Updated docs for collection*** |
415-
| payment_intents | ***New Collection*** |
416-
| payment_methods | ***New Collection*** |
417-
418-
| **Collection** | **Changes** |
419-
| ------ | -------------------------------------- |
420-
| accounts | *No Change - accounts cannot be synced incrementally* |
421-
| application_fee_refunds | **Deprecated properties** <ul><li> balance_transaction_id </li></ul> |
422-
| application_fees | **Deprecated properties** <ul><li>refund_ids</li></ul> |
423-
| balance_transaction_fee_details | *No Change* |
424-
| balance_transactions | **Deprecated properties** <ul><li>sourced_transfers</li></ul> |
425-
| bank_accounts | **Deprecated properties** <ul><li>currency</li></ul>**New properties**<ul><li>is_deleted</li></ul> |
426-
| cards | **New properties** <ul><li>customer_id</li><li>is_deleted</li></ul> |
427-
| charges | **Deprecated properties**<ul><li>receipt_number</li><li>dispute_id</li><li>tokenization_method</li></ul> |
428-
| coupons | *No Change* |
429-
| customers | **Deprecated properties**<ul><li>source_ids</li><li>subscription_ids</li><li>discount_id</li></ul>**New properties** <ul><li> is_deleted </li></ul> |
430-
| discounts | *No Change* |
431-
| disputes | *No Change* |
432-
| invoice_items | *No Change* |
433-
| invoice_lines | **Deprecated properties** <ul><li>metadata_*</li></ul> |
434-
| invoices | **Deprecated properties** <ul><li>line_ids</li><li>attempt_count</li><li>next_payment_attempt</li></ul> |
435-
| order_returns | **Deprecated properties**<ul><li>refund_id</li></ul> |
436-
| order_shipping_methods | *No Change* |
437-
| orders | **Deprecated properties**<ul><li>status_transitions_*</li></ul> |
438-
| plans | *No Change* |
439-
| products | *No Change* |
440-
| refunds | **Deprecated properties** <ul><li>refunds starting with `py_` </li></ul> |
441-
| skus | *No Change* |
442-
| subscriptions | *No Change* |
443-
| subscription_items | ***NEWCOLLECTION*** |
444-
| transfer_reversals | *No Change* |
445-
| transfers | **Deprecated Properties**<ul><li>reversal_ids</li></ul> |
446-
447-
## Adding Destinations
448-
Currently, Warehouses are the only supported destination for object-cloud sources.

0 commit comments

Comments
 (0)