Tenant object

Overview

This object is returned by endpoints in this section. It represents a Tenant on the Inspire payment platform.

📘

To learn about tenants, read Agencies and tenants.

Properties

Tenant objects returned by endpoints in this section have the following properties:

• id (String): Tenant ID.
• name (String): Tenant name.
• slug (String): Slug.
• googleTenantId (String): Tenant Identifier. This value is required in the tenant header of most Inspire API endpoints for authentication.
• settings (Array): Custom settings saved as key-value pairs.
• logo (String): Logo image URL.
• accountName (String): Account name.
• publicBusinessName (String): Public business name.
• supportEmail (String): Support email address.
• supportPhoneNumber (String): Support phone number.
• showPhoneOnInvoiceAndReceipt (boolean): If True, the support phone number will be displayed on invoices and reciepts.
• supportAddress (Object): An object describing the support postal adress.
• statementDescriptor (String): Desciption to be displayed in the transaction list of a bank statement.
• shortenedDescriptor (String): Short descriptor.
• businessWebsite (String): Public business website.
• supportWebsite (String): Support website URL.
• privacyPolicy (String): Privacy policy URL.
• termsOfService (String): Terms of service URL.
• timezone (Object): Object describing timezone.
• languages (Object): Object describing language.
• currencies (Array): An array of objects describing currencies.
• agencies (Object): Object describing the agency associated with this tenant.
• countries (Object): Object describing countries.