DeluxHostAPI Reference
Payments & payment methods

List available payment gateways

GET
/v1/payments/config

Authorization

apiToken billing:read
headerAuthorizationBearer <token>

A personal API token: Authorization: Bearer dh_live_…. See Authentication for scopes.

Scope: billing:read

Query Parameters

invoiceId?number

Response Body

Operation completed or accepted; asynchronous actions may still be running.

application/json
  1. response
methods*array<>
pinnedGatewayId?string
curl -X GET 'https://api.deluxhost.net/v1/payments/config' \  -H "Authorization: Bearer $DELUXHOST_TOKEN"
Example Response
{  "methods": [    {      "id": "string",      "clientId": "string",      "env": "string",      "unavailable": "string"    }  ],  "pinnedGatewayId": "string"}

Download an invoice PDF GET

Byte-for-byte the document the dashboard serves.

Start a PayPal payment POST

Requires confirm: true. Inspect the resource before retrying an uncertain outcome. Requires Idempotency-Key. Use the same key and payload to replay a completed response. A 409 for a pending or failed attempt requires checking the resource; a new key could duplicate a charge or purchase.