latestOpenAPI 3.1.02026-08-218667571.2 MB
a8ca30023371
Admin APIs
Admin - Reports
Preview Promo Codes
Preview promo code usage by customer + plan.
Source of truth:
- Local plans joined to local stripe_subscriptions.raw
- If the subscription discount references a promotion code id, we retrieve the PromotionCode from Stripe to get the human promo code string (e.g. "SAVE20").
get/api/v1/admin/reports/promo-codes/preview
Query parameters
client_idstring nullable
Filter by client ID
Filter by client ID
has_promo_codestring
Filter by whether a promo code is applied: all|yes|no
Filter by whether a promo code is applied: all|yes|no
promo_codestring nullable
Filter by specific promo code (e.g. SAVE20)
Filter by specific promo code (e.g. SAVE20)
start_datestring nullable
Start date (YYYY-MM-DD)
Start date (YYYY-MM-DD)
end_datestring nullable
End date (YYYY-MM-DD)
End date (YYYY-MM-DD)
pageinteger
Page number
Page number
per_pageinteger
Items per page
Items per page
Response
Successful Response