Skip to main content
POST
/
coupons
Create a coupon
curl --request POST \
  --url https://core.nozle.app/api/v1/coupons \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "coupon": {
    "name": "Startup Deal",
    "code": "startup_deal",
    "coupon_type": "fixed_amount",
    "frequency": "recurring",
    "expiration": "time_limit",
    "description": "I am a coupon description",
    "amount_cents": 5000,
    "amount_currency": "USD",
    "reusable": false,
    "percentage_rate": null,
    "frequency_duration": 6,
    "expiration_at": "2022-08-08T23:59:59Z",
    "applies_to": {
      "plan_codes": [
        "startup_plan"
      ],
      "billable_metric_codes": []
    }
  }
}
'
{
  "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"
  }
}

Authorizations

Authorization
string
header
required

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

Body

application/json

Coupon payload

coupon
object
required

Response

Coupon created

coupon
object
required