Skip to content

Commit f81adf9

Browse files
markzegarellimarkzegarelli
committed
DOC-48 final additions
1 parent 4f94e36 commit f81adf9

File tree

1 file changed

+42
-19
lines changed
  • src/connections/sources/catalog/cloud-apps/stripe

1 file changed

+42
-19
lines changed

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

Lines changed: 42 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -90,12 +90,13 @@ Below are tables outlining the properties included in the collections listed abo
9090

9191
### application_fee_refunds
9292

93-
| Property Name | Description |
94-
| ------------- | ------------------------------------------------------------------------------ |
95-
| `amount` | Amount, in cents |
96-
| `currency` | Three-letter ISO currency code, in lowercase |
97-
| `fee_id` | ID of the application fee that was refunded |
98-
| `metadata` | A set of key-value pairs that describe additional information about the object |
93+
| Property Name | Description |
94+
| ------------- | ------------------------------------------------------------------------------- |
95+
| `amount` | Amount, in cents |
96+
| `created` | Time at which the object was created. Measured in seconds since the Unix epoch. |
97+
| `currency` | Three-letter ISO currency code, in lowercase |
98+
| `fee_id` | ID of the application fee that was refunded |
99+
| `metadata` | A set of key-value pairs that describe additional information about the object |
99100

100101

101102
### application_fees
@@ -106,12 +107,17 @@ Below are tables outlining the properties included in the collections listed abo
106107
| `amount_refunded` | Amount in pence refunded |
107108
| `amount` | Amount earned, in pence |
108109
| `application_id` | ID of the Connect application that earned the fee |
110+
| `available` | The date on which the transaction's net funds become available to the balance |
109111
| `balance_transaction_id` | Balance transaction that describes the impact of this collected application fee on your account balance |
110112
| `charge_id` | ID of the charge that the application fee was taken from |
113+
| `created` | Time at which the object was created. Measured in seconds since the Unix epoch. |
114+
| `created` | Time at which the object was created. Measured in seconds since the Unix epoch. |
111115
| `currency` | Three-letter ISO currency code, in lowercase |
112116
| `metadata` | A set of key-value pairs that describe additional information about the object |
117+
| `metadata` | A set of key-value pairs that describe additional information about the object |
113118
| `originating_transaction` | ID of the corresponding charge on the platform account |
114119
| `refunded` | Whether the fee has been fully refunded |
120+
| `transfer_id` | A reference to the related transaction, if enabled |
115121

116122
### balance_transactions
117123

@@ -145,6 +151,7 @@ Below are tables outlining the properties included in the collections listed abo
145151
| `country` | Two-letter ISO code representing the country the bank account is located in |
146152
| `currency` | Three-letter ISO code for the currency paid out to the bank account |
147153
| `default_for_currency` | Currency default |
154+
| `is_deleted` | Whether the bank account is active or has been deleted |
148155
| `metadata` | A set of key-value pairs that describe additional information about the object |
149156
| `status` | Status of account |
150157

@@ -243,7 +250,10 @@ Below are tables outlining the properties included in the collections listed abo
243250

244251
| Property Name | Description |
245252
| -------------- | ---------------------------------------------------------------------------------------------- |
253+
| `coupon_id` | The ID of the discount |
246254
| `customer_id` | ID of the customer |
255+
| `end` | The end date of the discount, unless the discount is applied either `once` or `forever` |
256+
| `start` | The date the discount was applied |
247257
| `subscription` | The subscription that this coupon is applied to, if it is applied to a particular subscription |
248258

