api.botsubscription.com

GET/v1/endpoint

AuthenticationBearer

Token

Stays in this tab. Required for this endpoint — the value below is what gets sent.

Path parameters0

Query parameters0

Headers0

BodyJSON

Examples

curl --request GET \
  --url https://api.botsubscription.com/v1/endpoint \
  --header 'Authorization: Bearer sk_live_•••'

Get Coupon - View Discount Code Details via API

Retrieve a discount coupon by its ID to display or audit its configuration and usage.

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

Authorization

Bearer API KeyRequired

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

Path Parameters

project_idstringrequired

The unique identifier of the project.

coupon_idstringrequired

The unique identifier of the coupon.

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.

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

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_API_KEY'
  }
});
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_API_KEY'}
)
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_API_KEY']);
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/11111111-1111-4111-8111-111111111111/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",
    "starts_at": "2024-06-01T00:00:00.000Z",
    "ends_at": "2024-08-31T23:59:59.000Z",
    "created_at": "2024-05-15T10:00:00.000Z",
    "metadata": {},
    "min_spend_amount": "1",
    "min_spend_currency": "USD",
    "max_spend_amount": "100",
    "max_spend_currency": "USD"
  }
}

Coupon not foundapplication/json

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

Invalid or expired API keyapplication/json

{
  "ok": false,
  "request_id": "44444444-4444-4444-8444-444444444444",
  "method": "GET",
  "path": "/v2/projects/11111111-1111-4111-8111-111111111111/coupons/cccccccc-cccc-4ccc-8ccc-cccccccccccc",
  "code": 401,
  "error": {
    "message": "Invalid or expired authentication token.",
    "error_code": "UNAUTHORIZED"
  }
}

Fixed-amount couponapplication/json

{
  "ok": true,
  "request_id": "11111111-1111-1111-1111-111111111111",
  "method": "GET",
  "path": "/v2/projects/11111111-1111-4111-8111-111111111111/coupons/11111111-1111-1111-1111-111111111111",
  "code": 200,
  "data": {
    "coupon_id": "11111111-1111-1111-1111-111111111111",
    "code": "FIXED10",
    "display_name": "Ten dollar discount",
    "description": "Summer promotion discount",
    "coupon_type": "fixed",
    "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",
    "starts_at": "2024-06-01T00:00:00.000Z",
    "ends_at": "2024-08-31T23:59:59.000Z",
    "created_at": "2024-05-15T10:00:00.000Z",
    "metadata": {},
    "min_spend_amount": "1",
    "min_spend_currency": "USD",
    "max_spend_amount": "100",
    "max_spend_currency": "USD",
    "amount": "10",
    "currency": "USD"
  }
}

Last updated: November 4, 2026