Stripe: List payment method domains

← Payment method domains operations · Get started

Operation stripe.getpaymentmethoddomains

Provider route: GET /v1/payment_method_domains. 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["paymentMethodDomains"]["getPaymentMethodDomains"]>[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.getPaymentMethodDomains(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.get_payment_method_domains(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.domain_name	string	Optional	Maximum length: 5000
query.enabled	boolean	Optional
query.ending_before	string	Optional	Maximum length: 5000
query.expand	array	Optional
query.expand[]	string	Each item	Maximum length: 5000
query.limit	integer	Optional
query.starting_after	string	Optional	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
$	object	Root
data	array	Required within parent
data[]	Model	Each item	Expand Create a payment method domain — response body
has_more	boolean	Required within parent	True if this list has another page of items after this one that can be fetched.
object	string	Required within parent	String representing the object’s type. Objects of the same type share the same value. Always has the value `list`. Known values: list
url	string	Required within parent	The URL where this list can be accessed. Maximum length: 5000 Pattern: ^/v1/payment_method_domains

Referenced models: Create a payment method domain — response body

Schemas

Create a payment method domain — response body

Field	Type	Presence	Description and constraints
$	object	Root	A 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_pay	Model	Required within parent	Expand Create a payment method domain — response body — link
apple_pay	Model	Required within parent	Expand Create a payment method domain — response body — link
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]+)?$
domain_name	string	Required within parent	The domain name that this payment method domain object represents. Maximum length: 5000
enabled	boolean	Required within parent	Whether 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_pay	Model	Required within parent	Expand Create a payment method domain — response body — link
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
klarna	Model	Required within parent	Expand Create a payment method domain — response body — link
link	Model	Required within parent	Expand Create a payment method domain — response body — link
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: payment_method_domain
paypal	Model	Required within parent	Expand 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

Field	Type	Presence	Description and constraints
$	object	Root	Indicates the status of a specific payment method on a payment method domain.
status	string	Required within parent	The status of the payment method on the domain. Known values: active, inactive
status_details	Model	Optional	Expand 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

Field	Type	Presence	Description and constraints
$	object	Root	Contains additional details about the status of a payment method for a specific payment method domain.
error_message	string	Required within parent	The error message associated with the status of the payment method on the domain. Maximum length: 5000

Policy, approvals and errors

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