| Name | Type | Description | Notes |
|---|---|---|---|
| created | DateTime | { "description" : "The UTC DateTime when the object was created.", "verbs":[] } | [optional] |
| changed_by | String | { "description" : "ID of the user who last updated the entity.", "verbs":[] } | [optional] |
| updated | DateTime | { "description" : "The UTC DateTime when the object was last updated.", "verbs":[] } | [optional] |
| name | String | { "description" : "", "verbs":["POST","GET"] } | |
| coupon_code | String | { "description" : "Code used to identify this set of coupons. If unique codes are required this will be used as the prefix to generate individual coupon codes. When a unique code is returned the original couponCode is returned in the parentCouponCode property. For example a single coupon code SUMMER maybe be issued at an event to encourage sign-up, the same code can be redeemed by multiple accounts. In another example you may want to issue unique coupon codes per a customer, for example SUMMER-A4FC, SUMMER-BCQ4, each code can only be calimed once.", "verbs":["POST","GET"] } | |
| coupons | Integer | { "default" : "∞", "description" : "Number of times the coupon can be claimed. In the case of generating unique coupon codes this is the maximum quantity that can be genereated. For example set this value to 10 if you want to limit the total number of subscriptions that will use this code to 10.", "verbs":["POST","GET"] } | |
| uses | Integer | { "default" : "∞", "description" : "This specifies how many times a discount will be added to a subscription once the coupon is added. For example if the uses is set to 3 it will discount 3 times, set this to a large number, for example 9999999, to give infinite applications, .", "verbs":["POST","GET"] } | |
| product | String | { "description" : "Name or ID of the product this coupon applies to. Requires a specific rate-plan to be set.", "verbs":["POST"] } | [optional] |
| product_name | String | { "description" : "", "verbs":["GET"] } | [optional] |
| product_id | String | { "description" : "", "verbs":["GET"] } | [optional] |
| product_rate_plan | String | { "description" : "Name or ID of the rate-plan this coupon applies to. ", "verbs":["POST"] } | [optional] |
| product_rate_plan_name | String | { "description" : "", "verbs":["GET"] } | [optional] |
| product_rate_plan_id | String | { "description" : "", "verbs":["GET"] } | [optional] |
| currency | String | { "description" : "If the coupon is not for a specific rate-plan, and can apply to any subscription, the currency should be provivded. Currency is specified by a three character ISO 4217 currency code.", "verbs":["POST","GET"] } | [optional] |
| parent_coupon_code_redeemable | BOOLEAN | { "default" : "true", "description" : "If true the coupon without postfix can be added to a subscription, for example if parentCouponCodeRedeemable is true and the coupon was created with code SUMMER customers could claim using SUMMER. If parentCouponCodeRedeemable is false then only unique coupon codes can be claimed, for example SUMMER-AB4C, SUMMER-YZB4.", "verbs":["POST","GET"] } | [default to false] |
| organization_id | String | ||
| discounts | Array<CouponDiscount> | { "description" : "For each discount item on the coupon, only one discount type should be set between cashDiscount, percentageDiscount and unitsFree. cashDiscount gives a fixed monetary discount, for example $10.00. percentageDiscount gives a percentage discount on the overall invoice cost. unitsFree discounts the pricing by the number of units specified for that component. All discounts are applied against the base cost or units. Discounts are not compound. Discounts will never exceed the value of a pricing component of the overall invoice - thus at most the discount will reduce the cost to zero. If no pricing component is specified the discount will apply to the total invoice cost.", "verbs":["POST","GET"] } | |
| deleted | BOOLEAN | { "description" : "If a coupon has been deleted, any subsequent attempts to add it to a subscription will fail. Note: This will not affect existing subscription using the coupon. Please see deleting a coupon for more details", "verbs":["GET"] } | [optional] [default to false] |
| parent_coupon_code | String | { "description" : "For unique coupon codes this is the original coupon code, for example SUMMER", "verbs":["GET"] } | [optional] |
| applies_to | String | { "description" : "For unique coupon codes this is what the coupon applies to, usually subscription.", "verbs":["GET"] } | [optional] |
| applies_to_id | String | { "description" : "For a coupon added to a subscription this is the the ID of the subscription. This can be used to remove the coupon from the target.", "verbs":["GET"] } | [optional] |
| remaining_uses | Integer | { "description" : "", "verbs":["GET"] } | [optional] |
| used | Integer | { "description" : "", "verbs":["GET"] } | [optional] |
| discount_value | Float | [optional] | |
| valid_until | DateTime | { "description" : "If the coupon was removed from the subscription this is the date and time from when it no ceased to be applied.", "verbs":["GET"] } | [optional] |
This repository was archived by the owner on Oct 17, 2023. It is now read-only.