Skip to main content

Get Billing Details

Retrieve the billing contact and address information for the organization.

Request

GET /organization/billing

Authentication

Requires an Admin Bearer JWT token.

Authorization: Bearer <access_token>

Query Parameters

None.

Response

Returns the billing details object.

Success Response

Status Code: 200 OK

Response Body:

{
"companyName": "Example Corp",
"billingContactName": "Jane Smith",
"billingEmail": "[email protected]",
"billingAddressLine1": "123 Main Street",
"billingAddressLine2": "Suite 400",
"billingCity": "San Francisco",
"billingPostalCode": "94105",
"billingState": "California",
"billingCountry": "United States",
"vatNumber": "US123456789"
}

Response Fields

FieldTypeDescription
companyNamestringLegal company name
billingContactNamestringName of billing contact person
billingEmailstringEmail address for billing notifications
billingAddressLine1stringPrimary address line
billingAddressLine2stringSecondary address line (apartment, suite, etc.)
billingCitystringCity
billingPostalCodestringPostal or ZIP code
billingStatestringState, province, or region
billingCountrystringCountry
vatNumberstringVAT/Tax identification number (if applicable)

Errors

Status CodeError CodeDescription
401UNAUTHORIZEDMissing or invalid JWT token
403FORBIDDENUser does not have admin privileges
404NOT_FOUNDBilling details not yet configured for the organization

Example

Request

curl -X GET https://api.entryguard.io/api/v1/organization/billing \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

Response

{
"companyName": "Example Corp",
"billingContactName": "Jane Smith",
"billingEmail": "[email protected]",
"billingAddressLine1": "123 Main Street",
"billingAddressLine2": "Suite 400",
"billingCity": "San Francisco",
"billingPostalCode": "94105",
"billingState": "California",
"billingCountry": "United States",
"vatNumber": "US123456789"
}

Notes

  • Billing details must be configured before subscribing to a paid plan.
  • The billing email receives all payment-related notifications including receipts and failed payment alerts.
  • VAT number is optional but recommended for businesses in VAT-applicable regions to ensure correct tax calculation.