List all promotion codes

GET / v1 / promotion_codes

Returns a list of your promotion codes.

Parameters

No parameters.

More parameters

active boolean
code string
coupon string
created object
customer string
customer _ account string
ending _ before string
limit integer
starting _ after string

Returns

A dictionary with a data property that contains an array of up to limit promotion codes, starting after promotion code starting_after. Each entry in the array is a separate promotion code object. If no more promotion codes are available, the resulting array will be empty.

Response

{ "object": "list", "url": "/v1/promotion_codes", "has_more": false, "data": [ { "id": "promo_1MiM6KLkdIwHu7ixrIaX4wgn", "object": "promotion_code", "active": true, "code": "A1H1Q1MG", "promotion": { "type": "coupon", "coupon": "nVJYDOag" }, "created": 1678040164, "customer": null, "expires_at": null, "livemode": false, "max_redemptions": null, "metadata": {}, "restrictions": { "first_time_transaction": false, "minimum_amount": null, "minimum_amount_currency": null }, "times_redeemed": 0 } ]}