close
Core Resources
Payment Methods
Products
Commerce
Agentic Commerce
Checkout
Payment Links
Billing
Capital
Connect
Reserves
Fraud
Issuing
Terminal
Treasury for Platforms
Payment Records
Account Evaluation
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Privacy
Webhooks

Feedback Options

A feedback option is a reason you can present to customers when they cancel a subscription through the customer portal. Configure the set of options a customer can choose from on a portal configuration.

Related guide: Customer management

Was this section helpful?YesNo
Create a feedback option
POST/v1/billing/feedback_options
Update a feedback option
POST/v1/billing/feedback_options/:id
Retrieve a feedback option
GET/v1/billing/feedback_options/:id
List all feedback options
GET/v1/billing/feedback_options
Deactivate a feedback option
POST/v1/billing/feedback_options/:id/deactivate

The Feedback Option object

Attributes

  • idstring

    Unique identifier for the object.

  • objectstring, value is "billing.feedback_option"

    String representing the object’s type. Objects of the same type share the same value.

  • descriptionstring

    An arbitrary string attached to the object. Often useful for displaying to users.

  • livemodeboolean

    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

  • statusenum

    The feedback option’s status.

    Possible enum values
    active

    The feedback option is active and available for use.

    inactive

    The feedback option has been deactivated and is no longer available for use.

  • status_transitionsobject

    Set of key-value pairs indicating when the feedback option transitioned to a given status.

The Feedback Option object
{
  "id": "fo_1MowQVLkdIwHu7ixeRlqHVzs",
  "object": "billing.feedback_option",
  "description": "Too expensive",
  "livemode": false,
  "status": "active",
  "status_transitions": {
    "deactivated_at": null
  }
}

Create a feedback option

POST /v1/billing/feedback_options

Creates a new feedback option.

Parameters

  • descriptionstringRequired

    The text of the feedback option, which customers see when canceling. Maximum 100 characters.

    The maximum length is 100 characters.

Returns

Returns the newly created feedback option object.

curl https://api.stripe.com/v1/billing/feedback_options \
  -u "sk_test_BQokikJOvBiI2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d "description=Too expensive"
Response
{
  "id": "fo_1MowQVLkdIwHu7ixeRlqHVzs",
  "object": "billing.feedback_option",
  "description": "Too expensive",
  "livemode": false,
  "status": "active",
  "status_transitions": {
    "deactivated_at": null
  }
}