Coupons

Get coupon details

get/v3/subscriptions/{organizationName}/coupons/{coupon}

Request

  • Base URL: https://api.zephyr-cloud.io
  • URL: https://api.zephyr-cloud.io/v3/subscriptions/{organizationName}/coupons/{coupon}
  • Auth: HTTP bearer

Path parameters

couponstring required

Coupon code

Example:ZEPHYR20
organizationNamestring required

Organization name

Example:my-org

Response

Coupon details

stripeCouponIdstring required

Stripe coupon identifier

percentOffnumber nullable

Percentage discount (0-100)

amountOffnumber nullable

Fixed amount discount in cents

productIdsstring[]

Stripe product IDs this coupon applies to

forcedTier'PERSONAL' | 'TEAM' | 'PRO' | 'ENTERPRISE'

If set, forces subscription to this tier

forcedSeatsnumber

If set, forces this number of seats

blockedSeatsboolean

If true, prevents changing seat count

forcedCycle'MONTHLY' | 'YEARLY'

If set, forces this billing cycle

Example response

{
  "stripeCouponId": "ZEPHYR_DISCOUNT_20",
  "percentOff": 20,
  "amountOff": 500,
  "productIds": [
    "prod_123",
    "prod_456"
  ],
  "forcedSeats": 5
}

Changes

No recorded changes to this operation across all 1 revision of this API.