Dashboard
APIGet Return Offer | Subscription Bot API
api.botsubscription.com
GET/v1/endpoint
AuthenticationBearer
Token
Stays in this tab. Required for this endpoint — the value below is what gets sent.
Examples
curl --request GET \
  --url https://api.botsubscription.com/v1/endpoint \
  --header 'Authorization: Bearer sk_live_•••'

Get Return Offer

GET/v2/projects/{project_id}/cancel-offer

Authorization

Bearer API KeyRequired

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.

Path Parameters

project_idstringrequired

Project UUID.

See the project API authentication rules for shared request and retry behavior.

Last updated: