Stripe: Update an app install

← Apps operations · Get started

Operation stripe.postappsinstallsid

Provider route: POST /v1/apps/installs/{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["apps"]["postAppsInstallsId"]>[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.apps.postAppsInstallsId(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.apps.post_apps_installs_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
headers	object	Optional	Additional keys: not allowed
headers.Idempotency-Key	string	Optional	Minimum length: 1 Maximum length: 255
body	object	Optional	Additional keys: not allowed
body.expand	array	Optional	Specifies which fields in the response should be expanded.
body.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 an app install — response body

Referenced models: Create an app install — response body

Schemas

Create an app install — response body

Field	Type	Presence	Description and constraints
$	object	Root	An app install represents a Stripe App that is installed on an account. It reports the permissions, content security policy entries, and endpoints that the installing account has authorized, along with any that the app's latest version requests but the account has not authorized yet. Use the Install API to install, reauthorize, and uninstall apps, and to check the state of existing installs.
account	string	Required within parent	The ID of the account that the app install belongs to. Maximum length: 5000
app	string	Required within parent	The ID of the app installed. Maximum length: 5000
approval_required	boolean	Required within parent	Whether the installer must authorize pending permissions, content security policy entries, or endpoints. For private apps, `approval_required` stays `false`; creating or reauthorizing the install through the API installs the newest completed upload and grants its permissions.
auth_code	JSON	Optional
auth_code (anyOf 1)	string	Alternative	The authorization code for an oauth app install. Maximum length: 5000
auth_code (anyOf 2)	null	Alternative
channel	string	Required within parent	The distribution channel associated with the app install. Known values: private_live, private_test, public, review, testing
content_security_policy_granted	Model	Required within parent	Expand Create an app install — response body — content security policy granted
content_security_policy_pending	Model	Required within parent	Expand Create an app install — response body — content security policy granted
created	JSON	Required within parent
created (anyOf 1)	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
created (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
created_by	JSON	Optional
created_by (anyOf 1)	string	Alternative	The ID of the embedding platform that created the install, if applicable. Maximum length: 5000
created_by (anyOf 2)	null	Alternative
endpoints_granted	array	Required within parent	The endpoint URLs authorized by the installer.
endpoints_granted[]	string	Each item	Maximum length: 5000
endpoints_pending	array	Required within parent	The endpoint URLs requested by the latest app version that the installer has not authorized.
endpoints_pending[]	string	Each item	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: apps.install
permissions_granted	array	Required within parent	The permissions authorized by the installer.
permissions_granted[]	string	Each item	Maximum length: 5000
permissions_pending	array	Required within parent	The permissions requested by the latest app version that the installer has not authorized.
permissions_pending[]	string	Each item	Maximum length: 5000
status	string	Required within parent	The status of the app install. Known values: install_failed, installed, installing, uninstall_failed, uninstalling

Referenced models: Create an app install — response body — content security policy granted

Create an app install — response body — content security policy granted

Field	Type	Presence	Description and constraints
$	object	Root
connect_src	array	Required within parent	The URLs that the app can make network requests to.
connect_src[]	string	Each item	Maximum length: 5000
image_src	array	Required within parent	The URLs that the app can load images from.
image_src[]	string	Each item	Maximum length: 5000

Policy, approvals and errors

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