GEgetlago
coupons

Retrieve a coupon

Changed on

This endpoint is used to retrieve a specific coupon.

get/coupons/{code}

Request

Response

Coupon

Example response

{
  "coupon": {
    "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "name": "Startup Deal",
    "code": "startup_deal",
    "description": "I am a coupon description",
    "coupon_type": "fixed_amount",
    "amount_cents": 5000,
    "amount_currency": "USD",
    "reusable": true,
    "limited_plans": true,
    "plan_codes": [
      "startup_plan"
    ],
    "billable_metric_codes": [],
    "frequency": "recurring",
    "frequency_duration": 6,
    "expiration": "time_limit",
    "expiration_at": "2022-08-08T23:59:59Z",
    "created_at": "2022-04-29T08:59:51Z",
    "terminated_at": "2022-08-08T23:59:59Z"
  }
}

Changes

  • 5d26657495a3Revision changes
    • warning

      added the new SYP enum value to the / response property for the response status

    • warning

      added the new TND enum value to the / response property for the response status