Reseller Structure

Base Attributes

Attribute Type Example

id

The reseller ID

 Integer 1

name

The name of the reseller

 String Test Reseller

identifier

The identifier of the reseller

 String testreseller

name

The name of the reseller

 String

identifier

The identifier for this reseller

 String

container_id

The container to assign to this reseller.

 Integer

brand_name

The resellers brand name

 String

support_email

The support email address of the reseller

 String

cname

The resellers CNAME for the management interface

 String

timezone

The timezone of the reseller

 String

voicemail_email

The email address where voicemail notifications come from

 String

sip_server

The CNAME for the resellers container

 String

enabled

Is the reseller enabled or not

 String

customer_reference

String

metadata

Hash

invoice_day

The day this reseller will usually have an invoice generated

  • Must be authenticated as an admin.
 Integer 10

renewal_type

The type of renewal schedule this reseller uses (daily or monthly)

  • Must be authenticated as an admin.
 String daily

Extended Attributes

Attribute Type Example

created_at

The time the reseller was created

 Time

updated_at

The time the reseller was updated

 Time

Expansions

Expansions are embedded structures of other objects that are related to the structure that you're viewing. Which expansions are returned by a specific action are shown on that action's documentation however some actions allow you to choose which expansions are returned.

Attribute Type Example

base_price_plans

The base price plans that applies to this reseller

  • Must be authenticated as an admin.
 Price plan structure

containers

The containers that this reseller can use

  • Must be authenticated as an admin.
 Container structure