Coupons

Get a coupon collection by id

Changed on
get/couponCollections/{id}

Request

  • Base URL: https://api.brevo.com/v3
  • URL: https://api.brevo.com/v3/couponCollections/{id}
  • Auth: one of:
    • API key in header api-key
    • API key in header partner-key

Path parameters

idstring uuidv4 required

Id of the collection to return

Response

Coupon collection

idstring uuidv4 required

The id of the collection.

namestring uuidv4 required

The name of the collection.

defaultCouponstring required

The default coupon of the collection.

createdAtstring date-time required

Datetime on which the collection was created.

totalCouponsinteger required

Total number of coupons in the collection.

remainingCouponsinteger required

Number of coupons that have not been sent yet.

expirationDatestring date-time

Expiration date for the coupon collection in RFC3339 format.

remainingDaysAlertinteger

If present, an email notification is going to be sent the defined amount of days before the expiration date.

remainingCouponsAlertinteger

If present, an email notification is going to be sent when the total number of available coupons falls below the defined threshold.

Example response

{
  "id": "23befbae-1505-47a8-bd27-e30ef739f32c",
  "name": "SummerPromotions",
  "defaultCoupon": "10 OFF",
  "createdAt": "2023-01-06T05:03:47.053+0000",
  "totalCoupons": 10000,
  "remainingCoupons": 5000,
  "expirationDate": "2024-01-01T00:00:00Z",
  "remainingDaysAlert": 5,
  "remainingCouponsAlert": 5
}

Changes