{"templateId":"markdown","versions":[{"version":"9.0","label":"9.0","link":"/classes/whmcs/user/client/affiliate","default":true,"active":true,"folderId":"9d7dc099"},{"version":"8.13","label":"8.13","link":"/classes/8.13/whmcs/user/client/affiliate","default":false,"active":false,"folderId":"9d7dc099"}],"sharedDataIds":{"sidebar":"sidebar-classes/@8.13/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"WHMCS\\User\\Client\\Affiliate","description":"Developer documentation for the WHMCS API — the","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"whmcsuserclientaffiliate","__idx":0},"children":["WHMCS\\User\\Client\\Affiliate"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Class"]}," · extends ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AbstractModel"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Client affiliate information"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If a WHMCS operator turns on the affiliate payment system, then a client"," ","account can become an affiliate. An affiliate record is attached to a"," ","specific client and provides configuration information to the affiliate"," ","system so that client can handle payments and commissions. It also tracks the"," ","balance available, amount withdrawn, and the number of visitors an affiliate"," ","has brought to an operator's WHMCS installation."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"methods","__idx":1},"children":["Methods"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"boot","__idx":2},"children":["boot"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"public static function boot()\n","lang":"php"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"accounts","__idx":3},"children":["accounts"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"public function accounts(): Relation\n","lang":"php"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"client","__idx":4},"children":["client"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"public function client()\n","lang":"php"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each affiliate belongs to one client."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Returns"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\\Illuminate\\Database\\Eloquent\\Relations\\BelongsTo"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"history","__idx":5},"children":["history"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"public function history(): Relation\n","lang":"php"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"hits","__idx":6},"children":["hits"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"public function hits(): Relation\n","lang":"php"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"referrers","__idx":7},"children":["referrers"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"public function referrers(): Relation\n","lang":"php"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"withdrawals","__idx":8},"children":["withdrawals"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"public function withdrawals(): Relation\n","lang":"php"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"pending","__idx":9},"children":["pending"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"public function pending(): Relation\n","lang":"php"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"getreferrallink","__idx":10},"children":["getReferralLink"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"public function getReferralLink(): string\n","lang":"php"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"getadminlink","__idx":11},"children":["getAdminLink"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"public function getAdminLink(): string\n","lang":"php"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"getfulladminurl","__idx":12},"children":["getFullAdminUrl"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"public function getFullAdminUrl(): string\n","lang":"php"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"getpendingcommissionamountattribute","__idx":13},"children":["getPendingCommissionAmountAttribute"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"public function getPendingCommissionAmountAttribute(): float\n","lang":"php"},"children":[]}]},"headings":[{"value":"WHMCS\\User\\Client\\Affiliate","id":"whmcsuserclientaffiliate","depth":1},{"value":"Methods","id":"methods","depth":2},{"value":"boot","id":"boot","depth":3},{"value":"accounts","id":"accounts","depth":3},{"value":"client","id":"client","depth":3},{"value":"history","id":"history","depth":3},{"value":"hits","id":"hits","depth":3},{"value":"referrers","id":"referrers","depth":3},{"value":"withdrawals","id":"withdrawals","depth":3},{"value":"pending","id":"pending","depth":3},{"value":"getReferralLink","id":"getreferrallink","depth":3},{"value":"getAdminLink","id":"getadminlink","depth":3},{"value":"getFullAdminUrl","id":"getfulladminurl","depth":3},{"value":"getPendingCommissionAmountAttribute","id":"getpendingcommissionamountattribute","depth":3}],"frontmatter":{"title":"WHMCS\\User\\Client\\Affiliate","seo":{"title":"WHMCS\\User\\Client\\Affiliate"}},"lastModified":"2026-08-05T14:37:16.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/classes/whmcs/user/client/affiliate","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}