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? Yes No

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

id string Unique identifier for the object.
object string, value is "billing.feedback_option" String representing the object’s type. Objects of the same type share the same value.
description string An arbitrary string attached to the object. Often useful for displaying to users.
livemode boolean If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
status enum 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 _ transitions object 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

description string Required 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.

Response

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