BillingApi
in package
BillingApi Class Doc Comment
Tags
Table of Contents
- $apiClient : ApiClient
- API Client
- __construct() : void
- Constructor
- getApiClient() : ApiClient
- Get API client
- getBillingPlan() : BillingPlanResponse
- Operation getBillingPlan
- getBillingPlanWithHttpInfo() : array<string|int, mixed>
- Operation getBillingPlanWithHttpInfo
- getCreditCardInfo() : CreditCardInformation
- Operation getCreditCardInfo
- getCreditCardInfoWithHttpInfo() : array<string|int, mixed>
- Operation getCreditCardInfoWithHttpInfo
- getDowngradeRequestBillingInfo() : DowngradRequestBillingInfoResponse
- Operation getDowngradeRequestBillingInfo
- getDowngradeRequestBillingInfoWithHttpInfo() : array<string|int, mixed>
- Operation getDowngradeRequestBillingInfoWithHttpInfo
- getInvoice() : BillingInvoice
- Operation getInvoice
- getInvoiceWithHttpInfo() : array<string|int, mixed>
- Operation getInvoiceWithHttpInfo
- getPayment() : BillingPaymentItem
- Operation getPayment
- getPaymentWithHttpInfo() : array<string|int, mixed>
- Operation getPaymentWithHttpInfo
- getPlan() : AccountBillingPlanResponse
- Operation getPlan
- getPlanWithHttpInfo() : array<string|int, mixed>
- Operation getPlanWithHttpInfo
- listBillingPlans() : BillingPlansResponse
- Operation listBillingPlans
- listBillingPlansWithHttpInfo() : array<string|int, mixed>
- Operation listBillingPlansWithHttpInfo
- listInvoices() : BillingInvoicesResponse
- Operation listInvoices
- listInvoicesPastDue() : BillingInvoicesSummary
- Operation listInvoicesPastDue
- listInvoicesPastDueWithHttpInfo() : array<string|int, mixed>
- Operation listInvoicesPastDueWithHttpInfo
- listInvoicesWithHttpInfo() : array<string|int, mixed>
- Operation listInvoicesWithHttpInfo
- listPayments() : BillingPaymentsResponse
- Operation listPayments
- listPaymentsWithHttpInfo() : array<string|int, mixed>
- Operation listPaymentsWithHttpInfo
- makePayment() : BillingPaymentResponse
- Operation makePayment
- makePaymentWithHttpInfo() : array<string|int, mixed>
- Operation makePaymentWithHttpInfo
- purchaseEnvelopes() : mixed
- Operation purchaseEnvelopes
- purchaseEnvelopesWithHttpInfo() : array<string|int, mixed>
- Operation purchaseEnvelopesWithHttpInfo
- setApiClient() : self
- Set the API client
- updateDowngradeAccountBillingPlan() : DowngradePlanUpdateResponse
- Operation updateDowngradeAccountBillingPlan
- updateDowngradeAccountBillingPlanWithHttpInfo() : array<string|int, mixed>
- Operation updateDowngradeAccountBillingPlanWithHttpInfo
- updatePlan() : BillingPlanUpdateResponse
- Operation updatePlan
- updatePlanWithHttpInfo() : array<string|int, mixed>
- Operation updatePlanWithHttpInfo
- updateResourcePath() : string
- Update $resourcePath with $
Properties
$apiClient
API Client
protected
ApiClient
$apiClient
instance of the ApiClient
Methods
__construct()
Constructor
public
__construct([ApiClient|null $apiClient = null ]) : void
Parameters
- $apiClient : ApiClient|null = null
-
The api client to use
Return values
void —getApiClient()
Get API client
public
getApiClient() : ApiClient
Return values
ApiClient —get the API client
getBillingPlan()
Operation getBillingPlan
public
getBillingPlan(string|null $billing_plan_id) : BillingPlanResponse
Get the billing plan details.
Parameters
- $billing_plan_id : string|null
-
The ID of the billing plan being accessed.
Tags
Return values
BillingPlanResponse —getBillingPlanWithHttpInfo()
Operation getBillingPlanWithHttpInfo
public
getBillingPlanWithHttpInfo(string|null $billing_plan_id) : array<string|int, mixed>
Get the billing plan details.
Parameters
- $billing_plan_id : string|null
-
The ID of the billing plan being accessed.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\BillingPlanResponse, HTTP status code, HTTP response headers (array of strings)
getCreditCardInfo()
Operation getCreditCardInfo
public
getCreditCardInfo(string|null $account_id) : CreditCardInformation
Get metadata for a given credit card.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
Tags
Return values
CreditCardInformation —getCreditCardInfoWithHttpInfo()
Operation getCreditCardInfoWithHttpInfo
public
getCreditCardInfoWithHttpInfo(string|null $account_id) : array<string|int, mixed>
Get metadata for a given credit card.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\CreditCardInformation, HTTP status code, HTTP response headers (array of strings)
getDowngradeRequestBillingInfo()
Operation getDowngradeRequestBillingInfo
public
getDowngradeRequestBillingInfo(string|null $account_id) : DowngradRequestBillingInfoResponse
Returns downgrade plan information for the specified account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
Tags
Return values
DowngradRequestBillingInfoResponse —getDowngradeRequestBillingInfoWithHttpInfo()
Operation getDowngradeRequestBillingInfoWithHttpInfo
public
getDowngradeRequestBillingInfoWithHttpInfo(string|null $account_id) : array<string|int, mixed>
Returns downgrade plan information for the specified account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\DowngradRequestBillingInfoResponse, HTTP status code, HTTP response headers (array of strings)
getInvoice()
Operation getInvoice
public
getInvoice(string|null $account_id, string|null $invoice_id) : BillingInvoice
Retrieves a billing invoice.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $invoice_id : string|null
Tags
Return values
BillingInvoice —getInvoiceWithHttpInfo()
Operation getInvoiceWithHttpInfo
public
getInvoiceWithHttpInfo(string|null $account_id, string|null $invoice_id) : array<string|int, mixed>
Retrieves a billing invoice.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $invoice_id : string|null
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\BillingInvoice, HTTP status code, HTTP response headers (array of strings)
getPayment()
Operation getPayment
public
getPayment(string|null $account_id, string|null $payment_id) : BillingPaymentItem
Gets billing payment information for a specific payment.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $payment_id : string|null
Tags
Return values
BillingPaymentItem —getPaymentWithHttpInfo()
Operation getPaymentWithHttpInfo
public
getPaymentWithHttpInfo(string|null $account_id, string|null $payment_id) : array<string|int, mixed>
Gets billing payment information for a specific payment.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $payment_id : string|null
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\BillingPaymentItem, HTTP status code, HTTP response headers (array of strings)
getPlan()
Operation getPlan
public
getPlan(string|null $account_id[, GetPlanOptions $options = null ]) : AccountBillingPlanResponse
Get Account Billing Plan
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $options : GetPlanOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
AccountBillingPlanResponse —getPlanWithHttpInfo()
Operation getPlanWithHttpInfo
public
getPlanWithHttpInfo(string|null $account_id[, GetPlanOptions $options = null ]) : array<string|int, mixed>
Get Account Billing Plan
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $options : GetPlanOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\AccountBillingPlanResponse, HTTP status code, HTTP response headers (array of strings)
listBillingPlans()
Operation listBillingPlans
public
listBillingPlans() : BillingPlansResponse
Gets the list of available billing plans.
Tags
Return values
BillingPlansResponse —listBillingPlansWithHttpInfo()
Operation listBillingPlansWithHttpInfo
public
listBillingPlansWithHttpInfo() : array<string|int, mixed>
Gets the list of available billing plans.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\BillingPlansResponse, HTTP status code, HTTP response headers (array of strings)
listInvoices()
Operation listInvoices
public
listInvoices(string|null $account_id[, ListInvoicesOptions $options = null ]) : BillingInvoicesResponse
Get a List of Billing Invoices
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $options : ListInvoicesOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
BillingInvoicesResponse —listInvoicesPastDue()
Operation listInvoicesPastDue
public
listInvoicesPastDue(string|null $account_id) : BillingInvoicesSummary
Get a list of past due invoices.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
Tags
Return values
BillingInvoicesSummary —listInvoicesPastDueWithHttpInfo()
Operation listInvoicesPastDueWithHttpInfo
public
listInvoicesPastDueWithHttpInfo(string|null $account_id) : array<string|int, mixed>
Get a list of past due invoices.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\BillingInvoicesSummary, HTTP status code, HTTP response headers (array of strings)
listInvoicesWithHttpInfo()
Operation listInvoicesWithHttpInfo
public
listInvoicesWithHttpInfo(string|null $account_id[, ListInvoicesOptions $options = null ]) : array<string|int, mixed>
Get a List of Billing Invoices
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $options : ListInvoicesOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\BillingInvoicesResponse, HTTP status code, HTTP response headers (array of strings)
listPayments()
Operation listPayments
public
listPayments(string|null $account_id[, ListPaymentsOptions $options = null ]) : BillingPaymentsResponse
Gets payment information for one or more payments.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $options : ListPaymentsOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
BillingPaymentsResponse —listPaymentsWithHttpInfo()
Operation listPaymentsWithHttpInfo
public
listPaymentsWithHttpInfo(string|null $account_id[, ListPaymentsOptions $options = null ]) : array<string|int, mixed>
Gets payment information for one or more payments.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $options : ListPaymentsOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\BillingPaymentsResponse, HTTP status code, HTTP response headers (array of strings)
makePayment()
Operation makePayment
public
makePayment(string|null $account_id[, BillingPaymentRequest $billing_payment_request = null ]) : BillingPaymentResponse
Posts a payment to a past due invoice.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $billing_payment_request : BillingPaymentRequest = null
-
(optional)
Tags
Return values
BillingPaymentResponse —makePaymentWithHttpInfo()
Operation makePaymentWithHttpInfo
public
makePaymentWithHttpInfo(string|null $account_id[, BillingPaymentRequest $billing_payment_request = null ]) : array<string|int, mixed>
Posts a payment to a past due invoice.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $billing_payment_request : BillingPaymentRequest = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\BillingPaymentResponse, HTTP status code, HTTP response headers (array of strings)
purchaseEnvelopes()
Operation purchaseEnvelopes
public
purchaseEnvelopes(string|null $account_id[, PurchasedEnvelopesInformation $purchased_envelopes_information = null ]) : mixed
Reserverd: Purchase additional envelopes.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $purchased_envelopes_information : PurchasedEnvelopesInformation = null
-
(optional)
Tags
Return values
mixed —purchaseEnvelopesWithHttpInfo()
Operation purchaseEnvelopesWithHttpInfo
public
purchaseEnvelopesWithHttpInfo(string|null $account_id[, PurchasedEnvelopesInformation $purchased_envelopes_information = null ]) : array<string|int, mixed>
Reserverd: Purchase additional envelopes.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $purchased_envelopes_information : PurchasedEnvelopesInformation = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
setApiClient()
Set the API client
public
setApiClient(ApiClient $apiClient) : self
Parameters
- $apiClient : ApiClient
-
set the API client
Return values
self —updateDowngradeAccountBillingPlan()
Operation updateDowngradeAccountBillingPlan
public
updateDowngradeAccountBillingPlan(string|null $account_id[, DowngradeBillingPlanInformation $downgrade_billing_plan_information = null ]) : DowngradePlanUpdateResponse
Queues downgrade billing plan request for an account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $downgrade_billing_plan_information : DowngradeBillingPlanInformation = null
-
(optional)
Tags
Return values
DowngradePlanUpdateResponse —updateDowngradeAccountBillingPlanWithHttpInfo()
Operation updateDowngradeAccountBillingPlanWithHttpInfo
public
updateDowngradeAccountBillingPlanWithHttpInfo(string|null $account_id[, DowngradeBillingPlanInformation $downgrade_billing_plan_information = null ]) : array<string|int, mixed>
Queues downgrade billing plan request for an account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $downgrade_billing_plan_information : DowngradeBillingPlanInformation = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\DowngradePlanUpdateResponse, HTTP status code, HTTP response headers (array of strings)
updatePlan()
Operation updatePlan
public
updatePlan(string|null $account_id[, BillingPlanInformation $billing_plan_information = null ][, UpdatePlanOptions $options = null ]) : BillingPlanUpdateResponse
Updates the account billing plan.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $billing_plan_information : BillingPlanInformation = null
-
(optional)
- $options : UpdatePlanOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
BillingPlanUpdateResponse —updatePlanWithHttpInfo()
Operation updatePlanWithHttpInfo
public
updatePlanWithHttpInfo(string|null $account_id[, BillingPlanInformation $billing_plan_information = null ][, UpdatePlanOptions $options = null ]) : array<string|int, mixed>
Updates the account billing plan.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $billing_plan_information : BillingPlanInformation = null
-
(optional)
- $options : UpdatePlanOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\BillingPlanUpdateResponse, HTTP status code, HTTP response headers (array of strings)
updateResourcePath()
Update $resourcePath with $
public
updateResourcePath(string $resourcePath, string $baseName, string $paramName) : string
Parameters
- $resourcePath : string
-
the resource path to use
- $baseName : string
-
the base name param
- $paramName : string
-
the parameter name