Skip to content

Commit

Permalink
Documented Stripe Scripts -7
Browse files Browse the repository at this point in the history
  • Loading branch information
@Pete-Sony
Pete-Sony committed Jan 30, 2024
1 parent 4396e44 commit 5cbe75e
Show file tree
Hide file tree
Showing 8 changed files with 247 additions and 274 deletions.
3 changes: 2 additions & 1 deletion .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,5 @@ db.json


.nvmrc
Helper
Helper
CreateConfig
82 changes: 41 additions & 41 deletions docs/library/jobs/Stripe/fetch_invoice_items.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,60 +3,60 @@ title: Invoice Items
sidebar_position: 2
---

This job fetches vendors from Simplepor. v3
This job fetches Invoice Items from Stripe.

<AddJob
template="gsheet_simplepor_db_vendors" v4
template="gsheet_stripe_simple_get_invoice_items"
/>

## Data

### Sample Data

<Gsheet
src="https://docs.google.com/spreadsheets/d/14xpjjn0KR9oWi4zoM7JEfvAuiwR5ybX_0dVTZxmmwRI/edit#gid=548360923"
/>v6


### Data headers v7

| Header | Description |
|------------------|----------------------------------------------------------|
| content | Content of the event notification |
| type | Type of the event notification |
| doer | Doer or actor associated with the event |
| object_type | Type of the object affected by the event |
| object_id | Identifier of the object affected by the event |
| user | Name of the user associated with the event |
| user_email | Email address of the user associated with the event |
| details_from | Details indicating the source in the event |
| details_to | Details indicating the destination in the event |
| details_action | Details about the action performed in the event |
| details_por_no | Details related to the purchase order number, if available|
| createdAt | Timestamp when the event was created |
| updatedAt | Timestamp when the event was last updated |
| id | Unique identifier for the event |
| user_id | Unique identifier for the user associated with the event |

src="https://docs.google.com/spreadsheets/d/1yiCWVI4oGzIPUBR2Emm2YJGfpisbRnxShpuFw1MVqzE/edit#gid=1846151702"
/>


### Filtration options v7
### Data headers

| Header | Description |
|-------------------------|-----------------------------------------------------------|
| id | Unique identifier for the item. |
| object | Type of object (e.g., invoice item, subscription). |
| amount | Total amount for the item. |
| currency | Currency in which the amount is specified. |
| customer | Customer associated with the item. |
| date | Date when the item was created. |
| description | Brief description of the item. |
| discountable | Indicates whether the item is eligible for discounts. |
| discounts | Discounts applied to the item. |
| invoice | Invoice associated with the item. |
| livemode | Indicates whether the item is in live mode. |
| period/end | End date of the billing period. |
| period/start | Start date of the billing period. |
| plan | Subscription plan associated with the item. |
| price/id | ID of the price associated with the item. |
| price/object | Type of object for the price. |
| price/active | Indicates whether the price is currently active. |
| ... (continue for other price-related fields) |
| proration | Indicates whether proration is applied. |
| quantity | Quantity of the item. |
| subscription | Subscription associated with the item. |
| tax_rates | Tax rates applied to the item. |
| test_clock | Test clock value. |
| unit_amount | Unit amount for the item. |
| unit_amount_decimal | Decimal representation of the unit amount. |




### Filtration options

This job can restrict the data that is visible in spreadsheets. Use the following parameters to restrict the data.

| Parameter | Options |
|----|----|
| start_date | Select bills with billing date on or after `start_date`. Format - `YYYY-MM-DD` |
| end_date | Select bills with billing date on or before `end_date`. Format - `YYYY-MM-DD` |

<!---
## Others

### Similar jobs

Similar sort of data can be achieved by using get accounting transaction job and filtering it by invoice type.

### Reports that use this job

Here are some of the report templates that use this job:
-->
| customer | Customer ID to filter invoice items for a specific customer.|
| limit | Limits the number of invoice items to retrieve. |
| pending | Filters invoice items based on their pending status. |
91 changes: 51 additions & 40 deletions docs/library/jobs/Stripe/fetch_payment_intents.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,60 +3,71 @@ title: Payment Intents
sidebar_position: 2
---

