Skip to main content
GET
/
payment-profiles
{
  "items": [
    {
      "paymentProfileId": "d9f0b83a-8b0d-44a6-af7c-54b6b91b6040",
      "provider": "STRIPE",
      "type": "CARD",
      "status": "ACTIVE",
      "customerId": "cust-123",
      "displayName": "My credit card",
      "expiresAt": "2025-12-31",
      "billingDetails": {
        "name": "John Doe",
        "email": "john.doe@example.com",
        "address": {
          "street1": "500 S Main St",
          "street2": "Apt 1",
          "city": "Natick",
          "zip": "01701",
          "country": "US",
          "state": "CA",
          "region": "<string>",
          "attention": "<string>"
        }
      },
      "createdAt": "2024-01-15T10:00:00Z",
      "metadata": {}
    }
  ]
}

Authorizations

X-API-Key
string
header
required

An API key that grants access to the Connect API. You can create and manage API keys in the portal.

Query Parameters

customerId
string
required

Filter profiles for a specific customer.

Response

Payment profiles retrieved successfully.

items
object[]
required

List of saved payment profiles.

I