> ## Documentation Index
> Fetch the complete documentation index at: https://docs.voyantcloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Payment Defaults

> Return effective payment configuration for the workspace (with optional product overrides).

## Method

`GET` `/v1/payments/defaults`

## Query Parameters

<ParamField query="product" type="uuid">Optional product ID. When provided, product-level overrides supersede workspace defaults.</ParamField>

## Headers

<ParamField header="Authorization" type="string">Bearer token (workspace API key).</ParamField>

## Request Example

<RequestExample>
  ```bash cURL theme={null}
  curl "https://api.voyantcloud.com/v1/payments/defaults?product=1f4df0f4-58fa-4f6d-8fb8-8a8a23f8d2c7" \
    -H "Authorization: Bearer $VOYANT_API_KEY"
  ```

  ```javascript Node.js theme={null}
  const res = await fetch("https://api.voyantcloud.com/v1/payments/defaults", {
    headers: { Authorization: `Bearer ${process.env.VOYANT_API_KEY}` },
  })
  const { payments } = await res.json()
  ```

  ```python Python theme={null}
  import os, requests

  resp = requests.get(
    "https://api.voyantcloud.com/v1/payments/defaults",
    headers={"Authorization": f"Bearer {os.environ['VOYANT_API_KEY']}"},
  )
  defaults = resp.json()["payments"]
  ```
</RequestExample>

## Response

<ResponseExample>
  ```json 200 OK theme={null}
  {
    "payments": {
      "methods": {
        "card": { "enabled": true },
        "bank_transfer": { "enabled": true, "dueDays": 5 }
      },
      "provider": {
        "preferred": "netopia",
        "fallback": null
      },
      "checkout": {
        "currency": "EUR",
        "collectBillingAddress": true
      }
    }
  }
  ```

  ```json 200 OK theme={null}
  { "payments": null }
  ```
</ResponseExample>

<Tip>If no workspace can be resolved (for example, when the API key is missing and no `product` is provided), the response contains `payments: null` instead of an error.</Tip>
