Payment Method Domains

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 guides: Payment method domains.

Endpoints

POST/v1/payment_method_domains

POST/v1/payment_method_domains/:id

GET/v1/payment_method_domains/:id

GET/v1/payment_method_domains

POST/v1/payment_method_domains/:id/validate

The PaymentMethodDomain object

Attributes

idstring
Unique identifier for the object.

domain_namestring
The domain name that this payment method domain object represents.

enabledboolean
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.

More attributes

objectstring

apple_payobject

createdtimestamp

google_payobject

linkobject

livemodeboolean

paypalobject

The PaymentMethodDomain object

{
  "id": "pmd_1Nnrer2eZvKYlo2Cips79tWl",
  "object": "payment_method_domain",
  "apple_pay": {
    "status": "active"
  },
  "created": 1694129445,
  "domain_name": "example.com",
  "enabled": true,
  "google_pay": {
    "status": "active"
  },
  "link": {
    "status": "active"
  },
  "livemode": false,
  "paypal": {
    "status": "active"
  }
}

Create a payment method domain

Creates a payment method domain.

Parameters

domain_namestringRequired
The domain name that this payment method domain object represents.

enabledboolean
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.

Returns

Returns a payment method domain object.

POST /v1/payment_method_domains

Server-side language

curl https://api.stripe.com/v1/payment_method_domains \
  -u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:" \
  -d domain_name="example.com"

Response

{
  "id": "pmd_1Nnrer2eZvKYlo2Cips79tWl",
  "object": "payment_method_domain",
  "apple_pay": {
    "status": "active"
  },
  "created": 1694129445,
  "domain_name": "example.com",
  "enabled": true,
  "google_pay": {
    "status": "active"
  },
  "link": {
    "status": "active"
  },
  "livemode": false,
  "paypal": {
    "status": "active"
  }
}

Update a payment method domain

Updates an existing payment method domain.

Parameters

enabledboolean
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.

Returns

Returns the updated payment method domain object.

POST /v1/payment_method_domains/:id

Server-side language

curl https://api.stripe.com/v1/payment_method_domains/pmd_1Nnrer2eZvKYlo2Cips79tWl \
  -u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:" \
  -d enabled=false

Response

{
  "id": "pmd_1Nnrer2eZvKYlo2Cips79tWl",
  "object": "payment_method_domain",
  "apple_pay": {
    "status": "active"
  },
  "created": 1694129445,
  "domain_name": "example.com",
  "enabled": false,
  "google_pay": {
    "status": "active"
  },
  "link": {
    "status": "active"
  },
  "livemode": false,
  "paypal": {
    "status": "active"
  }
}

Retrieve a payment method domain

Retrieves the details of an existing payment method domain.

Parameters

No parameters.

Returns

Returns a payment method domain object.

GET /v1/payment_method_domains/:id

Server-side language

curl https://api.stripe.com/v1/payment_method_domains/pmd_1Nnrer2eZvKYlo2Cips79tWl \
  -u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:"

Response

{
  "id": "pmd_1Nnrer2eZvKYlo2Cips79tWl",
  "object": "payment_method_domain",
  "apple_pay": {
    "status": "active"
  },
  "created": 1694129445,
  "domain_name": "example.com",
  "enabled": true,
  "google_pay": {
    "status": "active"
  },
  "link": {
    "status": "active"
  },
  "livemode": false,
  "paypal": {
    "status": "active"
  }
}

Payment Method Domains

The PaymentMethodDomain object

Attributes

idstring

domain_namestring

enabledboolean

More attributesExpand all

objectstring

apple_payobject

createdtimestamp

google_payobject

linkobject

livemodeboolean

paypalobject

Create a payment method domain

Parameters

domain_namestringRequired

enabledboolean

Returns

Update a payment method domain

Parameters

enabledboolean

Returns

Retrieve a payment method domain

Parameters

Returns

More attributes