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

BodyJSON

Mock

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

Update Coupon - Modify Discount Code Settings via API

Modify an existing discount coupon's settings. Change the discount amount, update targeting rules, toggle auto-apply, or archive the coupon to stop new redemptions. Only the fields you include in the request body are updated.

PATCH/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 Body

display_namestring

Display name for the coupon.

descriptionstring

A description of the coupon.

percentagestring

Discount percentage as a decimal string (for percentage type coupons).

amountstring

Fixed discount amount as a decimal string (for fixed type coupons).

auto_applyboolean

Whether to auto-apply this coupon.

statusstring

Coupon status: active or archived.

invitee_modestring

Who can use: all, inviteesOnly, nonInvitees.

renewal_constraintstring

When applicable: any, renewalOnly, churnedOnly.

plan_scopestring

Which plans: all, include, exclude (plan_ids required when include or exclude).

starts_atnumber | string

Validity start: Unix milliseconds or ISO-8601 string.

ends_atnumber | string

Validity end: Unix milliseconds or ISO-8601 string.

metadataobject

Custom metadata for the coupon.

curl -X PATCH "https://api.botsubscription.com/v2/projects/f47ac10b-58cc-4372-a567-0e02b2c3d479/coupons/coupon_abc123" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "percentage": "25",
    "ends_at": 1727740799000
  }'

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: 'PATCH',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    percentage: '25',
    ends_at: 1727740799000
  })
});
const data = await response.json();

import requests
 
project_id = 'f47ac10b-58cc-4372-a567-0e02b2c3d479'
coupon_id = 'coupon_abc123'
response = requests.patch(
    f'https://api.botsubscription.com/v2/projects/{project_id}/coupons/{coupon_id}',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'percentage': '25',
        'ends_at': 1727740799000
    }
)
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_CUSTOMREQUEST, 'PATCH');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer YOUR_TOKEN',
    'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
    'percentage' => '25',
    'ends_at' => 1727740799000
]));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);

Coupon updatedapplication/json

{
  "ok": true,
  "request_id": "11111111-1111-1111-1111-111111111111",
  "method": "PATCH",
  "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": "Updated summer discount",
    "coupon_type": "percentage",
    "percentage": "25",
    "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": 1715767200000,
    "archived_at": null,
    "metadata": {}
  }
}

Coupon not foundapplication/json

{
  "ok": false,
  "request_id": "11111111-1111-1111-1111-111111111111",
  "method": "PATCH",
  "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: July 8, 2026