This job fetches vendors from Simplepor. v3
This job fetches Payment Intents from Stripe.

<AddJob
template="gsheet_simplepor_db_vendors" v4
template="gsheet_stripe_simple_get_payment_intents"
/>

## Data

### Sample Data

<Gsheet
src="https://docs.google.com/spreadsheets/d/14xpjjn0KR9oWi4zoM7JEfvAuiwR5ybX_0dVTZxmmwRI/edit#gid=548360923"
/>v6


### Data headers v7

| Header | Description |
|------------------|----------------------------------------------------------|
| content | Content of the event notification |
| type | Type of the event notification |
| doer | Doer or actor associated with the event |
| object_type | Type of the object affected by the event |
| object_id | Identifier of the object affected by the event |
| user | Name of the user associated with the event |
| user_email | Email address of the user associated with the event |
| details_from | Details indicating the source in the event |
| details_to | Details indicating the destination in the event |
| details_action | Details about the action performed in the event |
| details_por_no | Details related to the purchase order number, if available|
| createdAt | Timestamp when the event was created |
| updatedAt | Timestamp when the event was last updated |
| id | Unique identifier for the event |
| user_id | Unique identifier for the user associated with the event |

src="https://docs.google.com/spreadsheets/d/1yiCWVI4oGzIPUBR2Emm2YJGfpisbRnxShpuFw1MVqzE/edit#gid=899379188"
/>


### Filtration options v7
### Data Headers
| Header | Description |
|-----------------------------------------------------------|----------------------------------------------|
| id | Unique identifier for the payment. |
| object | Type of object (e.g., payment). |
| amount | Total amount for the payment. |
| amount_capturable | Amount that can be captured for the payment. |
| amount_received | Amount received for the payment. |
| application | Application ID associated with the payment. |
| application_fee_amount | Application fee amount (if any). |
| automatic_payment_methods | Automatic payment methods for the payment. |
| canceled_at | Date and time when the payment was canceled. |
| cancellation_reason | Reason for canceling the payment. |
| capture_method | Method used to capture the payment (e.g., automatic). |
| client_secret | Client secret for the payment. |
| confirmation_method | Confirmation method for the payment. |
| created | Date and time when the payment was created. |
| currency | Currency in which the amount is specified. |
| customer | Customer associated with the payment. |
| description | Brief description of the payment. |
| invoice | Invoice ID associated with the payment. |
| last_payment_error | Details of the last payment error, if any. |
| latest_charge | Latest charge ID associated with the payment. |
| livemode | Indicates whether the payment is in live mode. |
| next_action | Next action to be taken for the payment. |
| on_behalf_of | Account (on behalf of) associated with the payment. |
| payment_method | Payment method ID used for the payment. |
| payment_method_configuration_details | Configuration details for the payment method. |
| payment_method_options/card | Installment options for credit card payments. |
| payment_method_options/us_bank_account/verification_method| Verification method for US bank account payments. |
| payment_method_types/0-3 | Type of payment methods associated with the payment. |
| processing | Details about the processing status of the payment. |
| receipt_email | Email address for sending a receipt. |
| review | Details about the review status of the payment. |
| setup_future_usage | Indicates the intended usage of the payment for future setup. |
| shipping | Shipping information associated with the payment. |
| source | Source of the payment (e.g., card, bank account). |
| statement_descriptor | Descriptor that appears on the customer's statement. |
| statement_descriptor_suffix | Additional descriptor suffix for the statement. |
| status | Status of the payment (e.g., succeeded, failed). |
| transfer_data | Transfer data associated with the payment. |
| transfer_group | Transfer group for grouping multiple payments. |




### Filtration options

This job can restrict the data that is visible in spreadsheets. Use the following parameters to restrict the data.

| Parameter | Options |
|----|----|
| start_date | Select bills with billing date on or after `start_date`. Format - `YYYY-MM-DD` |
| end_date | Select bills with billing date on or before `end_date`. Format - `YYYY-MM-DD` |

<!---
## Others