249259
### disputes
@@ -445,14 +455,17 @@ Segment flattens Stripes `inventory`, `package_dimensions` objects. See Stripe's
445455
| --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
446456
| `active` | Whether the SKU is available for purchase |
447457
| `attributes_` | A dictionary of attributes and values defined by the product |
458+
| `created` | Time at which the object was created. Measured in seconds since the Unix epoch |
448459
| `currency` | Three-letter ISO currency code, in lowercase |
449460
| `image` | The URL of an image for this SKU |
450461
| `inventory_` | A description of the SKU's inventory, as described in Stripe's [documentation](https://stripe.com/docs/api/skus/object#sku_object-inventory). For example, `inventory_quantity`. |
462+
| `is_deleted` | Whether the object is active or has been deleted |
451463
| `livemode` | Whether the object exist in live mode or test mode |
452464
| `metadata` | A set of key-value pairs that describe additional information about the object |
453465
| `package_dimensions_` | The dimensions of a SKU's package dimensions, as described in Stripe's [documentation](https://stripe.com/docs/api/skus/object#sku_object-package_dimensions). For example, `package_dimensions_height`. |
454466
| `price` | The cost of the item in the smallest currency unit |
455467
| `product_id` | The ID of the product this SKU is associated with |
468+
| `updated` | Time at which the object was last updated. Measured in seconds since the Unix epoch |
456469

457470
### subscriptions
458471

@@ -465,32 +478,40 @@ Segment flattens Stripes `inventory`, `package_dimensions` objects. See Stripe's
465478
| `current_period_end` | End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created. |
466479
| `current_period_start` | Start of the current period that the subscription has been invoiced for. |
467480
| `customer_id` | ID of the customer who owns the subscription |
481+
| `discount_id` | References the associated discount, if available |
468482
| `ended_at` | If the subscription has ended, the date the subscription ended. |
483+
| `is_deleted` | Whether the object is active or has been deleted |
484+
| `plan_id` | References the associated plan, if available |
469485
| `quantity` | The quantity of the plan to which the customer is subscribed. |
470486
| `quantity` | The quantity of the plan to which the customer should be subscribed |
487+
| `start` | Date when the subscription was first created |
471488
| `status` | Possible values are trialing, active, past_due, canceled, or unpaid |
472489
| `tax_percent` | If provided, each invoice created by this subscription will apply the tax rate, increasing the amount billed to the customer |
473490
| `trial_end` | If the subscription has a trial, the end of that trial. |
474491
| `trial_start` | If the subscription has a trial, the beginning of that trial. |
475492

476493
### subscription_items
477494

478-
| Property Name | Description |
479-
| ----------------- | ------------------------------------------------------------------------------ |
480-
| `metadata` | A set of key-value pairs that describe additional information about the object |
481-
| `quantity` | The quantity of the plan to which the customer is subscribed |
482-
| `subscription_id` | The ID of the subscription this item belongs to |
495+
| Property Name | Description |
496+
| ----------------- | ------------------------------------------------------------------------------- |
497+
| `created` | Time at which the object was created. Measured in seconds since the Unix epoch. |
498+
| `metadata` | A set of key-value pairs that describe additional information about the object |
499+
| `plan_id` | References the associated plan, if available |
500+
| `quantity` | The quantity of the plan to which the customer is subscribed |
501+
| `subscription_id` | The ID of the subscription this item belongs to |
502+
483503

484504

485505
### transfer_reversals
486506

487-
| Property Name | Description |
488-
| ------------------------ | ------------------------------------------------------------------------------ |
489-
| `amount` | Amount, in cents |
490-
| `balance_transaction_id` | Balance transaction that describes the impact on your account balance |
491-
| `currency` | Three-letter ISO currency code, in lowercase |
492-
| `metadata` | A set of key-value pairs that describe additional information about the object |
493-
| `transfer_id` | ID of the transfer that was reversed |
507+
| Property Name | Description |
508+
| ------------------------ | ------------------------------------------------------------------------------- |
509+
| `amount` | Amount, in cents |
510+
| `balance_transaction_id` | Balance transaction that describes the impact on your account balance |
511+
| `created` | Time at which the object was created. Measured in seconds since the Unix epoch. |
512+
| `currency` | Three-letter ISO currency code, in lowercase |
513+
| `metadata` | A set of key-value pairs that describe additional information about the object |
514+
| `transfer_id` | ID of the transfer that was reversed |
494515

495516

496517
### transfers
@@ -501,11 +522,13 @@ Segment flattens Stripes `inventory`, `package_dimensions` objects. See Stripe's
501522
| `amount` | Amount in cents to be transferred |
502523
| `application_fee` | application_fee |
503524
| `balance_transaction_id` | Balance transaction that describes the impact of this transfer on your account balance |
525+
| `bank_account_id` | ID of the bank account used for the transaction |
526+
| `created` | Time at which the object was created. Measured in seconds since the Unix epoch. |
504527
| `currency` | Three-letter ISO currency code, in lowercase |
528+
| `date` | Time at which the transfer was completed |
505529
| `description` | An arbitrary string attached to the object |
506530
| `destination_id` | ID of the Stripe account the transfer was sent to |
507531
| `destination_payment` | If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer |
508532
| `metadata` | A set of key-value pairs that describe additional information about the object |
509533
| `reversed` | Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false |
510534
| `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 |
511-

0 commit comments

Comments
 (0)