Skip to content

Stripe: Update a payment method domain

Stripe paymentMethodDomains.postPaymentMethodDomainsPaymentMethodDomain: arguments, response, policy and SDK examples.

← Payment method domains operations · Get started

Operation stripe.postpaymentmethoddomainspaymentmethoddomain

Provider route: POST /v1/payment_method_domains/{payment_method_domain}. 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["paymentMethodDomains"]["postPaymentMethodDomainsPaymentMethodDomain"]>[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.paymentMethodDomains.postPaymentMethodDomainsPaymentMethodDomain(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.payment_method_domains.post_payment_method_domains_payment_method_domain(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.payment_method_domainstringRequired within parentMaximum length: 5000
headersobjectOptionalAdditional keys: not allowed
headers.Idempotency-KeystringOptionalMinimum length: 1
Maximum length: 255
bodyobjectOptionalAdditional keys: not allowed
body.enabledbooleanOptionalWhether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements or Embedded Checkout.
body.expandarrayOptionalSpecifies which fields in the response should be expanded.
body.expand[]stringEach itemMaximum length: 5000

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Create a payment method domain — response body

Referenced models: Create a payment method domain — response body

Create a payment method domain — response body
FieldTypePresenceDescription and constraints
$objectRootA payment method domain represents a web domain that you have registered with Stripe.
Stripe Elements use registered payment method domains to control where certain payment methods are shown.

Related guide: [Payment method domains](https://docs.stripe.com/payments/payment-methods/pmd-registration).
amazon_payModelRequired within parentExpand Create a payment method domain — response body — link
apple_payModelRequired within parentExpand Create a payment method domain — response body — link
createdJSONRequired within parent
created (anyOf 1)integerAlternativeTime at which the object was created. Measured in seconds since the Unix epoch.
Format: unix-time
created (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
domain_namestringRequired within parentThe domain name that this payment method domain object represents.
Maximum length: 5000
enabledbooleanRequired within parentWhether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements.
google_payModelRequired within parentExpand Create a payment method domain — response body — link
idstringRequired within parentUnique identifier for the object.
Maximum length: 5000
klarnaModelRequired within parentExpand Create a payment method domain — response body — link
linkModelRequired within parentExpand Create a payment method domain — response body — link
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: payment_method_domain
paypalModelRequired within parentExpand Create a payment method domain — response body — link

Referenced models: Create a payment method domain — response body — link

Create a payment method domain — response body — link
FieldTypePresenceDescription and constraints
$objectRootIndicates the status of a specific payment method on a payment method domain.
statusstringRequired within parentThe status of the payment method on the domain.
Known values: active, inactive
status_detailsModelOptionalExpand Create a payment method domain — response body — link status details

Referenced models: Create a payment method domain — response body — link status details

Create a payment method domain — response body — link status details
FieldTypePresenceDescription and constraints
$objectRootContains additional details about the status of a payment method for a specific payment method domain.
error_messagestringRequired within parentThe error message associated with the status of the payment method on the domain.
Maximum length: 5000

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