create_offer
Create a discount offer for a tier by specifying name, code, tier, discount type and amount, cadence, and optional duration and display information.
Instructions
Create a discount offer against a tier.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| code | Yes | Shortcode for the offer URL (yoursite.com/<code>). | |
| name | Yes | Internal name (must be unique). | |
| type | Yes | ``percent`` or ``fixed`` — whether ``amount`` is a percentage or a fixed value. | |
| amount | Yes | The discount, in percent or the smallest currency unit per ``type``. | |
| cadence | Yes | ``month`` or ``year`` — which of the tier's prices the offer applies to. | |
| tier_id | Yes | The tier the offer applies to (from ``list_tiers``). | |
| currency | No | Required when ``type="fixed"``; must match the tier's currency. | |
| duration | No | ``once``, ``forever``, or ``repeating`` (``repeating`` needs ``cadence="month"``). | once |
| display_title | No | Title shown in the offer window. | |
| duration_in_months | No | Months to repeat when ``duration="repeating"``. | |
| display_description | No | Text shown in the offer window. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||