api.botsubscription.com
GET /v1/endpoint
Authentication Bearer
Token
Stays in this tab. Required for this endpoint — the value below is what gets sent.
Request GET Response —
cURL Node Python PHP Go Ruby
Copy curl --request GET \
--url https://api.botsubscription.com/v1/endpoint \
--header 'Authorization: Bearer sk_live_•••'— — · — · —
Response will appear here.
GET /v2/projects/ {project_id} /cancel-offer CopyTry it Authorization Bearer API Key Required
API key access: Unrestricted key, or restricted key with BOTH settings:read and coupons:read.
Read the coupon and cancellation-reason filters configured for return offers. coupon_id: null means the offer is off. An empty reason_codes array includes every reason and skipped feedback. The filter value none means skipped feedback.
Restricted keys need both settings:read and coupons:read. Missing the route's settings:read scope returns 403 FORBIDDEN; a request admitted without coupon-read access can return 401 UNAUTHORIZED.
Use Set Return Offer to change this configuration. Member-specific coupon eligibility is checked later, so an enabled configuration does not promise every member an offer.
curl -X GET "https://api.botsubscription.com/v2/projects/11111111-1111-4111-8111-111111111111/cancel-offer" \
-H "Authorization: Bearer YOUR_API_KEY" Enabled application/json
{
"ok" : true ,
"request_id" : "44444444-4444-4444-8444-444444444444" ,
"method" : "GET" ,
"path" : "/v2/projects/11111111-1111-4111-8111-111111111111/cancel-offer" ,
"code" : 200 ,
"data" : {
"coupon_id" : "55555555-5555-4555-8555-555555555555" ,
"reason_codes" : [
"too_expensive" ,
"none"
]
}
} Disabled application/json
{
"ok" : true ,
"request_id" : "44444444-4444-4444-8444-444444444444" ,
"method" : "GET" ,
"path" : "/v2/projects/11111111-1111-4111-8111-111111111111/cancel-offer" ,
"code" : 200 ,
"data" : {
"coupon_id" : null ,
"reason_codes" : []
}
} UNAUTHORIZED application/json
{
"ok" : false ,
"request_id" : "44444444-4444-4444-8444-444444444444" ,
"method" : "GET" ,
"path" : "/v2/projects/11111111-1111-4111-8111-111111111111/cancel-offer" ,
"code" : 401 ,
"error" : {
"error_code" : "UNAUTHORIZED" ,
"message" : "Invalid or expired authentication token."
}
} FORBIDDEN application/json
{
"ok" : false ,
"request_id" : "44444444-4444-4444-8444-444444444444" ,
"method" : "GET" ,
"path" : "/v2/projects/11111111-1111-4111-8111-111111111111/cancel-offer" ,
"code" : 403 ,
"error" : {
"error_code" : "FORBIDDEN" ,
"message" : "Access is not permitted."
}
} VALIDATION_ERROR application/json
{
"ok" : false ,
"request_id" : "44444444-4444-4444-8444-444444444444" ,
"method" : "GET" ,
"path" : "/v2/projects/11111111-1111-4111-8111-111111111111/cancel-offer" ,
"code" : 422 ,
"error" : {
"error_code" : "VALIDATION_ERROR" ,
"message" : "Invalid request parameters."
}
} See the project API authentication rules for shared request and retry behavior.
Last updated: November 17, 2026