### Similar jobs

Similar sort of data can be achieved by using get accounting transaction job and filtering it by invoice type.

### Reports that use this job

Here are some of the report templates that use this job:
-->
81 changes: 40 additions & 41 deletions docs/library/jobs/Stripe/fetch_prices.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,60 +3,59 @@ title: Prices
sidebar_position: 2
---

This job fetches vendors from Simplepor. v3
This job fetches Prices from Stripe.

<AddJob
template="gsheet_simplepor_db_vendors" v4
template="gsheet_stripe_simple_get_prices"
/>

## Data

### Sample Data

<Gsheet
src="https://docs.google.com/spreadsheets/d/14xpjjn0KR9oWi4zoM7JEfvAuiwR5ybX_0dVTZxmmwRI/edit#gid=548360923"
/>v6


### Data headers v7

| Header | Description |
|------------------|----------------------------------------------------------|
| content | Content of the event notification |
| type | Type of the event notification |
| doer | Doer or actor associated with the event |
| object_type | Type of the object affected by the event |
| object_id | Identifier of the object affected by the event |
| user | Name of the user associated with the event |
| user_email | Email address of the user associated with the event |
| details_from | Details indicating the source in the event |
| details_to | Details indicating the destination in the event |
| details_action | Details about the action performed in the event |
| details_por_no | Details related to the purchase order number, if available|
| createdAt | Timestamp when the event was created |
| updatedAt | Timestamp when the event was last updated |
| id | Unique identifier for the event |
| user_id | Unique identifier for the user associated with the event |

src="https://docs.google.com/spreadsheets/d/1yiCWVI4oGzIPUBR2Emm2YJGfpisbRnxShpuFw1MVqzE/edit#gid=1609640077"
/>


### Filtration options v7
### Data headers

| Header | Description |
|---------------------------------|---------------------------------------------------------------|
| id | Unique identifier for the product. |
| object | Type of object (e.g., product). |
| active | Indicates whether the product is currently active. |
| billing_scheme | Specifies how prices are billed for the product. |
| created | Date and time when the product was created. |
| currency | Currency in which the prices are specified. |
| custom_unit_amount | Custom unit amount for the product. |
| livemode | Indicates whether the product is in live mode. |
| lookup_key | Lookup key associated with the product. |
| nickname | A nickname or short name for the product. |
| product | The type or category of the product. |
| recurring/aggregate_usage | Specifies how usage is aggregated for the product. |
| recurring/interval | Interval at which the product is billed. |
| recurring/interval_count | Number of intervals between each billing. |
| recurring/trial_period_days | Number of days for a trial period. |
| recurring/usage_type | Specifies whether the product's usage is metered or licensed.|
| tax_behavior | Specifies the tax behavior for the product. |
| tiers_mode | Specifies how tiers are defined for the product. |
| transform_quantity | Indicates whether to transform quantity on the invoice. |
| type | Type of the product (e.g., service). |
| unit_amount | Unit amount for the product. |
| unit_amount_decimal | Decimal representation of the unit amount for the product. |



### Filtration options

This job can restrict the data that is visible in spreadsheets. Use the following parameters to restrict the data.

| Parameter | Options |
|----|----|
| start_date | Select bills with billing date on or after `start_date`. Format - `YYYY-MM-DD` |
| end_date | Select bills with billing date on or before `end_date`. Format - `YYYY-MM-DD` |

<!---
## Others

### Similar jobs

Similar sort of data can be achieved by using get accounting transaction job and filtering it by invoice type.

### Reports that use this job

Here are some of the report templates that use this job:
-->
| start_date | Select bills with billing date on or after `start_date`. Format - `YYYY-MM-DD` |
| end_date | Select bills with billing date on or before `end_date`. Format - `YYYY-MM-DD` |
| active | Only return prices that are active or inactive (e.g., pass false to list all inactive prices). |
| currency | Only return prices for the given currency (e.g., usd, inr,...). |
| type | Only return prices of type recurring or one_time. |
| limit | A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. |
Loading

0 comments on commit 5cbe75e

Please sign in to comment.