Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Insforge Stripe Payments API

Stripe Checkout, Billing Portal, catalog, sync, customer, subscription, and transaction routes

Insforge Stripe Payments API is one of 11 APIs that Insforge publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Stripe Payments. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 23 operations across 16 paths, and defines 56 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against the base URL https://api.insforge.dev.

23 operations 16 paths 56 schemas 3 DELETE10 GET2 PATCH7 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.insforge.dev
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Insforge Stripe Payments API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth).

Paths & Operations 23

Across 16 paths, the API surfaces 23 operations — 3 DELETE, 10 GET, 2 PATCH, 7 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Stripe Payments 23

Stripe Checkout, Billing Portal, catalog, sync, customer, subscription, and transaction routes

POST
/api/payments/stripe/{environment}/checkout-sessions
Create Stripe Checkout Session
1 param body → 201400401403500
POST
/api/payments/stripe/{environment}/customer-portal-sessions
Create Stripe Customer Portal Session
1 param body → 201400401403404500
GET
/api/payments/stripe/status
Get Stripe Payments Status
→ 200401403
GET
/api/payments/stripe/config
Get Stripe Key Configuration
→ 200401403
PUT
/api/payments/stripe/{environment}/config
Configure Stripe Secret Key
1 param body → 200400401403
DELETE
/api/payments/stripe/{environment}/config
Remove Stripe Secret Key
1 param → 200400401403404
POST
/api/payments/stripe/sync
Sync Stripe Payments State
→ 200400401403
POST
/api/payments/stripe/{environment}/sync
Sync Stripe Payments State For One Environment
1 param → 200400401403
POST
/api/payments/stripe/{environment}/webhook
Configure Managed Stripe Webhook
1 param → 200400401403
GET
/api/payments/stripe/{environment}/catalog
List Stripe Catalog
1 param → 200400401403
GET
/api/payments/stripe/{environment}/catalog/products
List Stripe Products
1 param → 200400401403
POST
/api/payments/stripe/{environment}/catalog/products
Create Stripe Product
1 param body → 201400401403
GET
/api/payments/stripe/{environment}/catalog/products/{productId}
Get Stripe Product
2 params → 200400401403404
PATCH
/api/payments/stripe/{environment}/catalog/products/{productId}
Update Stripe Product
2 params body → 200400401403404
DELETE
/api/payments/stripe/{environment}/catalog/products/{productId}
Delete Stripe Product
2 params → 200400401403404
GET
/api/payments/stripe/{environment}/catalog/prices
List Stripe Prices
2 params → 200400401403
POST
/api/payments/stripe/{environment}/catalog/prices
Create Stripe Price
1 param body → 201400401403
GET
/api/payments/stripe/{environment}/catalog/prices/{priceId}
Get Stripe Price
2 params → 200400401403404
PATCH
/api/payments/stripe/{environment}/catalog/prices/{priceId}
Update Stripe Price
2 params body → 200400401403404
DELETE
/api/payments/stripe/{environment}/catalog/prices/{priceId}
Archive Stripe Price
2 params → 200400401403404
GET
/api/payments/stripe/{environment}/subscriptions
List Stripe Subscriptions
4 params → 200400401403
GET
/api/payments/stripe/{environment}/customers
List Stripe Customers
2 params → 200400401403
GET
/api/payments/stripe/{environment}/transactions
List Stripe Transactions
4 params → 200400401403

Schemas 56

The contract defines 56 schemas that model the data the API accepts and returns. The most detailed are PaymentTransaction (20 properties), StripeSubscription (19 properties), CheckoutSession (16 properties), StripePrice (15 properties). Each schema is shown below with its type and property counts.

CheckoutSessionPaymentStatus
string
ListPaymentCustomersResponse
object
1 property 1 required
PaymentProvider
string
MutateStripeProductResponse
object
1 property 1 required
PaymentTransaction
object
20 properties 20 required
StripeSubscriptionStatus
string
ArchiveStripePriceResponse
object
2 properties 2 required
CheckoutSessionStatus
string
StripeProduct
object
8 properties 8 required
PaymentTransactionStatus
string
StripePriceRecurringInterval
string
GetStripeStatusResponse
object
1 property 1 required
ListStripeSubscriptionsResponse
object
1 property 1 required
ConfigureStripeWebhookResponse
object
1 property 1 required
MutateStripePriceResponse
object
1 property 1 required
CreateCheckoutSessionLineItem
object
2 properties 1 required
SyncStripePaymentsResponse
object
1 property 1 required
StripeLatestSyncStatus
string
StripeKeyConfig
object
3 properties 3 required
DeleteStripeProductResponse
object
2 properties 2 required
PaymentEnvironment
string
UpdateStripeProductBody
object
4 properties
ListPaymentTransactionsResponse
object
1 property 1 required
CreateStripeProductBody
object
5 properties 1 required
CreateCheckoutSessionBody
object
Metadata keys starting with insforge are reserved and rejected.
8 properties 4 required
CreateCheckoutSessionResponse
object
1 property 1 required
CreateCustomerPortalSessionBody
object
3 properties 1 required
StripePrice
object
15 properties 15 required
SyncStripePaymentsSubscriptionsSummary
object
4 properties 4 required
PaymentCustomerListItem
SyncStripePaymentsEnvironmentResult
object
3 properties 3 required
GetStripeProductResponse
object
2 properties 2 required
PaymentTransactionType
string
StripeSubscriptionItem
object
9 properties 9 required
ListStripeCatalogResponse
object
2 properties 2 required
BillingSubject
object
2 properties 2 required
CheckoutSession
object
16 properties 16 required
StripeConnection
object
13 properties 13 required
GetStripeConfigResponse
object
1 property 1 required
CustomerPortalSessionStatus
string
StripePriceTaxBehavior
string
StripeConnectionStatus
string
UpsertStripeConfigBody
object
1 property 1 required
CustomerPortalSession
object
12 properties 12 required
GetStripePriceResponse
object
1 property 1 required
ErrorResponse
object
4 properties 3 required
CreateStripePriceBody
object
9 properties 3 required
PaymentCustomer
object
10 properties 10 required
CheckoutMode
string
CreateCustomerPortalSessionResponse
object
1 property 1 required
StripeEnvironment
ListStripePricesResponse
object
1 property 1 required
StripeSubscription
object
19 properties 19 required
Metadata
object
ListStripeProductsResponse
object
1 property 1 required
UpdateStripePriceBody
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

insforge-stripe-payments-api-openapi.yml Raw ↑

Other APIs Insforge publishes across the network.

Insforge Admin API
Insforge Channels API
Insforge Client API
Insforge Configuration API
Insforge Messages API
Insforge Payment Webhooks API
Insforge Permissions API
Insforge Razorpay Payments API
Insforge S3 Access Keys API
Insforge S3 Protocol API