stripe.promotion_codes.create_code

Create a Stripe promotion code for an existing coupon

Create the string a shopper actually types at checkout, pointing at an existing coupon. Omit code and Stripe generates one.

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).
• coupon_id: Coupon this code applies.
• code: Customer-facing code (generated when omitted) (optional).
• max_redemptions: How many times this code can be used (optional).
• expires_at: Unix timestamp after which the code stops working (optional).
• active: Whether the code is usable (default: true) (optional).

Outputs (terminal state_data):

• promotion_code_id: str
• code: str
• coupon_id: str
• 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)
coupon_id	string	Yes	—	Coupon this code applies
code	string	No	—	Customer-facing code (generated when omitted)
max_redemptions	integer	No	—	How many times this code can be used
expires_at	integer	No	—	Unix timestamp after which the code stops working
active	boolean	No	—	Whether the code is usable (default: true)

Output Schema

Field	Type	Required	Default	Description
promotion_code_id	string	No	—	—
code	string	No	—	—
coupon_id	string	No	—	—
active	boolean	No	—	—
cloud_connection_uuid	uuid	No	—	—
max_redemptions	integer	No	—	—
expires_at	integer	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

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

{
  "workflow_type": "stripe.promotion_codes.create_code",
  "initial_data": {
    "cloud_connection_uuid": "value",
    "coupon_id": "value"
  }
}