Skip to content
Paywright
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Menu
Start here
Introduction
Quick start
Configuration
Guides
One-time payments
Subscriptions
Webhooks
Testing payments
Client SDKs
TypeScript SDK
Other languages
Concepts
Architecture
Operations
Reference
CLI
API reference
Overview
Health
Health_check
GET
customers
List customers
GET
Create a customer
POST
Get a customer
GET
Delete a customer
DELETE
Update a customer
PATCH
plans
List plans
GET
Create a plan (Stripe product + price)
POST
Get a plan
GET
Archive a plan (prices are immutable in Stripe)
POST
payments
List payments, optionally by customer
GET
Create a payment intent
POST
Get a payment
GET
Cancel an uncaptured payment
POST
Refund a succeeded payment
POST
subscriptions
List subscriptions, optionally by customer
GET
Create a subscription (first charge confirmed by frontend)
POST
Get a subscription
GET
Cancel a subscription immediately
DELETE
Webhooks
Verify → dedup → enqueue → 200. No business logic here: Stripe retries anything that doesn't get a 2xx within ~10s, so the heavy work happens in the background processor.
POST
Metrics
Metrics_metrics
GET
invoices
List invoices, optionally by customer
GET
Get an invoice
GET
GitHub
Select theme
Dark
Light
Auto
Overview
Stripe Payment Service
1.0
Section titled “Stripe Payment Service 1.0”
Information
OpenAPI version:
3.0.0
Operations
Section titled “Operations”
GET
/health
GET
/api/v1/customers
POST
/api/v1/customers
GET
/api/v1/customers/{id}
DELETE
/api/v1/customers/{id}
PATCH
/api/v1/customers/{id}
GET
/api/v1/plans
POST
/api/v1/plans
GET
/api/v1/plans/{id}
POST
/api/v1/plans/{id}/archive
GET
/api/v1/payments
POST
/api/v1/payments
GET
/api/v1/payments/{id}
POST
/api/v1/payments/{id}/cancel
POST
/api/v1/payments/{id}/refund
GET
/api/v1/subscriptions
POST
/api/v1/subscriptions
GET
/api/v1/subscriptions/{id}
DELETE
/api/v1/subscriptions/{id}
POST
/webhooks/stripe
GET
/metrics
GET
/api/v1/invoices
GET
/api/v1/invoices/{id}
Authentication
Section titled “Authentication”
x-api-key
Section titled “x-api-key”
Security scheme type:
apiKey
Header parameter name:
x-api-key