Stripe: Retrieve a feedback option

← Billing operations · Get started

Operation stripe.getbillingfeedbackoptionsid

Provider route: GET /v1/billing/feedback_options/{id}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/stripe with npm, or alter-sdk-stripe with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { StripeIntegration } from "@alter-ai/stripe";

async function execute(input: Parameters<StripeIntegration["billing"]["getBillingFeedbackOptionsId"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new StripeIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.billing.getBillingFeedbackOptionsId(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_stripe import StripeIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = StripeIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.billing.get_billing_feedback_options_id(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.id	string	Required within parent	Maximum length: 5000
query	object	Optional	Additional keys: not allowed
query.expand	array	Optional
query.expand[]	string	Each item	Maximum length: 5000

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Create a feedback option — response body

Referenced models: Create a feedback option — response body

Schemas

Create a feedback option — response body

Field	Type	Presence	Description and constraints
$	object	Root	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](/api/customer_portal/configuration). Related guide: [Customer management](/customer-management)
description	string	Required within parent	An arbitrary string attached to the object. Often useful for displaying to users. Maximum length: 5000
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: billing.feedback_option
status	string	Required within parent	The feedback option's status. Known values: active, inactive
status_transitions	Model	Required within parent	Expand Create a feedback option — response body — status transitions

Referenced models: Create a feedback option — response body — status transitions

Create a feedback option — response body — status transitions

Field	Type	Presence	Description and constraints
$	object	Root
deactivated_at	JSON	Optional
deactivated_at (anyOf 1)	JSON	Alternative
deactivated_at (anyOf 1) (anyOf 1)	integer	Alternative	The time the feedback option was deactivated, if any. Measured in seconds since Unix epoch. Format: unix-time
deactivated_at (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
deactivated_at (anyOf 2)	null	Alternative

Policy, approvals and errors

SDK function policy ID: stripe.getbillingfeedbackoptionsid. Catalog operation: GetBillingFeedbackOptionsId. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"Stripe-Version": "2026-09-30.endive"}

Official provider source