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.
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
{
"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.
{
"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.
{
"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.
{
"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"
}
}