Skip to content

Stripe: List all feedback options

Stripe billing.getBillingFeedbackOptions: arguments, response, policy and SDK examples.

← Billing operations · Get started

Operation stripe.getbillingfeedbackoptions

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

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"]["getBillingFeedbackOptions"]>[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.getBillingFeedbackOptions(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(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.ending_beforestringOptionalMaximum length: 5000
query.expandarrayOptional
query.expand[]stringEach itemMaximum length: 5000
query.limitintegerOptional
query.starting_afterstringOptionalMaximum length: 5000
query.statusstringOptionalOne of: active, inactive

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

FieldTypePresenceDescription and constraints
$objectRootResource for the List Endpoint of Feedback Option.
dataarrayRequired within parent
data[]ModelEach itemExpand Create a feedback option — response body
has_morebooleanRequired within parentTrue if this list has another page of items after this one that can be fetched.
objectstringRequired within parentString representing the object’s type. Objects of the same type share the same value. Always has the value `list`.
Known values: list
urlstringRequired within parentThe URL where this list can be accessed.
Maximum length: 5000

Referenced models: Create a feedback option — response body

Create a feedback option — response body
FieldTypePresenceDescription and constraints
$objectRootA 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)
descriptionstringRequired within parentAn arbitrary string attached to the object. Often useful for displaying to users.
Maximum length: 5000
idstringRequired within parentUnique identifier for the object.
Maximum length: 5000
livemodebooleanRequired within parentIf the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
objectstringRequired within parentString representing the object's type. Objects of the same type share the same value.
Known values: billing.feedback_option
statusstringRequired within parentThe feedback option's status.
Known values: active, inactive
status_transitionsModelRequired within parentExpand 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
FieldTypePresenceDescription and constraints
$objectRoot
deactivated_atJSONOptional
deactivated_at (anyOf 1)JSONAlternative
deactivated_at (anyOf 1) (anyOf 1)integerAlternativeThe time the feedback option was deactivated, if any. Measured in seconds since Unix epoch.
Format: unix-time
deactivated_at (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
deactivated_at (anyOf 2)nullAlternative

SDK function policy ID: stripe.getbillingfeedbackoptions. Catalog operation: GetBillingFeedbackOptions. 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

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.