Get Coupon - View Discount Code Details via API

Fetch complete details for a single discount coupon by its ID. The response includes the coupon type, discount amount or percentage, applicable plans, usage restrictions, and redemption statistics—everything you need to audit or display coupon information.

GET/v2/projects/{project_id}/coupons/{coupon_id}

Authorization

Bearer TokenRequired

Path Parameters

project_idstringRequired

The unique identifier of the project.

coupon_idstringRequired

The unique identifier of the coupon.

Request

curl -X GET "https://api.botsubscription.com/v2/projects/f47ac10b-58cc-4372-a567-0e02b2c3d479/coupons/coupon_abc123" \
  -H "Authorization: Bearer YOUR_TOKEN"

const project_id = 'f47ac10b-58cc-4372-a567-0e02b2c3d479';
const coupon_id = 'coupon_abc123';
const response = await fetch(`https://api.botsubscription.com/v2/projects/${project_id}/coupons/${coupon_id}`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN'
  }
});
const data = await response.json();

import requests
 
project_id = 'f47ac10b-58cc-4372-a567-0e02b2c3d479'
coupon_id = 'coupon_abc123'
response = requests.get(
    f'https://api.botsubscription.com/v2/projects/{project_id}/coupons/{coupon_id}',
    headers={'Authorization': 'Bearer YOUR_TOKEN'}
)
data = response.json()

$project_id = 'f47ac10b-58cc-4372-a567-0e02b2c3d479';
$coupon_id = 'coupon_abc123';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.botsubscription.com/v2/projects/{$project_id}/coupons/{$coupon_id}");
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_TOKEN']);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);

Successapplication/json

{
  "ok": true,
  "request_id": "11111111-1111-1111-1111-111111111111",
  "method": "GET",
  "path": "/v2/projects/YOUR_PROJECT_ID/coupons/11111111-1111-1111-1111-111111111111",
  "code": 200,
  "data": {
    "coupon_id": "11111111-1111-1111-1111-111111111111",
    "code": "SUMMER2024",
    "display_name": "Summer Sale",
    "description": "Summer promotion discount",
    "coupon_type": "percentage",
    "percentage": "20",
    "auto_apply": false,
    "status": "active",
    "total_redemptions": 45,
    "total_reservations": 0,
    "invitee_mode": "all",
    "renewal_constraint": "any",
    "payment_count_comparator": "any",
    "lifetime_revenue_comparator": "any",
    "plan_scope": "all",
    "created_at": "2024-05-15T10:00:00.000Z",
    "metadata": {}
  }
}

Coupon not foundapplication/json

{
  "ok": false,
  "request_id": "11111111-1111-1111-1111-111111111111",
  "method": "GET",
  "path": "/v2/projects/YOUR_PROJECT_ID/coupons/11111111-1111-1111-1111-111111111111",
  "code": 404,
  "error": {
    "error_code": "NOT_FOUND",
    "message": "Requested resource could not be found"
  }
}

Last updated: January 25, 2026

API Endpoint

Get Coupon - View Discount Code Details via API

Authorization

Path Parameters