API Reference

Introduction

Everyware’s API is REST-style over HTTPS. Use an API key in the Authorization header and handle standard HTTP response codes.

Base URL

https://api.everyware.com

Authentication

Send your API key as a Bearer token in the Authorization header.

Authorization: Bearer ew_xxxxxxxxx

Response codes

Use standard HTTP status codes (2xx success, 4xx client issues, 5xx server issues).

Status

Description

200

Successful request

400

Bad request / invalid parameters

401

Missing API key

403

Invalid/insufficient permissions

404

Resource not found

429

Rate limit exceeded

5xx

Server error

Create invoice

POST

/v1/invoices

Creates a new invoice and returns a hosted pay link.

Playground

curl -X POST "https://api.everyware.com/v1/invoices" \
  -H "Authorization: Bearer ew_xxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 75.00,
    "currency": "USD",
    "service": "Physician Copay",
    "customer": {
      "name": "John Moneybags",
      "email": "john@example.com"
    }
  }'

Get invoice

GET

/v1/invoices/{invoice_id}

Fetches an invoice including status and payment details.

Playground

curl -X GET "https://api.everyware.com/v1/invoices/inv_123" \
  -H "Authorization: Bearer ew_xxxxxxxxx"

Update customer

PATCH

/v1/customers/{customer_id}

Updates customer profile fields used for receipts and risk signals.

Playground

curl -X PATCH "https://api.everyware.com/v1/customers/cus_123" \
  -H "Authorization: Bearer ew_xxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "phone": "+1 (305) 555-1212",
    "address": {
      "line1": "123 Palm Avenue",
      "city": "Miami",
      "region": "FL",
      "postal_code": "33131"
    }
  }'

Next: we’ll add dedicated pages per resource (Invoices, Customers, Webhooks), plus parameter tables and response schemas.