GEgetlago
coupons

List all coupons

Changed on

This endpoint is used to list all existing coupons.

get/coupons

Request

Query parameters

pageinteger
Example:1

Page number. Defaults to 1. A value that is not a positive integer, such as 0, returns the first page.

per_pageinteger
Example:20

Number of records per page. Defaults to 100. The maximum is 200, unless another maximum is configured for your organization. A value above the maximum returns a 422 error with value_is_out_of_range on per_page. A value that is not a positive integer, such as 0, returns the default number of records.

Response

Coupons

Example response

{
  "coupons": [
    {
      "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"
    }
  ],
  "meta": {
    "current_page": 2,
    "next_page": 3,
    "prev_page": 1,
    "total_pages": 4,
    "total_count": 70
  }
}

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