Documentation

ChargeBeeService
in package

Table of Contents

Properties

$chargeBeeComponent  : ChargeBeeComponent
$chargeBeeDebitCardComponent  : ChargeBeeDebitCardComponent
$chargeBeeOverviewComponent  : ChargeBeeOverviewComponent
$countryRepository  : CountryRepository
$hashids  : HashidsComponent
$logger  : Logger
$request  : Request
$subscriptionsRepository  : SubscriptionsRepository
$url  : Url

Methods

__construct()  : mixed
deleteCard()  : array<string|int, mixed>
Remove card from Chargebee.
downloadFile()  : mixed
getBalance()  : array<string|int, mixed>
Retrieve Balance data from chargebee.
getBillingData()  : array<string|int, mixed>
Retrieve Billing data from chargebee.
getCountryIdentifiableSubscriptions()  : mixed
getCreditNoteDownload()  : Response
Download Credit Note file.
getInvoiceDownload()  : Response
Download Invoice file.
getOssSubscriptionByUserId()  : Subscription|null
getPaymentMethods()  : array<string|int, mixed>
Retrieve cards as user from Chargebee.
getSubscriptions()  : array<string|int, mixed>
Retrieve subscriptions as user from Chargebee.
getTransactionDownload()  : Response
Download Transaction file.
getTransactions()  : array<string|int, mixed>
Retrieve transactions as user from Chargebee.
postDebitCard()  : array<string|int, mixed>|null
postPaymentMethods()  : JsonSerializable
Push new card as user from Chargebee.
setPrimaryCard()  : bool
Set primary card on Chargebee.
updateBillingData()  : array<string|int, mixed>|null
Update Billing data for customer on chargebee.
formatCreditNoteFloatValues()  : mixed
formatInvoiceFloatValues()  : mixed
formatTransactionFloatValues()  : mixed

Properties

Methods

__construct()

public __construct(Request $request, CountryRepository $countryRepository, Url $url, HashidsComponent $hashids, ChargeBeeComponent $chargeBeeComponent, ChargeBeeOverviewComponent $chargeBeeOverviewComponent, ChargeBeeDebitCardComponent $chargeBeeDebitCardComponent, SubscriptionsRepository $subscriptionsRepository) : mixed
Parameters
$request : Request
$countryRepository : CountryRepository
$url : Url
$hashids : HashidsComponent
$chargeBeeComponent : ChargeBeeComponent
$chargeBeeOverviewComponent : ChargeBeeOverviewComponent
$chargeBeeDebitCardComponent : ChargeBeeDebitCardComponent
$subscriptionsRepository : SubscriptionsRepository

deleteCard()

Remove card from Chargebee.

public deleteCard(int $userId, string $paymentMethodId) : array<string|int, mixed>
Parameters
$userId : int

HelloTax User identification

$paymentMethodId : string

PaymentMethod identification

Tags
throws
UserNotFoundException
throws
ForbiddenException
Return values
array<string|int, mixed>

downloadFile()

public downloadFile(string $filename, string $url) : mixed
Parameters
$filename : string
$url : string

getCountryIdentifiableSubscriptions()

public getCountryIdentifiableSubscriptions(int $userId[, bool $includeExpired = false ]) : mixed
Parameters
$userId : int
$includeExpired : bool = false

getCreditNoteDownload()

Download Credit Note file.

public getCreditNoteDownload(string $hash) : Response
Parameters
$hash : string
Tags
throws
InvalidHashException
Return values
Response

getInvoiceDownload()

Download Invoice file.

public getInvoiceDownload(string $hash) : Response
Parameters
$hash : string
Tags
throws
InvalidHashException
Return values
Response

getOssSubscriptionByUserId()

public getOssSubscriptionByUserId(int $userId[, bool $includeExpired = false ]) : Subscription|null
Parameters
$userId : int
$includeExpired : bool = false
Return values
Subscription|null

getPaymentMethods()

Retrieve cards as user from Chargebee.

public getPaymentMethods(int $userId) : array<string|int, mixed>
Parameters
$userId : int

HelloTax User identification

Tags
throws
UserNotFoundException
throws
ForbiddenException
Return values
array<string|int, mixed>

getSubscriptions()

Retrieve subscriptions as user from Chargebee.

public getSubscriptions(int $userId[, bool $includeExpired = false ]) : array<string|int, mixed>
Parameters
$userId : int

HelloTax User identification

$includeExpired : bool = false
Tags
throws
UserNotFoundException
throws
ForbiddenException
Return values
array<string|int, mixed>

getTransactionDownload()

Download Transaction file.

public getTransactionDownload(string $hash) : Response
Parameters
$hash : string
Tags
throws
InvalidHashException
Return values
Response

getTransactions()

Retrieve transactions as user from Chargebee.

public getTransactions(int $userId) : array<string|int, mixed>
Parameters
$userId : int

HelloTax User identification

Tags
throws
UserNotFoundException
throws
ForbiddenException
Return values
array<string|int, mixed>

postDebitCard()

public postDebitCard(int $userId, array<string|int, mixed> $postData) : array<string|int, mixed>|null
Parameters
$userId : int
$postData : array<string|int, mixed>
Return values
array<string|int, mixed>|null

setPrimaryCard()

Set primary card on Chargebee.

public setPrimaryCard(int $userId, string $paymentMethodId) : bool
Parameters
$userId : int

HelloTax User identification

$paymentMethodId : string

PaymentMethod identification

Tags
throws
UserNotFoundException
throws
ForbiddenException
Return values
bool

formatCreditNoteFloatValues()

private formatCreditNoteFloatValues(mixed $creditNotes) : mixed
Parameters
$creditNotes : mixed

formatInvoiceFloatValues()

private formatInvoiceFloatValues(mixed $invoices) : mixed
Parameters
$invoices : mixed

formatTransactionFloatValues()

private formatTransactionFloatValues(mixed $transactions) : mixed
Parameters
$transactions : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results