For AI agents and LLMs: a structured documentation index is available at /llms.txt. Every page has a Markdown sibling — append .md to any URL.

Skip to content
Docs

List checkout domains

Returns a paginated list of checkout domains submitted for your account.

GET /checkout-domains
Returns a paginated list of checkout domains submitted for your account. Use the query parameters to page through results.
Requires checkout_domain.read permission.

Query parameters

idarray
Return only the IDs specified. Use a comma-separated list to get multiple entities.
afterstring
Return entities after the specified Paddle ID when working with paginated endpoints. Used in the meta.pagination.next URL in responses for list operations.
per_pageinteger
Default: 50

Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is requested. Check meta.pagination.per_page in the response to see how many were returned.

Default: 50; Maximum: 200.

Max: 200
domainstring
Filter results to include the specified fully qualified domain name (FQDN), its ancestors, and any of its subdomains. For example, if you provide app.example.com, the results include app.example.com, example.com and any subdomains such as cool.app.example.com.
order_bystring
Default: id[DESC]

Order returned entities by the specified field and direction ([ASC] or [DESC]). For example, ?order_by=id[ASC].

Valid fields for ordering: id, created_at, and updated_at.

statusarray
Return entities that match the specified status. Use a comma-separated list to specify multiple status values.
Values
  • pending_review
    Return the checkout domains that are newly added and pending review.
  • approved
    Return the checkout domains that have been approved and can be used for checkouts.
  • rejected
    Return the checkout domains that have been rejected and cannot be used for checkouts.
  • in_review
    Return the checkout domains that are currently under review by Paddle.
  • action_required
    Return the checkout domains that were soft-declined and can be resubmitted by the seller.

Header parameters

Skip-Countstring
Set to true to skip the count query on list operations. When set, meta.pagination.estimated_total returns -1 instead of an exact count.

Response (200)

dataarrayrequired
idstringrequired
Example: chedom_01kkertpke0gv2t61p1pq8v23x
Unique Paddle ID for this checkout domain entity, prefixed with chedom_.
Pattern: ^chedom_[a-z\d]{26}$
domainstring (hostname)required
Example: example.com
Checkout domain name.
statusstringrequired
Approval status of this checkout domain. Checkout domains are created as pending_review. It can be pending_review, approved, rejected, in_review, or action_required.
Values
  • pending_review
    Domain is newly added and is pending review.
  • approved
    Domain has been approved and can be used for checkouts.
  • rejected
    Domain has been rejected and cannot be used for checkouts.
  • in_review
    Domain is currently under review by Paddle.
  • action_required
    Domain was soft-declined during review. The seller can resolve the issue and resubmit the domain.
payment_method_verificationobjectrequired
Payment method verification status for this checkout domain.
apple_payobjectrequired
Apple Pay verification status for this checkout domain.
statusstringrequired
Payment method verification status for this checkout domain.
Values
  • verified
    Payment method is verified for this checkout domain.
  • unverified
    Payment method isn't verified for this checkout domain.
created_atstring (date-time)required
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.
updated_atstring (date-time)required
Example: 2024-10-13T07:20:50.52Z
RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.
metaobjectrequired
Information about this response.
request_idstringrequired
Example: b15ec92e-8688-40d4-a04d-f44cbec93355
Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.
paginationobjectrequired
Keys used for working with paginated results.
per_pageintegerrequired
Number of entities per page for this response. May differ from the number requested if the requested number is greater than the maximum.
nextstring (uri)required
URL containing the query parameters of the original request, along with the after parameter that marks the starting point of the next page. Always returned, even if has_more is false.
has_morebooleanrequired
Whether this response has another page.
estimated_totalinteger
Example: 999

Estimated number of entities for this response.

For datasets with 100,000 or fewer matches, returns the exact count. For datasets with more than 100,000 matches, returns 100001 to indicate that more than 100,000 entities match. Returns -1 when counting is skipped or couldn't be calculated.

Use has_more and next to page through all results rather than relying on estimated_total for an exact count.

Response
{
  "data": [
    {
      "id": "chedom_01j2abc3def4ghi5jkl6mno7pq",
      "domain": "app.example.com",
      "status": "approved",
      "payment_method_verification": {
        "apple_pay": {
          "status": "verified"
        }
      },
      "created_at": "2026-03-04T12:00:00.000Z",
      "updated_at": "2026-03-04T14:30:00.000Z"
    },
    {
      "id": "chedom_01k9zyx8wvu7tsp5qra4lkj2mn",
      "domain": "store.example.net",
      "status": "pending_review",
      "payment_method_verification": {
        "apple_pay": {
          "status": "unverified"
        }
      },
      "created_at": "2026-04-10T15:20:00.000Z",
      "updated_at": "2026-04-10T16:45:00.000Z"
    }
  ],
  "meta": {
    "request_id": "e7f2d619-3c84-4a5e-9f10-2b48c7d0e3f1",
    "pagination": {
      "per_page": 50,
      "next": "https://api.paddle.com/checkout-domains?after=chedom_01j2abc3def4ghi5jkl6mno7pq&per_page=50",
      "has_more": false,
      "estimated_total": 2
    }
  }
}

Was this page helpful?