Websites

A Website represents the website/brand that customers interact with... You could think of it like a brand. For example, Nestle owns Perrier and Purina and PowerBar.

We recognize that some enterprises have more than one website (or brand). The website is related to each invoice and each payment gateway account. This feature would allow you to have gateway accounts that are related to multiple websites, or exclusive to particular websites. And gives you more control over your business.

Retrieve a website

Retrieve a website. Use it to find the website name, logo, or more.

SecurityCustomerJWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

Responses
200

Website was retrieved successfully.

Response Schema: application/json
name
required
string

The website name.

url
required
string

The website domain address.

servicePhone
required
string

The website customer service phone number.

serviceEmail
required
string <email>

The website customer service email address.

id
string <= 50 characters

The resource ID. Defaults to UUID v4.

createdTime
string <date-time>

Read-only timestamp, automatically assigned on back-end.

updatedTime
string <date-time>

Read-only timestamp, automatically assigned on back-end.

customFields
object (ResourceCustomFields)
Default: {}

Custom Fields list as a map {"custom field name": "custom field value", ...}. The format must follow the saved format (see Custom Fields section for the formats).

object (WebsiteSettings)

Website settings.

object

Payment form settings.

css
string

Hosted payment form css options.

object

Hosted payment form theme options.

organizationId
string <= 50 characters
Deprecated

The resource ID. Defaults to UUID v4.

Array of SelfLink (object) or OrganizationLink (object) non-empty

The links related to resource.

Array (non-empty)
Any of:
rel
required
string

The link type.

Value: "self"
href
required
string

The link URL.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

get/websites/{id}
Request samples
curl -i -X GET \
  'https://api-sandbox.rebilly.com/storefront/websites/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "name": "string",
  • "url": "string",
  • "servicePhone": "string",
  • "serviceEmail": "user@example.com",
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "customFields": {
    },
  • "settings": {
    },
  • "organizationId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "_links": [
    ]
}