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

Update a feedback option

POST /v1/billing/feedback_options/:id

Updates the description of an existing feedback option.

Parameters

  • idstringRequired

    The ID of the feedback option to update.

  • descriptionstring

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

    The maximum length is 100 characters.

Returns

Returns the updated feedback option object.

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

Retrieve a feedback option

GET /v1/billing/feedback_options/:id

Retrieves a feedback option object given an ID.

Parameters

  • idstringRequired

    The ID of the feedback option to retrieve.

Returns

Returns a feedback option object if a valid ID was provided. Raises an error otherwise.

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

List all feedback options

GET /v1/billing/feedback_options

Returns a list of your feedback options.

Parameters

No parameters.

More parameters

  • ending_beforestring

  • limitinteger

  • starting_afterstring

  • statusenum

Returns

Returns a list of feedback option objects. Pass the status parameter to return only active or only inactive feedback options.

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