Dashboard
APISet 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_•••'

Set Return Offer

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

Authorization

Bearer API KeyRequired

API key access: Unrestricted project key only.

Choose an existing project coupon, or send coupon_id: null to turn the offer off. This replaces the configuration: omitting reason_codes resets it to every reason, including skipped feedback. Use none only as an offer filter, never as a cancellation reason code. Other filters are too_expensive, not_using_enough, missing_features, technical_problems, switching, and other.

The coupon must be active, started, unexpired, and have uses available. Renewal-only, invitee-only, and top-up-only coupons cannot serve as return offers. Missing, foreign, or archived coupons return 404; unusable coupons return 422. A concurrent edit returns 409 CONFLICT; reload before trying a new edit.

Read the original offer before editing. The dedicated endpoints handle offer configuration; use them rather than writing an internal setting key.

Path Parameters

project_idstringrequired

Project UUID.

Request Body

coupon_idstring|nullrequired

Existing project coupon UUID, or null to disable offers.

reason_codesstring[]

Unique reason codes; empty or omitted means all reasons, including skipped feedback.

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

Last updated: