openapi/api.yaml in recurly-3.17.0 vs openapi/api.yaml in recurly-3.18.0
- old
+ new
@@ -273,12 +273,12 @@
description: Coupons can either be single codes that easily allow mass distribution
by many customers or bulk coupons that can generate many unique coupons that can
allow for individual delivery and tracking.
- name: coupon_redemption
x-displayName: Coupon Redemption
- description: Coupon redemptions are created when a coupon is applied to an account.
- This allows you to track your promotions.
+ description: Coupon redemptions are created when a coupon is applied to an account
+ or subscription. This allows you to track your promotions.
- name: unique_coupon_code
x-displayName: Unique Coupon Code
description: Unique coupon codes are generated from bulk coupons.
- name: shipping_method
x-displayName: Shipping Method
@@ -2670,11 +2670,11 @@
post:
tags:
- account
- coupon_redemption
operationId: create_coupon_redemption
- summary: Generate an active coupon redemption on an account
+ summary: Generate an active coupon redemption on an account or subscription
parameters:
- "$ref": "#/components/parameters/site_id"
- "$ref": "#/components/parameters/account_id"
requestBody:
content:
@@ -16709,10 +16709,13 @@
type: object
title: Account
description: The Account on which the coupon was applied.
readOnly: true
"$ref": "#/components/schemas/AccountMini"
+ subscription_id:
+ type: string
+ title: Subscription ID
coupon:
"$ref": "#/components/schemas/Coupon"
state:
type: string
title: Coupon Redemption state
@@ -16756,9 +16759,12 @@
currency:
type: string
title: Currency
description: 3-letter ISO 4217 currency code.
maxLength: 3
+ subscription_id:
+ type: string
+ title: Subscription ID
required:
- coupon_id
CouponRedemptionMini:
type: object
properties: