Client Object

attributes id string a unique identifier for the client object string the value is always client name string the name of the client email string the email of the client country string ( appendix docid\ kfbmx4q3dxjtduqf75yx1 ) the billing country of the client registration date timestamp the date the client was created telephone string the client's phone number last campaign date status string the possible values are pending , trialing , active and inactive permissions object appendix docid\ kfbmx4q3dxjtduqf75yx1 an object containing the permissions of the client billing plan object a subscription object docid\ k0wuvfe yqdvzc3q awny containing the billing configuration of the client's subscription plan business information object an object containing the shop settings of the client "business information" { "name" "awesome ltd", "country" "de", "email" "johndoe\@example com", "currencies" \[ "eur", "gbp", "jpy" ], "default currency" "eur", "languages" \[ "en", "de" ], "logos" {}, "facebook" null, "instagram" null, "twitter" null, "pinterest" null, "address" "awesome street", "city" "frankfurt", "postcode" "60123", "state" null, "telephone" "+49123456789", "currency conversion" true, "offset" "+01 00" } name string the shop's business name country string ( appendix docid\ kfbmx4q3dxjtduqf75yx1 ) the shop's country email email the email of the shop default currency string appendix docid\ kfbmx4q3dxjtduqf75yx1 the default currency of the shop offset string the timezone offset of the shop facebook string the facebook link of the shop twitter string the twitter profile of the shop instagram string the instagram profile of the shop pinterest string the pinterest profile of the shop currencies array of strings appendix docid\ kfbmx4q3dxjtduqf75yx1 the currencies configured on the client account languages array of strings ( appendix docid\ kfbmx4q3dxjtduqf75yx1 ) the languages configured on the client account address string the billing address of the client postcode string the shop's postcode state string the shop's state (if applicable) vat string the vat number of the client's shop city string the shop's city telephone string the shop's telephone currency conversion boolean this attribute shows whether currency conversion features are activated on the client's shop quotas object an object containing the quotas of the client example "quotas" { "automations quota" 100, "transaction quota" 100, "datatransfer quota" 100, "storage quota" 3, "languages quota" 1, "products quota" 100, "domains quota" 100, "currencies quota" 2, "teammates quota" 100, "api quota" 100, "newsletters quota" 100 } { "customer id" "69ba5c0a 49c2 4e1d a4a8 e3f3619f1c29", "quotas" { "used storage" 0, "storage quota" 3221225472, "datatransfer quota" 2147483648, "used datatransfer" 0, "automations quota" 0, "used automations" 0, "transaction quota" 12, "used transactions" 0, "products quota" 12, "used products" 0, "languages quota" 2, "used languages" 1, "paid extra languages" 0, "domains quota" 1, "currencies quota" 2, "paid extra currencies" 0, "used currencies" 1, "used domains" 0, "paid extra domains" 0, "teammates quota" 1, "used teammates" 0, "api quota" 0, "used api" 0, "newsletters quota" 12, "used newsletters" 0, "ai quota" 0 }, "is demo" false, "is suspended" false, "permissions" { "account" { "view" true, "edit" true, "remove" true }, "billing" { "view" true, "edit" true }, "keys" { "view" true, "edit" true, "remove" true, "create" true }, "webhooks" { "view" true, "edit" true, "remove" true, "create" true }, "logs" { "view" true }, "audit trail" { "view" true }, "revenue analytics" { "view" true }, "source analytics" { "view" true }, "visitor analytics" { "view" true }, "domains" { "edit" true, "view" true, "create" true, "remove" true }, "taxes" { "edit" true, "view" true, "create" true, "remove" true }, "teammates" { "edit" true, "view" true, "create" true, "remove" true }, "reports" { "view" true, "edit" true }, "sites" { "edit" true, "view" true, "create" true, "remove" true, "publish" true }, "pages" { "edit" true, "view" true, "create" true, "remove" true }, "affiliate programs" { "edit" true, "view" true, "create" true, "remove" true }, "affiliates" { "edit" true, "view" true, "remove" true }, "payouts" { "edit" true, "view" true, "create" true, "remove" true }, "affiliate network" { "edit" true, "view" true }, "payments" { "edit" true, "view" true, "remove" true }, "integrations" { "edit" true, "create" true, "publish" true, "view" true, "remove" true }, "invoices" { "view" true, "edit" true, "remove" true, "create" true }, "subscriptions" { "view" true, "edit" true, "remove" true }, "instalment plans" { "view" true, "edit" true, "remove" true }, "customers" { "view" true, "edit" true, "create" true, "remove" true }, "subscribers" { "view" true, "edit" true, "create" true, "remove" true }, "mailing lists" { "view" true, "edit" true, "create" true, "remove" true }, "automations" { "view" true, "edit" true, "create" true, "remove" true }, "discounts" { "view" true, "edit" true, "create" true, "remove" true }, "email templates" { "view" true, "edit" true, "create" true, "remove" true }, "reviews" { "view" true, "edit" true, "remove" true }, "assets" { "view" true, "edit" true, "create" true, "remove" true }, "products" { "view" true, "edit" true, "create" true, "remove" true }, "shippings" { "view" true, "edit" true, "create" true, "remove" true }, "warehouses" { "view" true, "edit" true, "create" true, "remove" true }, "support" { "view" true, "edit" true, "create" true, "remove" true }, "clients" { "view" true, "edit" true, "create" true, "remove" true }, "agency billing plans" { "view" true, "edit" true, "create" true, "remove" true } }, "status" "active", "billing plan" null, "id" "7ea9c22d 0bd5 4a29 9753 ae210cba77e4", "email" "james\@example com", "registration date" 1681899665, "locale" "en", "country" "de", "name" "james", "business information" { "name" "james", "country" "de", "email" "james\@example com", "currencies" \[ "eur" ], "default currency" "eur", "languages" \[ "en" ], "logos" {}, "facebook" null, "instagram" null, "twitter" null, "pinterest" null } }