Sample - Stripe API
GET/v1/apple_pay/domains

List Apple Pay domains

Lists Apple Pay domains registered for your account. Use domain_name to filter the results and starting_after or ending_before to navigate the cursor-based list; set limit to control the page size.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

5 parameters
domain_namestringoptional
Filters results to the specified Apple Pay domain name. Maximum 5,000 characters.
ending_beforestringoptional
Cursor identifying the object before the page you want to retrieve. Maximum 5,000 characters.
expandarray<string>optional
Fields to expand in each returned domain object.
limitintegeroptional
Number of domains to return, from 1 to 100. Defaults to 10 when omitted.
starting_afterstringoptional
Cursor identifying the object after the page you want to retrieve. Maximum 5,000 characters.

2 status codes
200Returns a paginated list object containing Apple Pay domain objects, the list URL, and a `has_more` indicator.
dataarray<ApplePayDomain>required
has_morebooleanrequired
True if this list has another page of items after this one that can be fetched.
objectstringrequired
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
Allowed:list
urlstringrequired
The URL where this list can be accessed.
defaultError response.
errorobjectrequired

Error handling

limit must be between 1 and 100 when provided, and starting_after and ending_before must contain valid object identifiers for cursor pagination. domain_name and cursor values must not exceed 5,000 characters.