Skip to content

Commit cbaa5e5

Browse files
authored
[chore] update stripe doc (#107)
1 parent d4f0665 commit cbaa5e5

File tree

1 file changed

+16
-24
lines changed

1 file changed

+16
-24
lines changed

src/stripe/INTEGRATION.mdx

Lines changed: 16 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,12 @@ Build complete payment flows, subscription systems, and revenue management with
3131

3232
## What Monk Manages
3333

34-
Monk handles your entire Stripe infrastructure:
34+
This integration ships the following Stripe entities:
3535

36-
- **Credentials & API keys**: Secure secret management for test and live environments
37-
- **Products & pricing**: Create and manage your product catalog and pricing tiers
38-
- **Webhook endpoints**: Configure secure webhook handlers for payment events
39-
- **Customer management**: Handle customer data and subscription lifecycle
40-
- **Invoice & billing**: Automate invoice generation and payment collection
41-
- **Subscription operations**: Manage trials, cancellations, and plan changes
36+
- **Credentials (stripe/credentials)**: Validates API key, derives mode (test/live), exposes `account_id` and optional `publishable_key`.
37+
- **Product (stripe/product)**: Creates or adopts a product by `product_id` or name; supports `product_description` and `metadata`.
38+
- **Price (stripe/price)**: Resolves by `lookup_key` or creates a price with `currency`, `unit_amount`, optional `recurring_interval`, and `product_id`.
39+
- **Webhook endpoint (stripe/webhook-endpoint)**: Creates an endpoint at `destination_url`, subscribes to `event_types`, stores signing secret in `signing_secret_ref` (default `stripe-webhook-secret`).
4240

4341
## Step-by-Step Integration Guide
4442

@@ -55,13 +53,11 @@ Add your Stripe credentials as Monk secrets:
5553
```bash
5654
# Test environment
5755
monk secrets add -g stripe-secret-key-test "sk_test_..."
58-
monk secrets add -g stripe-publishable-key-test "pk_test_..."
5956

6057
# Live environment (when ready for production)
6158
monk secrets add -g stripe-secret-key-live "sk_live_..."
62-
monk secrets add -g stripe-publishable-key-live "pk_live_..."
6359

64-
# Webhook signing secret (get this from Stripe dashboard)
60+
# Webhook signing secret (stored by entity on create, or set manually)
6561
monk secrets add -g stripe-webhook-secret "whsec_..."
6662
```
6763

@@ -76,14 +72,12 @@ namespace: my-saas-payments
7672
stripe-creds-test:
7773
defines: stripe/credentials
7874
secret_ref: stripe-secret-key-test
79-
publishable_key_ref: stripe-publishable-key-test
80-
environment: test
75+
publishable_key: "pk_test_..." # optional, convenience only
8176

8277
stripe-creds-live:
8378
defines: stripe/credentials
8479
secret_ref: stripe-secret-key-live
85-
publishable_key_ref: stripe-publishable-key-live
86-
environment: live
80+
publishable_key: "pk_live_..." # optional, convenience only
8781

8882
# SaaS product with multiple pricing tiers
8983
saas-product:
@@ -100,24 +94,22 @@ saas-product:
10094
monthly-price:
10195
defines: stripe/price
10296
secret_ref: stripe-secret-key-live
103-
product_id: \<- connection-target("saas-product") entity-state get-member("product_id")
97+
product_id: <- connection-target("saas-product") entity-state get-member("product_id")
10498
lookup_key: "monthly_basic"
10599
currency: usd
106100
unit_amount: 2900 # $29.00
107101
recurring_interval: month
108-
recurring_interval_count: 1
109-
trial_period_days: 14
102+
# trial periods can be configured at checkout/session level
110103

111104
# Annual subscription price (with discount)
112105
annual-price:
113106
defines: stripe/price
114107
secret_ref: stripe-secret-key-live
115-
product_id: \<- connection-target("saas-product") entity-state get-member("product_id")
108+
product_id: <- connection-target("saas-product") entity-state get-member("product_id")
116109
lookup_key: "annual_basic"
117110
currency: usd
118111
unit_amount: 29000 # $290.00 (2 months free)
119112
recurring_interval: year
120-
recurring_interval_count: 1
121113
metadata:
122114
discount: "20_percent"
123115

@@ -192,7 +184,7 @@ enterprise-product:
192184
starter-monthly:
193185
defines: stripe/price
194186
secret_ref: stripe-secret-key-live
195-
product_id: \<- connection-target("starter-product") entity-state get-member("product_id")
187+
product_id: <- connection-target("starter-product") entity-state get-member("product_id")
196188
lookup_key: "starter_monthly"
197189
currency: usd
198190
unit_amount: 0 # Free tier
@@ -201,7 +193,7 @@ starter-monthly:
201193
pro-monthly:
202194
defines: stripe/price
203195
secret_ref: stripe-secret-key-live
204-
product_id: \<- connection-target("professional-product") entity-state get-member("product_id")
196+
product_id: <- connection-target("professional-product") entity-state get-member("product_id")
205197
lookup_key: "pro_monthly"
206198
currency: usd
207199
unit_amount: 4900 # $49/month
@@ -210,7 +202,7 @@ pro-monthly:
210202
enterprise-monthly:
211203
defines: stripe/price
212204
secret_ref: stripe-secret-key-live
213-
product_id: \<- connection-target("enterprise-product") entity-state get-member("product_id")
205+
product_id: <- connection-target("enterprise-product") entity-state get-member("product_id")
214206
lookup_key: "enterprise_monthly"
215207
currency: usd
216208
unit_amount: 19900 # $199/month
@@ -243,7 +235,7 @@ hoodie-product:
243235
tshirt-price-small:
244236
defines: stripe/price
245237
secret_ref: stripe-secret-key-live
246-
product_id: \<- connection-target("tshirt-product") entity-state get-member("product_id")
238+
product_id: <- connection-target("tshirt-product") entity-state get-member("product_id")
247239
lookup_key: "tshirt_small"
248240
currency: usd
249241
unit_amount: 2500 # $25.00
@@ -252,7 +244,7 @@ tshirt-price-small:
252244
hoodie-price-large:
253245
defines: stripe/price
254246
secret_ref: stripe-secret-key-live
255-
product_id: \<- connection-target("hoodie-product") entity-state get-member("product_id")
247+
product_id: <- connection-target("hoodie-product") entity-state get-member("product_id")
256248
lookup_key: "hoodie_large"
257249
currency: usd
258250
unit_amount: 6500 # $65.00

0 commit comments

Comments
 (0)