Settings API

Read and update tenant-level settings — branding, contact info, and custom configuration.

The Settings API lets you read and update your tenant's configuration, including business name, brand settings, contact information, and address.

All settings endpoints require a secret key (renta_sk_). Publishable keys will receive a 403 Forbidden error.

Get Settings

GET /v1/settings

Returns all tenant settings.

const settings = await renta.settings.get();
console.log(settings.name);
console.log(settings.tenant_settings);

curl https://api.getrenta.io/v1/settings \
  -H "Authorization: Bearer renta_sk_live_..."

Response:

{
  "name": "Mountain Bike Rentals",
  "brand_settings": {
    "primary_color": "#2563eb",
    "logo_url": "https://storage.getrenta.io/..."
  },
  "email": "info@mtbrentals.com",
  "phone": "+1-555-0100",
  "address_line1": "123 Trail Road",
  "address_line2": "Suite 4",
  "city": "Moab",
  "state": "UT",
  "zip": "84532",
  "tenant_settings": {
    "timezone": "America/Denver",
    "currency": "usd"
  }
}

Update Settings

PUT /v1/settings

Update tenant settings. Only the fields you include will be changed.

Body Parameters:

Parameter	Type	Required	Description
`name`	string	—	Business display name
`brand_settings`	object	—	Branding configuration (colors, logo, etc.)
`email`	string	—	Contact email
`phone`	string	—	Contact phone number
`address_line1`	string	—	Street address line 1
`address_line2`	string	—	Street address line 2
`city`	string	—	City
`state`	string	—	State / province
`zip`	string	—	ZIP / postal code

await renta.settings.update({
  name: 'Mountain Bike Rentals LLC',
  phone: '+1-555-0200',
});

curl -X PUT https://api.getrenta.io/v1/settings \
  -H "Authorization: Bearer renta_sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Mountain Bike Rentals LLC",
    "phone": "+1-555-0200"
  }'

Response:

{
  "success": true
}

Get Settings

Update Settings

On this page