Skip to content
Proud to collaborate with Microsoft for Startups

stripe.charge.hosted ​

Ensure the customer then create a hosted Stripe checkout and return its URL

One call from "who is paying" to "here is the payment URL".

Ensures the Stripe customer exists (by email, when no customer_id is given) and creates the hosted Checkout Session against it, carrying client_reference_id through so stripe.access.grant_on_payment can entitle the right end-user when the webhook arrives.

Mirrors abacatepay.charge.hosted.

Overview ​

PropertyValue
Workflow typeDag
LibraryApp-stripe
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes——
cloud_connection_uuiduuidYes—Org-scoped Stripe connection (customer's own account)
price_idstringYes—Price to charge
success_urlstringYes—Redirect URL after successful payment
cancel_urlstringYes—Redirect URL when the payer cancels
modestringNo—payment
quantityintegerNo—Line-item quantity (default: 1)
customer_idstringNo—Existing Stripe customer; skips customer creation
customer_emailstringNo—Create/attach a customer with this email
customer_namestringNo—Name for a newly created customer
client_reference_idstringNo—End-user uuid to carry onto the payment
metadatajsonNo—Metadata stored on the session

Output Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes——
cloud_connection_uuiduuidYes——
session_idstringNo——
session_urlstringNo——
statusstringNo——
customer_idstringNo——
created_customerbooleanNo——
ensure_customerjsonNo——
create_sessionjsonNo——
price_idstringNo——
success_urlstringNo——
cancel_urlstringNo——
modestringNo——
quantityintegerNo——
customer_emailstringNo——
customer_namestringNo——
client_reference_idstringNo——
metadatajsonNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepjsonNo——
failed_layerintegerNo——
errorstringNo——
error_typestringNo——

DAG Layers ​

#LayerStepsCompensation
1customerstripe.customers.create_customer—
2checkoutstripe.checkout.create_session—

Execution Flow ​

Sub-workflows ​

Sub-workflowStep name
stripe.customers.create_customerensure_customer
stripe.checkout.create_sessioncreate_session

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "stripe.charge.hosted",
  "initial_data": {
    "organization_uuid": "value",
    "cloud_connection_uuid": "value",
    "price_id": "value",
    "success_url": "value"
  }
}