GET/v1/apple_pay/domains

List Apple Pay domains

Lists Apple Pay domains registered with your account. Results are returned in sorted order with the most recent domains appearing first. Use pagination parameters to control the page size and navigate through results.

5 parameters
domain_namestringoptional

Filter results to domains matching this exact domain name.

ending_beforestringoptional

A cursor for pagination. Pass an object ID to fetch the previous page of results.

expandarray<string>optional

Specifies which fields in the response should be expanded.

limitintegeroptional

Maximum number of domains to return. Defaults to 10 if omitted; must be between 1 and 100.

starting_afterstringoptional

A cursor for pagination. Pass an object ID to fetch the next page of results.

2 status codes
200Returns a paginated list of Apple Pay domain objects with metadata including creation time and livemode status.
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 a positive integer between 1 and 100 if provided. domain_name filters results by exact domain match. Use starting_after and ending_before for cursor-based pagination.