List coupons - Gennia

GET

public

api

billing

coupons

List coupons

curl --request GET \
  --url https://api.gennia.ai/public/api/v1/billing/coupons \
  --header 'X-Api-Key: <api-key>'

{
  "items": [
    {
      "active": true,
      "applicablePlansCount": 123,
      "code": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "currency": "<string>",
      "discountValue": 123,
      "durationMonths": 123,
      "isExhausted": true,
      "isExpired": true,
      "maxUses": 123,
      "name": "<string>",
      "publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "timesUsed": 123,
      "validFrom": "2023-11-07T05:31:56Z",
      "validUntil": "2023-11-07T05:31:56Z"
    }
  ],
  "limit": 123,
  "page": 123,
  "total": 123,
  "totalPages": 123
}

Autorizações

X-Api-Key

string

header

obrigatório

Parâmetros de consulta

page

integer<int32>

padrão:1

1-based page index

limit

integer<int32>

padrão:20

Page size (max 100)

active

boolean

Filter by active flag

Resposta

items

object[]

Show child attributes

limit

integer<int32>

page

integer<int32>

total

integer<int64>

totalPages

integer<int32>

Create couponCreates a coupon. **Side effect:** a Stripe Coupon + Promotion Code are created. Restrictions: percentage discounts must be 1-100; `duration=repeating` requires `durationMonths`; `discountType=fixed_amount` requires `applicablePlanIds`; plans in `applicablePlanIds` must already have a Stripe product and share a currency.

List coupons

curl --request GET \
  --url https://api.gennia.ai/public/api/v1/billing/coupons \
  --header 'X-Api-Key: <api-key>'

{
  "items": [
    {
      "active": true,
      "applicablePlansCount": 123,
      "code": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "currency": "<string>",
      "discountValue": 123,
      "durationMonths": 123,
      "isExhausted": true,
      "isExpired": true,
      "maxUses": 123,
      "name": "<string>",
      "publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "timesUsed": 123,
      "validFrom": "2023-11-07T05:31:56Z",
      "validUntil": "2023-11-07T05:31:56Z"
    }
  ],
  "limit": 123,
  "page": 123,
  "total": 123,
  "totalPages": 123
}