List all coupons

🚧 Beta: This endpoint may not be available yet and may change without notice.
Contact support to request access.

Retrieve a list of coupons for the school. Excludes single-use and student-referral coupons. Without product context, returns only school-wide (non-product-specific) coupons.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean
integer

Filter by pricing plan ID. Meaningful on schools not using the new payments experience; on schools using the new payments experience, matches only coupons scoped by pricing plan (typically empty).

string
enum

Filter by product. On schools using the new payments experience, resolves via the product itself; otherwise resolves via the pricing plans attached to it. Must be paired with product_id.

integer

ID of the entity identified by product_type; required when product_type is present.

string

ISO8601 datetime; invalid values return 400. Date range between created_after and created_before cannot exceed 90 days.

string

ISO8601 datetime; invalid values return 400. Date range between created_after and created_before cannot exceed 90 days.

integer
≄ 1
integer
1 to 100
string

Sort by field (created_at, updated_at)

string

Sort direction (asc, desc)

Headers
string
required

Generated Admin API key

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json