Sign in
Coupons

Get coupon details

get/api/v1/coupons/{coupon_id}

Path parameters

coupon_idstring MeteroidId required
Example:cou_7n42DGM5Tflk9n8mt7Fhc7

Coupon ID

Response

Coupon details

archived_atstring date-time nullable
codestring required
created_atstring date-time required
descriptionstring nullable
disabledboolean required
expires_atstring date-time nullable
idstring MeteroidId required
plan_idsPlanId[] required
recurring_valueinteger nullable
redemption_countinteger required
redemption_limitinteger nullable
reusableboolean required

Example response

{
  "id": "cou_7n42DGM5Tflk9n8mt7Fhc7",
  "plan_ids": [
    "plan_7n42DGM5Tflk9n8mt7Fhc7"
  ]
}

Changes

Changed in 5 of the 54 revisions of this API.527

  • v14e013b4e4a8f24See the full diff
    • ▲

      the response property description became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property description became optional for the status 200

      response-property-became-optional

    • ○

      added the optional property archived_at to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property created_at to the response with the 200 status

      response-required-property-added

    • ○

      added the required property plan_ids to the response with the 200 status

      response-required-property-added

    • ○

      added the required property redemption_count to the response with the 200 status

      response-required-property-added

  • v1ee465c53a42321See the full diff
    • ▲

      the discount/oneOf[FixedDiscount]/amount response's property type/format changed from string/decimal to string/ for status 200

      response-property-type-changed

    • ▲

      the discount/oneOf[PercentageDiscount]/percentage response's property type/format changed from string/decimal to string/ for status 200

      response-property-type-changed

    • ○

      response discriminator property name changed for discount response property from discriminator to type for the response status 200

      response-property-discriminator-property-name-changed

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v1de35c02bb0d221See the full diff
    • ●

      added the new TOO_MANY_REQUESTS enum value to the code response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new TOO_MANY_REQUESTS enum value to the code response property for the response status 404

      response-property-enum-value-added

    • ○

      added the non-success response with the status 429

      response-non-success-status-added

  • v151c7018cc5ef1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v1dece17f86f991See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 274 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog