Dashboard
APIList Coupons API - View Discount Codes | BotSubscription
API · Coupons
api.botsubscription.com
GET/v1/endpoint
AuthenticationBearer
Token
Stays in this tab. Required for this endpoint — the value below is what gets sent.
Examples
curl --request GET \
  --url https://api.botsubscription.com/v1/endpoint \
  --header 'Authorization: Bearer sk_live_•••'

List Coupons - View All Discount Codes for Your Bot

Get all discount codes configured for your subscription bot. Filter by status (active or archived), search by code, name, or description, or find coupons that apply to specific plans. Each coupon includes redemption statistics and configuration details.

GET/v2/projects/{project_id}/coupons

Authorization

Bearer API KeyRequired

API key scope: coupons:read (required for restricted keys).

Path Parameters

project_idstringrequired

The unique identifier of the project.

Query Parameters

limitinteger

Number of items per page (1-100). Default: 10

offsetinteger

Number of items to skip. Default: 0

statusstring

Filter by status: active or archived

auto_applyboolean

Filter by auto-apply setting

searchstring

Free-text match against code, name, and description

plan_idstring

Only return coupons whose plan_ids include this plan

orderstring

Sort order by created_at: asc or desc

Note

Response examples use the UTC ISO date format.

Coupon decimal fields are returned as strings. Values such as "1e-7" are normalized to "0.0000001", but higher-precision values such as "5e-19" can retain exponent notation. Read values are not rounded to the 18-fractional-digit input limit. Creating, updating or cloning a coupon must satisfy the decimal input rules.

Last updated: