Billing

Retrieve a discount coupon by code.

Used during registration to confirm that a coupon code can still be applied to a plan. Returns the coupon when valid, 404 when no coupon matches the code, or a validation error when the coupon cannot be applied.

get/api/v1/public/billing/discountcoupons/{code}

Request

Base URL: https://go.outseta.com
URL: https://go.outseta.com/api/v1/public/billing/discountcoupons/{code}
Auth: none declared

Path parameters

codestring nullable required

The discount coupon's code

Query parameters

planUidstring nullable required

The unique identifier of the plan to validate the coupon against

Response

Uidstring nullable

_objectTypestring nullable

Createdstring date-time required

Updatedstring date-time required

ActivityEventDataunknown

UniqueIdentifierstring nullable

Namestring nullable

IsActiveboolean

AmountOffnumber nullable

PercentOffnumber nullable

RedeemBystring date-time nullable

Duration1 | 2 | 3

1 - Forever, 2 - Once, 3 - Repeating

DurationInMonthsinteger nullable

TimesRedeemedinteger

MaxRedemptionsinteger nullable

ApplyToAddOnsboolean

IsInUseboolean nullable

PlanUidsstring nullable

Example response

{
  "Uid": "string",
  "_objectType": "string",
  "Created": "string",
  "Updated": "string",
  "ActivityEventData": {},
  "UniqueIdentifier": "string",
  "Name": "string",
  "IsActive": false,
  "AmountOff": 0,
  "PercentOff": 0,
  "RedeemBy": "string",
  "Duration": 1,
  "DurationInMonths": 0,
  "TimesRedeemed": 0,
  "MaxRedemptions": 0,
  "DiscountCouponPlans": [
    {
      "Uid": "string",
      "_objectType": "string",
      "Created": "string",
      "Updated": "string",
      "ActivityEventData": {},
      "Plan": {},
      "DiscountCoupon": {}
    }
  ],
  "ApplyToAddOns": false,
  "IsInUse": false,
  "PlanUids": "string"
}

Changes

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