Coupons

Get a coupon

One coupon with its currency ISO code loaded. A coupon of another project, or a deleted one, is 404 RESOURCE_NOT_FOUND.

Three fields that are easy to misread

plan_ids: [] means every plan, not no plans. An empty array is how the coupon itself reads an empty plan relation: the code applies to every plan in the project, including plans added later. Treating it as "restricted to nothing" inverts the meaning.

redemptions.remaining is derived, not stored. Prefer it over computing max_redemptions - count yourself. The quota counts settled redemptions plus reservations whose hold has not expired, so an in-flight checkout is already accounted for, and an abandoned one returns its slot without any sweeper job. Your own subtraction will disagree.

discount.value is a decimal string with four places: "25.0000" for 25% off, "10.0000" for ten of the coupon's currency. Parse it as a decimal, never a float. currency_id is null on a percentage coupon and set on a fixed-amount one, because a percentage applies to a plan in any currency and a fixed amount only to plans priced in its own.

currency (the ISO code) is present only when the relation is loaded: on a single read, a create and an update, not on every list row.

get/v1/projects/{project}/coupons/{coupon}

Request

  • Base URL: https://api.subscriby.net
  • URL: https://api.subscriby.net/v1/projects/{project}/coupons/{coupon}
  • Auth: HTTP bearer

Path parameters

projectstring uuid required

The project, resolved by the route binder.

couponstring uuid required

The coupon, resolved within the project by the route binder.

Response

The coupon.

Example response

{
  "data": {
    "id": "4b9d3e08-a1f6-4275-9c83-7e01d6a2f594",
    "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",
    "code": "BLACKFRIDAY",
    "name": "Black Friday 2026",
    "discount": {
      "type": "percentage",
      "value": "25.0000"
    },
    "duration": "once",
    "limits": {
      "max_redemptions": 500,
      "max_redemptions_per_user": 1
    },
    "redemptions": {
      "count": 137,
      "remaining": 363
    },
    "window": {
      "starts_at": "2026-11-27T00:00:00+00:00",
      "expires_at": "2026-12-01T00:00:00+00:00"
    },
    "active": true,
    "redeemable": true,
    "created_at": "2026-11-20T09:14:02+00:00",
    "updated_at": "2026-11-24T16:41:11+00:00"
  }
}

Changes

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