Delete a coupon

This endpoint is used to delete a coupon.

DELETE /coupons/{code}

cURL

LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"

curl --location --request DELETE "$LAGO_URL/api/v1/coupons/:code" \
  --header "Authorization: Bearer $API_KEY"

200

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

cURL

LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"

curl --location --request DELETE "$LAGO_URL/api/v1/coupons/:code" \
  --header "Authorization: Bearer $API_KEY"

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

code · string · required

Unique code used to identify the coupon.

Example:

"startup_deal"

Response

200

application/json

Coupon deleted

coupon · object · required

Show child attributes