Billing

Retrieve a discount coupon.

get/api/v1/billing/discountcoupons/{discountCouponUid}

Request

  • Base URL: https://go.outseta.com
  • URL: https://go.outseta.com/api/v1/billing/discountcoupons/{discountCouponUid}
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Path parameters

discountCouponUidstring nullable required

The discount coupon's unique identifier

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.