stripe.payment_links.create_link ​
Create a reusable Stripe payment link
Create a durable, shareable payment URL for a price.
Unlike a Checkout Session (single use, expires), a payment link can be posted in a bio, a WhatsApp message, or a QR code and reused by many payers.
Acts on the CUSTOMER'S OWN Stripe account, authenticated via the org-scoped Stripe connection selected by cloud_connection_uuid.
Inputs:
- cloud_connection_uuid: Org-scoped Stripe connection (customer's own account).
- price_id: Price to charge.
- quantity: Line-item quantity (default: 1) (optional).
- after_completion_url: Redirect URL after payment (optional).
- metadata: Arbitrary key-value metadata (optional).
Outputs (terminal state_data):
- payment_link_id: str
- url: str — the shareable URL
- active: bool
Connection required: cloud_connection_uuid — the organization's own Stripe account credentials; there is no platform-key fallback.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-stripe |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
cloud_connection_uuid | uuid | Yes | — | Org-scoped Stripe connection (customer's own account) |
price_id | string | Yes | — | Price to charge |
quantity | integer | No | — | Line-item quantity (default: 1) |
after_completion_url | string | No | — | Redirect URL after payment |
metadata | json | No | — | Arbitrary key-value metadata |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
payment_link_id | string | No | — | — |
url | string | No | — | — |
active | boolean | No | — | — |
cloud_connection_uuid | uuid | No | — | — |
price_id | string | No | — | — |
quantity | integer | No | — | — |
after_completion_url | string | No | — | — |
metadata | json | No | — | — |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_at_state | string | No | — | — |
failed_step | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
failed_layer | integer | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | execute | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | execute | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "stripe.payment_links.create_link",
"initial_data": {
"cloud_connection_uuid": "value",
"price_id": "value"
}
}