[
{
"handle": "customers",
"meta": {
"short": "Customers",
"description": "Manage customer information and payment details."
},
"endpoint": {
"value": "/v1/customers",
"placeholders": []
},
"fields": [
{
"name": "id",
"type": "String",
"selector": ["id"],
"meta": {}
},
{
"name": "name",
"type": "String",
"selector": ["name"],
"meta": {}
},
{
"name": "email",
"type": "String",
"selector": ["email"],
"meta": {}
},
{
"name": "created",
"type": "Integer",
"selector": ["created"],
"meta": {}
}
],
"operations": {
"list": {
"method": "GET",
"path": {
"value": "",
"placeholders": []
},
"headers": {},
"queryParams": {},
"bodyTemplate": null
},
"read": {
"method": "GET",
"path": {
"value": "/{{id}}",
"placeholders": [
{
"name": "id",
"type": "String",
"description": "The ID of the customer to retrieve.",
"required": true
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": null
},
"create": {
"method": "POST",
"path": {
"value": "",
"placeholders": []
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "{\"name\": \"{{name}}\", \"email\": \"{{email}}\"}",
"placeholders": [
{
"name": "name",
"type": "String",
"description": "The name of the customer.",
"required": true
},
{
"name": "email",
"type": "String",
"description": "The email address of the customer.",
"required": true
}
]
}
},
"update": {
"method": "POST",
"path": {
"value": "/{{id}}",
"placeholders": [
{
"name": "id",
"type": "String",
"description": "The ID of the customer to update.",
"required": true
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "{\"name\": \"{{name}}\", \"email\": \"{{email}}\"}",
"placeholders": [
{
"name": "name",
"type": "String",
"description": "The updated name of the customer.",
"required": false
},
{
"name": "email",
"type": "String",
"description": "The updated email address of the customer.",
"required": false
}
]
}
},
"delete": {
"method": "DELETE",
"path": {
"value": "/{{id}}",
"placeholders": [
{
"name": "id",
"type": "String",
"description": "The ID of the customer to delete.",
"required": true
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": null
}
},
"webhooks": [
{
"event": "customer.created",
"path": "/webhooks/stripe/customer-created",
"payload": [
{
"name": "id",
"type": "String",
"selector": ["data", "object", "id"],
"meta": {}
},
{
"name": "email",
"type": "String",
"selector": ["data", "object", "email"],
"meta": {}
}
]
},
{
"event": "customer.updated",
"path": "/webhooks/stripe/customer-updated",
"payload": [
{
"name": "id",
"type": "String",
"selector": ["data", "object", "id"],
"meta": {}
},
{
"name": "email",
"type": "String",
"selector": ["data", "object", "email"],
"meta": {}
}
]
}
]
},
{
"handle": "charges",
"meta": {
"short": "Charges",
"description": "Create and manage payments."
},
"endpoint": {
"value": "/v1/charges",
"placeholders": []
},
"fields": [
{
"name": "id",
"type": "String",
"selector": ["id"],
"meta": {}
},
{
"name": "amount",
"type": "Integer",
"selector": ["amount"],
"meta": {}
},
{
"name": "currency",
"type": "String",
"selector": ["currency"],
"meta": {}
},
{
"name": "status",
"type": "String",
"selector": ["status"],
"meta": {}
}
],
"operations": {
"list": {
"method": "GET",
"path": {
"value": "",
"placeholders": []
},
"headers": {},
"queryParams": {},
"bodyTemplate": null
},
"read": {
"method": "GET",
"path": {
"value": "/{{id}}",
"placeholders": [
{
"name": "id",
"type": "String",
"description": "The ID of the charge to retrieve.",
"required": true
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": null
},
"create": {
"method": "POST",
"path": {
"value": "",
"placeholders": []
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "{\"amount\": {{amount}}, \"currency\": \"{{currency}}\", \"source\": \"{{source}}\"}",
"placeholders": [
{
"name": "amount",
"type": "Integer",
"description": "The amount to charge.",
"required": true
},
{
"name": "currency",
"type": "String",
"description": "The currency to use for the charge.",
"required": true
},
{
"name": "source",
"type": "String",
"description": "The payment source (e.g., a token).",
"required": true
}
]
}
}
},
"webhooks": [
{
"event": "charge.succeeded",
"path": "/webhooks/stripe/charge-succeeded",
"payload": [
{
"name": "id",
"type": "String",
"selector": ["data", "object", "id"],
"meta": {}
},
{
"name": "amount",
"type": "Integer",
"selector": ["data", "object", "amount"],
"meta": {}
}
]
}
]
},
{
"handle": "subscriptions",
"meta": {
"short": "Subscriptions",
"description": "Manage recurring payments and subscriptions."
},
"endpoint": {
"value": "/v1/subscriptions",
"placeholders": []
},
"fields": [
{
"name": "id",
"type": "String",
"selector": ["id"],
"meta": {}
},
{
"name": "customer",
"type": "String",
"selector": ["customer"],
"meta": {}
},
{
"name": "status",
"type": "String",
"selector": ["status"],
"meta": {}
},
{
"name": "current_period_end",
"type": "Integer",
"selector": ["current_period_end"],
"meta": {}
}
],
"operations": {
"list": {
"method": "GET",
"path": {
"value": "",
"placeholders": []
},
"headers": {},
"queryParams": {},
"bodyTemplate": null
},
"read": {
"method": "GET",
"path": {
"value": "/{{id}}",
"placeholders": [
{
"name": "id",
"type": "String",
"description": "The ID of the subscription to retrieve.",
"required": true
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": null
},
"create": {
"method": "POST",
"path": {
"value": "",
"placeholders": []
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "{\"customer\": \"{{customer}}\", \"items\": [{\"price\": \"{{price}}\"}]}",
"placeholders": [
{
"name": "customer",
"type": "String",
"description": "The ID of the customer.",
"required": true
},
{
"name": "price",
"type": "String",
"description": "The ID of the price.",
"required": true
}
]
}
},
"delete": {
"method": "DELETE",
"path": {
"value": "/{{id}}",
"placeholders": [
{
"name": "id",
"type": "String",
"description": "The ID of the subscription to delete.",
"required": true
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": null
}
},
"webhooks": [
{
"event": "customer.subscription.created",
"path": "/webhooks/stripe/subscription-created",
"payload": [
{
"name": "id",
"type": "String",
"selector": ["data", "object", "id"],
"meta": {}
},
{
"name": "customer",
"type": "String",
"selector": ["data", "object", "customer"],
"meta": {}
}
]
}
]
},
{
"handle": "payment_intents",
"meta": {
"short": "Payment Intents",
"description": "Manage the lifecycle of a payment flow."
},
"endpoint": {
"value": "/v1/payment_intents",
"placeholders": []
},
"fields": [
{
"name": "id",
"type": "String",
"selector": ["id"],
"meta": {}
},
{
"name": "amount",
"type": "Integer",
"selector": ["amount"],
"meta": {}
},
{
"name": "currency",
"type": "String",
"selector": ["currency"],
"meta": {}
},
{
"name": "status",
"type": "String",
"selector": ["status"],
"meta": {}
},
{
"name": "customer",
"type": "String",
"selector": ["customer"],
"meta": {}
}
],
"operations": {
"list": {
"method": "GET",
"path": {
"value": "",
"placeholders": []
},
"headers": {},
"queryParams": {},
"bodyTemplate": null
},
"read": {
"method": "GET",
"path": {
"value": "/{{id}}",
"placeholders": [
{
"name": "id",
"type": "String",
"description": "The ID of the payment intent.",
"required": true
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": null
},
"create": {
"method": "POST",
"path": {
"value": "",
"placeholders": []
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "{\"amount\": {{amount}}, \"currency\": \"{{currency}}\"}",
"placeholders": [
{
"name": "amount",
"type": "Integer",
"description": "Amount intended to be collected.",
"required": true
},
{
"name": "currency",
"type": "String",
"description": "Three-letter ISO currency code.",
"required": true
}
]
}
},
"update": {
"method": "POST",
"path": {
"value": "/{{id}}",
"placeholders": [
{
"name": "id",
"type": "String",
"description": "The ID of the payment intent to update.",
"required": true
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "{\"amount\": {{amount}}}",
"placeholders": [
{
"name": "amount",
"type": "Integer",
"description": "Amount intended to be collected.",
"required": false
}
]
}
},
"confirm": {
"method": "POST",
"path": {
"value": "/{{id}}/confirm",
"placeholders": [
{
"name": "id",
"type": "String",
"description": "The ID of the payment intent to confirm.",
"required": true
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": null
}
},
"webhooks": [
{
"event": "payment_intent.succeeded",
"path": "/webhooks/stripe/payment-intent-succeeded",
"payload": [
{
"name": "id",
"type": "String",
"selector": ["data", "object", "id"],
"meta": {}
},
{
"name": "amount",
"type": "Integer",
"selector": ["data", "object", "amount"],
"meta": {}
}
]
}
]
},
{
"handle": "products",
"meta": {
"short": "Products",
"description": "Manage products representing physical or digital goods."
},
"endpoint": {
"value": "/v1/products",
"placeholders": []
},
"fields": [
{
"name": "id",
"type": "String",
"selector": ["id"],
"meta": {}
},
{
"name": "name",
"type": "String",
"selector": ["name"],
"meta": {}
},
{
"name": "description",
"type": "String",
"selector": ["description"],
"meta": {}
},
{
"name": "active",
"type": "Boolean",
"selector": ["active"],
"meta": {}
}
],
"operations": {
"list": {
"method": "GET",
"path": {
"value": "",
"placeholders": []
},
"headers": {},
"queryParams": {},
"bodyTemplate": null
},
"read": {
"method": "GET",
"path": {
"value": "/{{id}}",
"placeholders": [
{
"name": "id",
"type": "String",
"description": "The ID of the product.",
"required": true
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": null
},
"create": {
"method": "POST",
"path": {
"value": "",
"placeholders": []
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "{\"name\": \"{{name}}\"}",
"placeholders": [
{
"name": "name",
"type": "String",
"description": "The product's name.",
"required": true
}
]
}
},
"update": {
"method": "POST",
"path": {
"value": "/{{id}}",
"placeholders": [
{
"name": "id",
"type": "String",
"description": "The ID of the product to update.",
"required": true
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "{\"name\": \"{{name}}\", \"active\": {{active}}}",
"placeholders": [
{
"name": "name",
"type": "String",
"description": "The product's name.",
"required": false
},
{
"name": "active",
"type": "Boolean",
"description": "Whether the product is active.",
"required": false
}
]
}
},
"delete": {
"method": "DELETE",
"path": {
"value": "/{{id}}",
"placeholders": [
{
"name": "id",
"type": "String",
"description": "The ID of the product to delete.",
"required": true
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": null
}
},
"webhooks": []
},
{
"handle": "prices",
"meta": {
"short": "Prices",
"description": "Manage prices which map to products."
},
"endpoint": {
"value": "/v1/prices",
"placeholders": []
},
"fields": [
{
"name": "id",
"type": "String",
"selector": ["id"],
"meta": {}
},
{
"name": "product",
"type": "String",
"selector": ["product"],
"meta": {}
},
{
"name": "currency",
"type": "String",
"selector": ["currency"],
"meta": {}
},
{
"name": "unit_amount",
"type": "Integer",
"selector": ["unit_amount"],
"meta": {}
},
{
"name": "active",
"type": "Boolean",
"selector": ["active"],
"meta": {}
},
{
"name": "type",
"type": "String",
"selector": ["type"],
"meta": {}
}
],
"operations": {
"list": {
"method": "GET",
"path": {
"value": "",
"placeholders": []
},
"headers": {},
"queryParams": {},
"bodyTemplate": null
},
"read": {
"method": "GET",
"path": {
"value": "/{{id}}",
"placeholders": [
{
"name": "id",
"type": "String",
"description": "The ID of the price.",
"required": true
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": null
},
"create": {
"method": "POST",
"path": {
"value": "",
"placeholders": []
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "{\"product\": \"{{product}}\", \"currency\": \"{{currency}}\", \"unit_amount\": {{unit_amount}}}",
"placeholders": [
{
"name": "product",
"type": "String",
"description": "The ID of the product.",
"required": true
},
{
"name": "currency",
"type": "String",
"description": "Three-letter ISO currency code.",
"required": true
},
{
"name": "unit_amount",
"type": "Integer",
"description": "The unit amount in cents.",
"required": true
}
]
}
},
"update": {
"method": "POST",
"path": {
"value": "/{{id}}",
"placeholders": [
{
"name": "id",
"type": "String",
"description": "The ID of the price to update.",
"required": true
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "{\"active\": {{active}}}",
"placeholders": [
{
"name": "active",
"type": "Boolean",
"description": "Whether the price is active.",
"required": false
}
]
}
}
},
"webhooks": []
},
{
"handle": "invoices",
"meta": {
"short": "Invoices",
"description": "Manage customer invoices."
},
"endpoint": {
"value": "/v1/invoices",
"placeholders": []
},
"fields": [
{
"name": "id",
"type": "String",
"selector": ["id"],
"meta": {}
},
{
"name": "customer",
"type": "String",
"selector": ["customer"],
"meta": {}
},
{
"name": "status",
"type": "String",
"selector": ["status"],
"meta": {}
},
{
"name": "total",
"type": "Integer",
"selector": ["total"],
"meta": {}
},
{
"name": "currency",
"type": "String",
"selector": ["currency"],
"meta": {}
}
],
"operations": {
"list": {
"method": "GET",
"path": {
"value": "",
"placeholders": []
},
"headers": {},
"queryParams": {},
"bodyTemplate": null
},
"read": {
"method": "GET",
"path": {
"value": "/{{id}}",
"placeholders": [
{
"name": "id",
"type": "String",
"description": "The ID of the invoice.",
"required": true
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": null
},
"create": {
"method": "POST",
"path": {
"value": "",
"placeholders": []
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "{\"customer\": \"{{customer}}\"}",
"placeholders": [
{
"name": "customer",
"type": "String",
"description": "The ID of the customer.",
"required": true
}
]
}
},
"update": {
"method": "POST",
"path": {
"value": "/{{id}}",
"placeholders": [
{
"name": "id",
"type": "String",
"description": "The ID of the invoice to update.",
"required": true
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "{\"description\": \"{{description}}\"}",
"placeholders": [
{
"name": "description",
"type": "String",
"description": "An arbitrary string attached to the object.",
"required": false
}
]
}
},
"delete": {
"method": "DELETE",
"path": {
"value": "/{{id}}",
"placeholders": [
{
"name": "id",
"type": "String",
"description": "The ID of the invoice to delete.",
"required": true
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": null
},
"pay": {
"method": "POST",
"path": {
"value": "/{{id}}/pay",
"placeholders": [
{
"name": "id",
"type": "String",
"description": "The ID of the invoice to pay.",
"required": true
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": null
}
},
"webhooks": [
{
"event": "invoice.paid",
"path": "/webhooks/stripe/invoice-paid",
"payload": [
{
"name": "id",
"type": "String",
"selector": ["data", "object", "id"],
"meta": {}
},
{
"name": "customer",
"type": "String",
"selector": ["data", "object", "customer"],
"meta": {}
}
]
}
]
},
{
"handle": "checkout_sessions",
"meta": {
"short": "Checkout Sessions",
"description": "Manage Stripe Checkout sessions."
},
"endpoint": {
"value": "/v1/checkout/sessions",
"placeholders": []
},
"fields": [
{
"name": "id",
"type": "String",
"selector": ["id"],
"meta": {}
},
{
"name": "url",
"type": "String",
"selector": ["url"],
"meta": {}
},
{
"name": "status",
"type": "String",
"selector": ["status"],
"meta": {}
},
{
"name": "customer",
"type": "String",
"selector": ["customer"],
"meta": {}
},
{
"name": "payment_intent",
"type": "String",
"selector": ["payment_intent"],
"meta": {}
}
],
"operations": {
"list": {
"method": "GET",
"path": {
"value": "",
"placeholders": []
},
"headers": {},
"queryParams": {},
"bodyTemplate": null
},
"read": {
"method": "GET",
"path": {
"value": "/{{id}}",
"placeholders": [
{
"name": "id",
"type": "String",
"description": "The ID of the checkout session.",
"required": true
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": null
},
"create": {
"method": "POST",
"path": {
"value": "",
"placeholders": []
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "{\"success_url\": \"{{success_url}}\", \"mode\": \"{{mode}}\"}",
"placeholders": [
{
"name": "success_url",
"type": "String",
"description": "The URL to which Stripe should send customers when payment or setup is complete.",
"required": true
},
{
"name": "mode",
"type": "String",
"description": "The mode of the Checkout Session.",
"required": true
}
]
}
}
},
"webhooks": [
{
"event": "checkout.session.completed",
"path": "/webhooks/stripe/checkout-session-completed",
"payload": [
{
"name": "id",
"type": "String",
"selector": ["data", "object", "id"],
"meta": {}
},
{
"name": "payment_intent",
"type": "String",
"selector": ["data", "object", "payment_intent"],
"meta": {}
}
]
}
]
},
{
"handle": "payment_links",
"meta": {
"short": "Payment Links",
"description": "A Payment Link is a shareable URL that will take your customers to a hosted payment page."
},
"endpoint": {
"value": "/v1/payment_links",
"placeholders": []
},
"fields": [
{
"name": "id",
"type": "String",
"selector": ["id"],
"meta": {}
},
{
"name": "url",
"type": "String",
"selector": ["url"],
"meta": {}
},
{
"name": "active",
"type": "Boolean",
"selector": ["active"],
"meta": {}
}
],
"operations": {
"list": {
"method": "GET",
"path": {
"value": "",
"placeholders": []
},
"headers": {},
"queryParams": {},
"bodyTemplate": null
},
"read": {
"method": "GET",
"path": {
"value": "/{{id}}",
"placeholders": [
{
"name": "id",
"type": "String",
"description": "The ID of the payment link.",
"required": true
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": null
},
"create": {
"method": "POST",
"path": {
"value": "",
"placeholders": []
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "{\"line_items\": [{\"price\": \"{{price}}\", \"quantity\": {{quantity}}}]}",
"placeholders": [
{
"name": "price",
"type": "String",
"description": "The ID of the Price or Plan object.",
"required": true
},
{
"name": "quantity",
"type": "Integer",
"description": "The quantity of the line item being purchased.",
"required": true
}
]
}
},
"update": {
"method": "POST",
"path": {
"value": "/{{id}}",
"placeholders": [
{
"name": "id",
"type": "String",
"description": "The ID of the payment link to update.",
"required": true
}
]
},
"headers": {},
"queryParams": {},
"bodyTemplate": {
"value": "{\"active\": {{active}}}",
"placeholders": [
{
"name": "active",
"type": "Boolean",
"description": "Whether the payment link is active.",
"required": false
}
]
}
}
},
"webhooks": []
}
]