Skip to main content
The billing endpoints let you read and update the billing profile attached to your organization. This profile is used for invoicing and must be accurate for VAT compliance. Use GET /api/billing to retrieve the current record and POST /api/billing to update it.

Get billing details

GET https://api-admin.hackgate.io/api/billing
Returns the current billing profile for your organization.

Request

Authorization
string
required
Bearer token. See Authentication.

Response

bussinessName
string
Legal business name for invoicing.
vat
string
VAT registration number (if applicable).
address
string
Primary address line (street and number).
addressLine2
string
Secondary address line (apartment, suite, floor, etc.).
city
string
City.
zipCode
string
Postal or ZIP code.
country
string
Country.
state
string
State, province, or region.
email
string
Email address where invoices and billing notifications are sent.

Example

curl https://api-admin.hackgate.io/api/billing \
  -H "Authorization: Bearer <token>"
{
  "bussinessName": "Acme Security Ltd.",
  "vat": "GB123456789",
  "address": "10 Pentest Lane",
  "addressLine2": "Suite 4B",
  "city": "London",
  "zipCode": "EC1A 1BB",
  "country": "United Kingdom",
  "state": "England",
  "email": "billing@acmesecurity.io"
}

Update billing details

POST https://api-admin.hackgate.io/api/billing
Replaces the billing profile for your organization. Send all fields — any field you omit will be cleared.

Request

Authorization
string
required
Bearer token. See Authentication.
Content-Type
string
required
Must be application/json.

Body parameters

bussinessName
string
Legal business name for invoicing.
vat
string
VAT registration number. Leave blank if not VAT-registered.
address
string
Primary address line (street and number).
addressLine2
string
Secondary address line (apartment, suite, floor, etc.).
city
string
City.
zipCode
string
Postal or ZIP code.
country
string
Country.
state
string
State, province, or region.
email
string
Email address for invoices and billing notifications.

Response

Returns 200 OK on success. The response body may be empty.

Example

curl -X POST https://api-admin.hackgate.io/api/billing \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "bussinessName": "Acme Security Ltd.",
    "vat": "GB123456789",
    "address": "10 Pentest Lane",
    "addressLine2": "Suite 4B",
    "city": "London",
    "zipCode": "EC1A 1BB",
    "country": "United Kingdom",
    "state": "England",
    "email": "billing@acmesecurity.io"
  }'