Pay: offers create
pay_offers_createCreate discount, trial extension, or referral offers with required redeemer rewards; set optional referrer rewards, eligibility, caps, and dates. Discount offers also create Stripe coupons.
Instructions
Create an offer (rewards via convenience flags or raw JSON). Creates an offer of kind discount, trial_extension or referral. A redeemer reward is required, as raw JSON or a shortcut such as trial days or discount percent; referrer reward, eligibility, caps and dates are optional. Discount offers also create a Stripe coupon. Add a code users can enter with pay_offers_add_code.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | No | Offer kind: discount, trial_extension, or referral | |
| name | No | Offer display name | |
| status | No | Initial status: active (default), paused, or expired | |
| total_cap | No | Total redemption cap (omit for unlimited) | |
| valid_from | No | Offer valid-from (ISO date/time) | |
| description | No | Offer description | |
| eligibility | No | Eligibility rules as JSON, e.g. {"match":"all","rules":[{"type":"subscribed_to_plan","plan_ids":[1]}]} | |
| valid_until | No | Offer valid-until (ISO date/time) | |
| per_user_cap | No | Per-user redemption cap (default 1) | |
| redeemer_reward | No | Redeemer reward as JSON, e.g. {"type":"discount","percent_off":50,"duration":"once"} | |
| referrer_reward | No | Referrer reward as JSON (referral offers only) | |
| discount_percent | No | Shortcut: redeemer reward = N% discount (use --discount-duration for recurrence) | |
| discount_duration | No | Discount duration for --discount-percent: once, forever, repeating (default once) | |
| redeemer_trial_days | No | Shortcut: redeemer reward = trial extension of N days | |
| referrer_trial_days | No | Shortcut: referrer reward = trial extension of N days | |
| referrer_subscription_days | No | Shortcut: referrer reward = subscription extension of N days |