php-zoho-subscriptions

, _(*1)

Zoho Subscriptions API Client for PHP, _(*2)


use SudiptoChoudhury\Zoho\Subscriptions\Api;

...

$subscriptions = new Api([
                'oauthtoken' => '<<Zoho Subscriptions OAuth Token>>', // https://www.zoho.com/subscriptions/api/v1/#oauth
                'zohoOrgId' => '<<Zoho Organization ID>>',
            ]);


$resultJson = $subscriptions->addCustomer($data); // create a customer

$resultJson = $subscriptions->addSubscription($data); // create a subscription

Auth Token (Will be deprecated soon), but you can still use it., _(*3)


use SudiptoChoudhury\Zoho\Subscriptions\Api;

...

$subscriptions = new Api([
                'authtoken' => '<<Zoho Subscriptions Auth Token>>', // https://accounts.zoho.com/apiauthtoken/nb/create
                'zohoOrgId' => '<<Zoho Organization ID>>',
            ]);


$resultJson = $subscriptions->addCustomer($data); // create a customer

$resultJson = $subscriptions->addSubscription($data); // create a subscription

Installation

Requirements

Any flavour of PHP 7.0+ should do

Install With Composer

You can install the library via Composer by adding the following line to the require block of your composer.json file (replace dev-master with latest stable version):, _(*4)

"sudiptochoudhury/php-zoho-subscriptions": "dev-master"

or run the following command:, _(*5)

composer require sudiptochoudhury/php-zoho-subscriptions

Setting up Authentication

Get Organization ID Before you start, read https://www.zoho.com/subscriptions/api/v1/#organization-id to know your Organization ID., _(*6)

Setup OAuth and use oauth token

Follow instructions from https://www.zoho.com/subscriptions/api/v1/#oauth and get the oathtoken., _(*7)

Pass the oauth token via the constructor., _(*8)


use SudiptoChoudhury\Zoho\Subscriptions\Api;


new Api([
    'oauthtoken' => '<<Zoho Subscriptions OAuth Token>>', // https://www.zoho.com/subscriptions/api/v1/#oauth
    'zohoOrgId' => '<<Zoho Organization ID>>',
]);

Or Use AuthToken

will be deprecated soon, _(*9)

Crete and retrieve AuthToken from https://accounts.zoho.com/apiauthtoken/nb/create and set the AuthToken and Organization ID in the constructor., _(*10)


use SudiptoChoudhury\Zoho\Subscriptions\Api;


new Api([
    'authtoken' => '<<Zoho Subscriptions Auth Token>>', // https://accounts.zoho.com/apiauthtoken/nb/create
    'zohoOrgId' => '<<Zoho Organization ID>>',
]);

How to use

Next, call the desired method from the table given below. In some methods you may need to pass parameters. The parameters are to be passed as an associative array. The required list of parameters can be found in the parameters column of the table or you may get more details going to the original Zoho Subscription API documentation., _(*11)

Examples:, _(*12)

$resultJson = $subscriptions->getOrganizations(); 

$resultJson = $subscriptions->addCustomer(['display_name'=> 'Sudipto Choudhury', 'email'=> 'mail@sudipto.net']); // create a customer

Available API Methods

| Method & Endpoint | Parameters | Description | |-------------------|------------|-------------| getHostedpage(array)br/ [GET] /hostedpages/{hostedpage_id} | hostedpage_id | Getting the details of a particular hosted pagebr/PlaceHolder to replace : hostedpage_idbr/API DOC br/HELP DOC | getHostedpages()br/ [GET] /hostedpages | [none] | Listing all the hostedpagesbr/API DOC br/HELP DOC | addNewSubscriptionHostedpages(array)br/ [POST] /hostedpages/newsubscription | customer_idbr/contactpersonsbr/planbr/addonsbr/starts_atbr/custom_fieldsbr/coupon_codebr/reference_idbr/additional_parambr/redirect_url | Creating a hosted page for a new subscription for an existing customerbr/API DOC br/HELP DOC | addNewCustomerNewSubscriptionHostedpages(array)br/ [POST] /hostedpages/newsubscription | planbr/addonsbr/starts_atbr/custom_fieldsbr/coupon_codebr/reference_idbr/additional_parambr/redirect_url | Creating a hosted page for a new subscription for a new customerbr/API DOC br/HELP DOC | addUpdateCardHostedpages(array)br/ [POST] /hostedpages/updatecard | subscription_idbr/additional_parambr/redirect_url | Creating a hosted page for updating a card linked to a specific subscriptionbr/API DOC br/HELP DOC | addOnetimeAddonHostedpages(array)br/ [POST] /hostedpages/buyonetimeaddon | subscription_idbr/addonsbr/additional_parambr/redirect_url | Creating a hosted page for onetime addon purchasebr/API DOC br/HELP DOC | addUpdateSubscriptionHostedpages(array)br/ [POST] /hostedpages/updatesubscription | subscription_idbr/contactpersonsbr/planbr/addonsbr/reference_idbr/starts_atbr/additional_parambr/redirect_url | Creating a hosted page for updating an existing subscriptionbr/API DOC br/HELP DOC | getTransactions(array)br/ [GET] /transactions?customer_id={customer_id}&filter_by={filter_by} | customer_idbr/filter_by [default: TransactionType.ALL] | List all transactions of a particular customerbr/Allowed parameters and its allowed values :br/ 1)filter_by : TransactionType.(All | INVOICE | PAYMENT | CREDIT | REFUND)br/ 2)customer_id : Customer ID of the customerbr/PlaceHolder to replace : br/ customer_idbr/API DOC br/HELP DOC | deleteCustomerComment(array)br/ [DELETE] /customers/{customer_id}/comments/{comment_id} | customer_idbr/comment_id | Delete a particular customer comment.br/PlaceHolder to replace : br/ customer_idbr/ comment_id | activateCustomers(array)br/ [POST] /customers/markasactive?customer_ids={customer_ids} | customer_ids | Bulk marking multiple customers as activebr/Placeholders to replace : br/ customer_idsbr/customer_ids should be replaced by customer id's seperated by comma | disableCustomerPaymentReminder(array)br/ [POST] /customers/{customer_id}/paymentreminder/disable | customer_id | Disabling payment reminder for a particular customerbr/Placeholders to replace : br/ br/ customer_id | activateCustomer(array)br/ [POST] /customers/{customer_id}/markasactive | customer_id | Marking a particular customer as activebr/Placeholders to replace : br/ customer_idbr/API DOC br/HELP DOC | getCustomers(array)br/ [GET] /customers?filter_by={filter_by} | filter_by [default: Status.All] | Retrieving details of all the customersbr/Allowed parameters and its allowed values :br/ 1)filter_by : Status.(All | Active | Inactive | Gapps | Crm | NonSubscribers | PortalEnabled | PortalDisabled)br/API DOC br/HELP DOC | getCustomer(array)br/ [GET] /customers/{customer_id} | customer_id | Retrieving details of a particular customerbr/PlaceHolder to replace : br/ customer_idbr/API DOC br/HELP DOC | getCustomerComments(array)br/ [GET] /customers/{customer_id}/comments | customer_id | Retrieving comments of a particular customerbr/PlaceHolder to replace : br/ customer_idbr/HELP DOC | updateCustomer(array)br/ [PUT] /customers/{customer_id} | customer_idbr/display_namebr/salutationbr/first_namebr/last_namebr/emailbr/company_namebr/phonebr/mobilebr/websitebr/twitterbr/facebookbr/billing_addressbr/shipping_addressbr/currency_codebr/notesbr/payment_termsbr/payment_terms_labelbr/ach_supportedbr/custom_fieldsbr/default_templates | Updating the details of a particular customerbr/PlaceHolder to replace : br/ customer_idbr/API DOC br/HELP DOC | deleteCustomer(array)br/ [DELETE] /customers/{customer_id} | customer_id | Delete a particular customer.br/PlaceHolder to replace : br/ customer_idbr/API DOC br/HELP DOC | getCustomerUnusedCredits(array)br/ [GET] /customers/{customer_id}/unusedcredits | customer_id | Unused credit of a particular customerbr/PlaceHolder to replace : br/ customer_idbr/HELP DOC | deactivateCustomers(array)br/ [POST] /customers/markasinactive?customer_ids={customer_ids} | customer_ids | Bulk marking multiple customers as inactivebr/Placeholders to replace : br/ customer_idsbr/customer_ids should be replaced by customer id's seperated by comma | addCustomer(array)br/ [POST] /customers | display_namebr/salutationbr/first_namebr/last_namebr/emailbr/company_namebr/phonebr/mobilebr/websitebr/twitterbr/facebookbr/billing_addressbr/shipping_addressbr/currency_codebr/notesbr/payment_termsbr/payment_terms_labelbr/ach_supportedbr/custom_fieldsbr/default_templates | Creating a new customerbr/API DOC br/HELP DOC | deleteCustomers(array)br/ [DELETE] /customers?customer_ids={customer_ids} | customer_ids | Bulk deleting customersbr/PlaceHolders to replace : br/ customer_idsbr/customer_ids should be passed as a param. Make sure that the customer_ids are seperated by ,(comma)br/Eg: customer_ids=112072000001700227,11207200001700228br/HELP DOC | deactivateCustomer(array)br/ [POST] /customers/{customer_id}/markasinactive | customer_id | Marking a particular customer as inactivebr/Placeholders to replace : br/ customer_idbr/API DOC br/HELP DOC | enableCustomerPaymentReminder(array)br/ [POST] /customers/{customer_id}/paymentreminder/enable | customer_id | Enabling payment reminder for a particular customerbr/Placeholders to replace : br/ customer_id | deleteCustomerAddress(array)br/ [DELETE] /customers/{customer_id}/address/{address_id} | customer_idbr/address_id | Delete an existing customer's address.br/PlaceHolder to replace : br/ customer_idbr/ address_id | deleteCustomerPaypalAccount(array)br/ [DELETE] /customers/{customer_id}/paypalaccounts/{paypal_id} | customer_idbr/paypal_id | To delete a particular PayPal account of a particular customerbr/PlaceHolders to replace : br/ customer_idbr/ paypal_id | deleteProduct(array)br/ [DELETE] /products/{product_id} | product_id | Delete an existing product.br/PlaceHolder to replace : br/ product_idbr/API DOC br/HELP DOC | updateProduct(array)br/ [PUT] /products/{product_id} | product_idbr/namebr/descriptionbr/email_idsbr/redirect_url | Updating the details of a particular productbr/PlaceHolder to replace : br/ product_idbr/API DOC br/HELP DOC | addProduct(array)br/ [POST] /products | namebr/descriptionbr/email_idsbr/redirect_url | Creating a new productbr/API DOC br/HELP DOC | getProduct(array)br/ [GET] /products/{product_id}?showchild={showchild} | product_idbr/showchild [default: true] | Retreiving details of a productbr/Placeholders to be replaced : br/ product_idbr/Allowed parameters and its allowed values :br/ 1)show_child : true | falsebr/If show_child paramter is provided, all the plans, add-ons, couopons created under the product will be retreived.br/API DOC br/HELP DOC | activateProduct(array)br/ [POST] /products/{product_id}/markasactive | product_id | Marking a particular product as activebr/Placeholders to replace : br/ product_idbr/API DOC br/HELP DOC | getProducts(array)br/ [GET] /products?filter_by={filter_by} | filter_by [default: ProductStatus.All] | List of all Productsbr/Allowed parameters and its allowed values :br/ 1)filter_by : ProductStatus.(All | ACTIVE | INACTIVE | search)br/API DOC br/HELP DOC | deactivateProduct(array)br/ [POST] /products/{product_id}/markasinactive | product_id | Marking a particular product as inactivebr/Placeholders to replace : br/ product_idbr/API DOC br/HELP DOC | deleteSalesPerson(array)br/ [DELETE] /salespersons/{salesperson_id} | salesperson_id | Delete an existing salespersonbr/PlaceHolders to be replaced :br/ salesperson_id | deleteSalesPersons(array)br/ [DELETE] /salespersons?salesperson_ids={salesperson_ids} | salesperson_ids | Bulk delete multiple sales personsbr/PlaceHolders to be replaced : **br/ salesperson_idsbr/salesperson_ids should be replaced by sales person ids seperated by commas(,) | getSalesPersons()br/ [GET] /salespersons | [none] | List details of all sales person | deleteCreditnoteRefund(array)br/ [DELETE] /creditnotes/{creditnote_id}/refunds/{refund_id} | creditnote_idbr/refund_id | Delete an existing credit note refundbr/PlaceHolder to replace** : br/ creditnote_idbr/ refund_id | deleteCreditnote(array)br/ [DELETE] /creditnotes/{creditnote_id} | creditnote_id | Delete an existing credit notebr/PlaceHolder to replace : br/ creditnote_idbr/API DOC | deleteCreditnoteComment(array)br/ [DELETE] /creditnotes/{creditnote_id}/comments/{comment_id} | creditnote_idbr/comment_id | Delete a comment for a credit notebr/PlaceHolder to replace : br/ creditnote_idbr/ comment_id | getRefundCreditnote(array)br/ [GET] /creditnotes/refunds/{refund_id} | refund_id | Details of an existing refundbr/Placeholders to replace : br/ refund_idbr/API DOC | addCreditnoteRefunds(array)br/ [POST] /creditnotes/{creditnote_id}/refunds | creditnote_idbr/amountbr/description | Refund an existing credit notebr/PlaceHolder to replace : br/ creditnote_idbr/HELP DOC | deleteCreditnoteInvoice(array)br/ [DELETE] /creditnotes/{creditnote_id}/invoices/{creditnote_invoice_id} | creditnote_idbr/creditnote_invoice_id | Delete the credits applied to invoicesbr/PlaceHolder to replace : br/ creditnote_idbr/ creditnote_invoice_id | addCreditnoteInvoices(array)br/ [POST] /creditnotes/{creditnote_id}/invoices | creditnote_idbr/invoices | Apply credits from credit note to invoicesbr/PlaceHolders to be replaced :br/ creditnote_id | addInvoiceEmail(array)br/ [POST] /invoices/{creditnote_id}/email | creditnote_idbr/to_mail_idsbr/cc_mail_idsbr/subjectbr/body | Email a particular credit notebr/Placeholders to replace : br/ creditnote_id | openVoidCreditnote(array)br/ [POST] /creditnotes/{creditnote_id}/converttoopen | creditnote_id | Convert a voided credit note to openbr/PlaceHolder to replace : br/ creditnote_idbr/API DOC | voidCreditnote(array)br/ [POST] /creditnotes/{creditnote_id}/void | creditnote_id | Void an existing credit note for a particular customerbr/PlaceHolder to replace : br/ creditnote_idbr/API DOC | getCreditnote(array)br/ [GET] /creditnotes/{creditnotes_id} | creditnotes_id | Retrieve an existing credit notebr/PlaceHolder to replace : br/ creditnote_idbr/API DOC | addCreditnoteCustomFields(array)br/ [POST] /creditnotes/{creditnote_id}/customfields | creditnote_idbr/custom_fields | Updating custom fields for a credit notebr/You can update custom fields only if they are configuredbr/Placeholders to replace : br/ creditnote_id | addCreditnote(array)br/ [POST] /creditnotes | customer_idbr/contact_personsbr/creditnote_numberbr/ignore_auto_number_generationbr/reference_numberbr/datebr/exchange_ratebr/creditnote_itemsbr/custom_fieldsbr/notesbr/termsbr/template_id | Creating a Credit note for particular customerbr/API DOC br/HELP DOC | deleteCreditnotes(array)br/ [DELETE] /creditnotes?creditnote_ids={creditnote_ids} | creditnote_ids | Delete an existing credit note refundbr/PlaceHolder to replace : br/ creditnote_idsbr/creditnote_ids should be replaced by credit note ids seperated by commas(,) | getProductPlans(array)br/ [GET] /plans?product_id={product_id}&filter_by={filter_by} | product_idbr/filter_by [default: PlanStatus.All] | Listing all the plans for a specific productbr/Allowed parameters and its allowed values :br/ 1)filter_by : PlanStatus.(All | ACTIVE | INACTIVE | search)br/ 2)product_id : Product ID of a product. Allows to list all plans under the product.br/ 3)search_text : Any text value. Allows to search plans matching the text provided.br/PlaceHolders to replace : br/ product_idbr/API DOC br/HELP DOC | updatePlan(array)br/ [PUT] /plans/{plan_code} | plan_codebr/namebr/recurring_pricebr/intervalbr/interval_unitbr/billing_cyclesbr/trial_periodbr/setup_feebr/addonsbr/product_idbr/account_idbr/tax_idbr/description | Updating the details of a particular planbr/PlaceHolder to replace : br/ plan_codebr/API DOC br/HELP DOC | addPlan(array)br/ [POST] /plans | namebr/plan_codebr/product_idbr/descriptionbr/intervalbr/interval_unitbr/billing_cyclesbr/setup_pricebr/trial_periodbr/recurring_pricebr/account_idbr/tax_id | Creating a new planbr/API DOC br/HELP DOC | deactivatePlan(array)br/ [POST] /plans/{plan_code}/markasinactive | plan_code | Marking a plan as inactivebr/Place Holders to replace : br/ plan_codebr/API DOC br/HELP DOC | activatePlan(array)br/ [POST] /plans/{plan_code}/markasactive | plan_code | Marking a plan as activebr/Place Holders to replace : br/ plan_codebr/API DOC br/HELP DOC | getPlan(array)br/ [GET] /plans/{plan_code} | plan_code | Retreiving details of a particular planbr/PlaceHolder to replace : br/ plan_codebr/API DOC br/HELP DOC | deletePlan(array)br/ [DELETE] /plans/{plan_code} | plan_code | Delete an existing plan. A plan can only be deleted if it has no transactions associated with it.br/PlaceHolder to replace : br/ plan_codebr/API DOC br/HELP DOC | getPlans(array)br/ [GET] /plans?filter_by={filter_by} | filter_by [default: PlanStatus.All] | Listing all the plansbr/ br/Allowed parameters and its allowed values :br/ 1)filter_by : PlanStatus.(All | ACTIVE | INACTIVE | search)br/ 2)product_id : Product ID of a product. Allows to list all plans under the product.br/ 3)search_text : Any text value. Allows to search plans matching the text provided.br/API DOC br/HELP DOC | addSubscriptionNotes(array)br/ [POST] /subscriptions/{subscription_id}/notes | subscription_idbr/description | Notes related to a particular subscription can be added by any user at any timebr/PlaceHolder to replace : br/ subscription_idbr/API DOC br/HELP DOC | reactivateSubscription(array)br/ [POST] /subscriptions/{subscription_id}/reactivate | subscription_id | Reactivating a subscriptionbr/Only a subscription which is in "non-renewing" status can be reactivatedbr/PlaceHolder to replace : br/ subscription_idbr/API DOC br/HELP DOC | deleteSubscriptionNote(array)br/ [DELETE] /subscriptions/{subscription_id}/notes/{note_id} | subscription_idbr/note_id | Delete a specific note associated to a particular subscriptionbr/PlaceHolder to replace : br/ subscription_idbr/ note_idbr/API DOC | addSubscription(array)br/ [POST] /subscriptions | customer_idbr/planbr/addonsbr/coupon_codebr/payment_termsbr/payment_terms_labelbr/starts_atbr/exchange_ratebr/salesperson_namebr/reference_idbr/custom_fieldsbr/auto_collectbr/cardbr/payment_gateways | Creating an online subscription for an already existing customerbr/API DOC br/HELP DOC | cancelSubscriptions(array)br/ [POST] /subscriptions/bulkcancel?subscription_ids={subscription_ids} | subscription_ids | Bulk cancelling multiple subscriptionsbr/You can only cancel 25 subscriptions at a timebr/PlaceHolder to replace : br/ subscription_idsbr/HELP DOC | addSubscriptionLineItem(array)br/ [POST] /subscriptions/{subscription_id}/lineitems/{plan_code} | subscription_idbr/plan_codebr/description | Add/Edit description to a particular plan in the line items listbr/PlaceHolder to replace : br/ subscription_idbr/ plan_codebr/API DOC br/HELP DOC | deleteSubscriptionCard(array)br/ [DELETE] /subscriptions/{subscription_id}/card | subscription_id | Delete a card associated with the subscription. Once removed, the subscription will become an offline subscription.br/PlaceHolder to replace : br/ subscription_idbr/API DOC | updateSubscription(array)br/ [PUT] /subscriptions/{subscription_id} | subscription_id | Updating the details of a particular subscriptionbr/PlaceHolder to replace : br/ subscription_idbr/API DOC br/HELP DOC | addSubscriptionBankAccount(array)br/ [POST] /subscriptions/{subscription_id}/bankaccount | subscription_idbr/auto_collectbr/account_id | Associate an existing bank account/Update to an existing bank account with a subscriptionbr/PlaceHolder to replace : br/ subscription_idbr/HELP DOC | getSubscriptions(array)br/ [GET] /subscriptions?filter_by={filter_by}&customer_id={customer_id} | filter_by [default: SubscriptionStatus.All]br/customer_id | Listing all the subscriptionsbr/Allowed parameters and its allowed values :br/ 1)filter_by : SubscriptionStatus.(All \| IN_PROGRESS \| TRIAL \| FUTURE \| LIVE \| UNPAID \| PAST_DUE \| NON_RENEWING \| CANCELLED \| CANCELLED_FROM_DUNNING \| EXPIRED \| CREATION_FAILED \| TRIAL_EXPIRED \| CANCELLED_THIS_MONTH \| CANCELLED_LAST_MONTH \| ACTIVE)br/ SubscriptionMode.(ONLINE \| OFFLINE)br/ 2)customer_id : Customer ID of a customer. Lists all invoices of a customer.br/API DOC br/HELP DOC | setSubscriptionOnline(array)br/ [POST] /subscriptions/{subscription_id}/autocollect | subscription_idbr/auto_collect [default: true] | Change a particular subscription to online modebr/PlaceHolder to replace : br/ subscription_idbr/API DOC br/HELP DOC | getSubscription(array)br/ [GET] /subscriptions/{subscription_id} | subscription_id | Getting the details about a particular subscriptionbr/PlaceHolder to replace : br/ subscription_idbr/API DOC br/HELP DOC | addSubscriptionOnetimeAddon(array)br/ [POST] /subscriptions/{subscription_id}/buyonetimeaddon | subscription_idbr/addonsbr/exchange_ratebr/coupon_code | Include a one-time addon to a particular subscriptionbr/PlaceHolder to replace : br/ subscription_idbr/API DOC br/HELP DOC | addOfflineSubscription(array)br/ [POST] /subscriptions | customer_idbr/planbr/addonsbr/coupon_codebr/starts_atbr/exchange_ratebr/payment_termsbr/payment_terms_labelbr/salesperson_namebr/reference_idbr/custom_fieldsbr/auto_collect [default: false]br/payment_gateways | Creating an offline subscription for an already existing customerbr/API DOC br/HELP DOC | addSubscriptionCoupon(array)br/ [POST] /subscriptions/{subscription_id}/coupons/{coupon_code} | subscription_idbr/coupon_code | Associating a coupon to a paricular subscriptionbr/PlaceHolder to replace : br/ subscription_idbr/ coupon_codebr/API DOC br/HELP DOC | deleteSubscription(array)br/ [DELETE] /subscriptions/{subscription_id} | subscription_id | Deleting an existing subscriptionbr/PlaceHolder to replace : br/ subscription_idbr/API DOC br/HELP DOC | getSubscriptionScheduledChanges(array)br/ [GET] /subscriptions/{subscription_id}/scheduledchanges | subscription_id | Retrieving the scheduled changes of a particular subscriptionbr/PlaceHolder to replace : br/ subscription_idbr/API DOC br/HELP DOC | addSubscriptionCard(array)br/ [POST] /subscriptions/{subscription_id}/card | subscription_idbr/card_idbr/auto_collect | Associate/Update card with an existing card for a particular subscriptionbr/PlaceHolder to replace : br/ subscription_idbr/API DOC br/HELP DOC | getSubscriptionRecentActivities(array)br/ [GET] /subscriptions/{subscription_id}/recentactivities | subscription_id | Retrieving all activities of a particular subscriptionbr/PlaceHolder to replace : subscription_idbr/API DOC br/HELP DOC | getSubscriptionNotes(array)br/ [GET] /subscriptions/{subscription_id}/notes | subscription_id | Retrieving notes of a particular subscriptionbr/PlaceHolder to replace : br/ subscription_idbr/HELP DOC | deleteSubscriptionScheduledChanges(array)br/ [DELETE] /subscriptions/{subscription_id}/scheduledchanges | subscription_id | Dropping the scheduled changes of a particular subscriptionbr/PlaceHolder to replace : br/ subscription_id | addSubscriptionCustomFields(array)br/ [POST] /subscriptions/{subscription_id}/customfields | subscription_idbr/custom_fields | Update custome fields for a particular subscriptionbr/PlaceHolder to replace : subscription_idbr/API DOC br/HELP DOC | addSubscriptionNewBankAccount(array)br/ [POST] /subscriptions/{subscription_id}/bankaccount | subscription_idbr/bank_accountbr/auto_collect | Associate/Update bank account with a new bank account for a particular subscriptionbr/PlaceHolder to replace : br/ subscription_idbr/HELP DOC | addSubscriptionsCompute(array)br/ [POST] /subscriptions/compute | subscription_idbr/planbr/addonsbr/coupon_codebr/starts_atbr/exchange_ratebr/payment_termsbr/payment_terms_labelbr/salesperson_namebr/reference_idbr/custom_fieldsbr/auto_collectbr/payment_gateways | Preview amount of the subscription and invoice. This can be called while both at time of creating a subscription/updating a subscription.br/For compute during update, you will have to pass the subscription_id node in the JSON bodybr/HELP DOC | setSubscriptionOffline(array)br/ [POST] /subscriptions/{subscription_id}/autocollect | subscription_idbr/auto_collect [default: false] | Change a particular subscription to offline modebr/PlaceHolder to replace : br/ subscription_idbr/API DOC br/HELP DOC | updateSubscriptionCard(array)br/ [POST] /subscriptions/{subscription_id}/card | subscription_idbr/cardbr/auto_collect | Associate/Update card with a new card for a particular subscriptionbr/PlaceHolder to replace : br/ subscription_idbr/API DOC br/HELP DOC | addSubscriptionOnetimeCharge(array)br/ [POST] /subscriptions/{subscription_id}/charge | subscription_idbr/amountbr/description | Charge a one-time amount for a subscriptionbr/PlaceHolder to replace : br/ subscription_idbr/API DOC br/HELP DOC | addNewCustomerSubscription(array)br/ [POST] /subscriptions | customerbr/cardbr/starts_atbr/exchange_ratebr/planbr/addonsbr/custom_fieldsbr/payment_termsbr/payment_terms_labelbr/coupon_codebr/auto_collectbr/salesperson_namebr/reference_idbr/payment_gateways | Creating a subscription for a new customerbr/This works as a quick-createbr/Customer while creating the subscriptionbr/API DOC br/HELP DOC | cancelSubscriptionNow(array)br/ [POST] /subscriptions/{subscription_id}/cancel?cancel_at_end={cancel_at_end} | subscription_idbr/cancel_at_end [default: false] | Cancelling the subscription immediatelybr/PlaceHolder to replace : br/ subscription_idbr/API DOC br/HELP DOC | addSubscriptionPaypalAccount(array)br/ [POST] /subscriptions/{subscription_id}/paypalaccount | subscription_idbr/paypal_id | Associate/Update PayPal account with an existing PayPal account for a particular subscriptionbr/PlaceHolder to replace : br/ subscription_idbr/HELP DOC | postponeSubscription(array)br/ [POST] /subscriptions/{subscription_id}/postpone | subscription_idbr/renewal_at | Renewal date refers to the billing date of the subsequent term.br/You can postpone date of renewal of the subscription by specifying an appropriate date on which the customer should be billed. No prorated charges will be applied. Billing date for the subscription will be replaced by the date which you providebr/PlaceHolder to replace : br/ subscription_idbr/API DOC br/HELP DOC | deleteSubscriptionBankAccount(array)br/ [DELETE] /subscriptions/{subscription_id}/bankaccount | subscription_id | Delete a bank account associated with the subscription. Once removed, the subscription will become an offline subscription.br/PlaceHolder to replace : br/ subscription_id | addSubscriptionContactPersons(array)br/ [POST] /subscriptions/{subscription_id}/contactpersons | subscription_idbr/contactpersons | Associate an existing contact person with a particular subscriptionbr/PlaceHolder to replace : br/ subscription_idbr/API DOC br/HELP DOC | addSubscriptionReference(array)br/ [POST] /subscriptions/{subscription_id}/reference | subscription_idbr/reference_id | Update reference id to easily identify and keep track of your subscriptionbr/PlaceHolder to replace : br/ subscription_idbr/API DOC br/HELP DOC | getCustomersSubscriptions(array)br/ [GET] /subscriptions?filter_by={filter_by}&customer_id={customer_id} | filter_by [default: SubscriptionStatus.All]br/customer_id | Listing all the subscriptionsbr/Allowed parameters and its allowed values :br/ 1)filter_by : SubscriptionStatus.(All \| IN_PROGRESS \| TRIAL \| FUTURE \| LIVE \| UNPAID \| PAST_DUE \| NON_RENEWING \| CANCELLED \| CANCELLED_FROM_DUNNING \| EXPIRED \| CREATION_FAILED \| TRIAL_EXPIRED \| CANCELLED_THIS_MONTH \| CANCELLED_LAST_MONTH \| ACTIVE)br/ SubscriptionMode.(ONLINE \| OFFLINE)br/ 2)customer_id : Customer ID of a customer. Lists all invoices of a customer.br/ br/PlaceHolder to be placed :br/ br/ customer_idbr/API DOC br/HELP DOC | addSubscriptionAddonLineItem(array)br/ [POST] /subscriptions/{subscription_id}/lineitems/{addon_code} | subscription_idbr/addon_codebr/description | Add/Edit description to a particular add-on in the line items listbr/PlaceHolder to replace : br/ subscription_idbr/ addon_codebr/API DOC br/HELP DOC | deleteSubscriptionCoupons(array)br/ [DELETE] /subscriptions/{subscription_id}/coupons | subscription_id | To remove coupon associated with a subscriptionbr/PlaceHolder to replace : br/ subscription_idbr/API DOC | cancelSubscription(array)br/ [POST] /subscriptions/{subscription_id}/cancel?cancel_at_end={cancel_at_end} | subscription_idbr/cancel_at_end [default: true] | Cancelling the subscription at the end of term of subscriptionbr/PlaceHolder to replace : br/ subscription_idbr/API DOC br/HELP DOC | addSubscriptionSalesPerson(array)br/ [POST] /subscriptions/{subscription_id}/salesperson | subscription_idbr/salesperson_name | Update sales person associated with a particular subscriptionbr/PlaceHolder to replace : br/ subscription_idbr/API DOC br/HELP DOC | getCustomerCard(array)br/ [GET] /customers/{customer_id}/cards/{card_id} | customer_idbr/card_id | Retrieving details of a particular card for a particular customerbr/Placeholders to replace : br/ customer_idbr/ card_idbr/API DOC br/HELP DOC | deleteCustomerCard(array)br/ [DELETE] /customers/{customer_id}/cards/{card_id} | customer_idbr/card_id | To delete a particular credit card for a customerbr/PlaceHolders to replace : br/ customer_idbr/ card_idbr/API DOC | addCustomerCards(array)br/ [POST] /customers/{customer_id}/cards | customer_idbr/card_numberbr/expiry_monthbr/expiry_yearbr/cvv_numberbr/first_namebr/last_namebr/streetbr/citybr/statebr/countrybr/zipbr/payment_gateway | Creating a new card for an existing customerbr/PlaceHolder to replace : customer_idbr/API DOC | getCustomerCards(array)br/ [GET] /customers/{customer_id}/cards | customer_id | Retrieving details of all cards for a particular customerbr/Placeholders to replace : br/ customer_idbr/API DOC br/HELP DOC | updateCustomerCard(array)br/ [PUT] /customers/{customer_id}/cards/{card_id} | customer_idbr/card_idbr/card_numberbr/expiry_monthbr/expiry_yearbr/cvv_numberbr/first_namebr/last_namebr/streetbr/citybr/statebr/countrybr/zipbr/payment_gateway | Editing the existing Credit card information for a customerbr/PlaceHolders to be replaced : br/ customer_idbr/ card_idbr/ br/API DOC | activateCoupon(array)br/ [POST] /coupons/{coupon_code}/markasactive | coupon_code | Marking a coupon as activebr/Place Holders to replace : br/ coupon_codebr/API DOC br/HELP DOC | deleteCoupon(array)br/ [DELETE] /coupons/{coupon_code} | coupon_code | Delete an existing coupon.br/PlaceHolders to replace : br/ coupon_codebr/API DOC br/HELP DOC | updateCoupon(array)br/ [PUT] /coupons/{coupon_code} | coupon_codebr/namebr/descriptionbr/max_redemptionbr/expiry_at | Updating the details of a particular couponbr/PlaceHolder to replace : br/ coupon_codebr/API DOC br/HELP DOC | deactivateCoupon(array)br/ [POST] /coupons/{coupon_code}/markasinactive | coupon_code | Marking a coupon as inactivebr/Place Holders to replace : br/ coupon_codebr/API DOC br/HELP DOC | addCoupon(array)br/ [POST] /coupons | coupon_codebr/namebr/descriptionbr/typebr/discount_bybr/discount_valuebr/product_idbr/max_redemptionbr/expiry_atbr/apply_to_plansbr/plansbr/apply_to_addonsbr/addons | Creating a new couponbr/API DOC br/HELP DOC | getCoupons(array)br/ [GET] /coupons?filter_by={filter_by}&product_id={product_id} | filter_by [default: CouponStatus.All]br/product_id | Retrieving details of all couponsbr/Allowed parameters and its allowed values :br/ 1)filter_by : CouponStatus.(All | ACTIVE | INACTIVE | EXPIRED),searchbr/ 2)product_id : Product ID of a product. Allows to list all coupons under the product.br/ 3)search_text : Any text value. Allows to search coupons matching the text providedbr/API DOC br/HELP DOC | getCoupon(array)br/ [GET] /coupons/{coupon_code} | coupon_code | Retrieving details of a particular couponbr/PlaceHolder to replace : coupon_codebr/API DOC br/HELP DOC | get()br/ [GET] / | [none] | Lists all resources API endpoint of Zoho Subscriptions | getEvent(array)br/ [GET] /events/{event_id} | event_id | Retrieving details of an existing eventbr/Placeholders to replace : br/ event_idbr/API DOC | getEvents(array)br/ [GET] /events?filter_by={filter_by} | filter_by [default: EventTime.All] | Retrieving list of all eventsbr/Allowed parameters and its allowed values :br/ 1)filter_by : EventTime.(All \| LastMonth \| LastWeek \| Today \| ThisWeek \| ThisMonth \| CustomDate)br/ EventType.(All \| subscription_created \| subscription_upgraded \| subscription_downgraded \| subscription_renewed \| subscription_cancelled \| subscription_expiring \| subscription_expired \| onetimeaddon_purchased \| subscription_activation \| subscription_reactivated \| invoice_notification \| payment_thankyou \| payment_declined \| payment_refunded \| trial_expiring \| subscription_cancelling \| card_expired \| card_expiring \| subscription_ahead \| subscription_deleted \| creditnote_added \| creditnote_updated \| creditnote_deleted \| card_deleted \| billing_date_changed)br/ InvoiceDate.(ThisMonth \| PreviousMonth)br/ 2)event_start_date : Custom start date in YYYY-MM-DD format.br/ 3)event_end_date : Custom end date in YYYY-MM-DD format.br/ 4)sort_column : event_time \| event_id \| notified_timebr/API DOC | addPayment(array)br/ [POST] /payments | customer_idbr/amountbr/datebr/payment_modebr/descriptionbr/reference_numberbr/invoicesbr/exchange_ratebr/bank_chargesbr/tax_account_idbr/account_idbr/custom_fields | Recording a new offline payment for a customerbr/API DOC br/HELP DOC | getPayment(array)br/ [GET] /payments/{payment_id} | payment_id | Retrieve details of a particular paymentbr/Placeholders to replace : br/ payment_idbr/API DOC | addPaymentRefunds(array)br/ [POST] /payments/{payment_id}/refunds | payment_idbr/amountbr/description | A new credit note is created for the amount to be refund. Refund is then made for the credit note.br/Placeholders to replace : br/ payment_idbr/HELP DOC | deletePayment(array)br/ [DELETE] /payments/{payment_id} | payment_id | Delete an existing payment.br/Placeholders to replace : br/ payment_idbr/API DOC br/HELP DOC | addProductCustomFields(array)br/ [POST] /products/{product_id}/customfields | product_idbr/custom_fields | Updating custom fields for a paymentbr/You can update custom fields only if they are configuredbr/Placeholders to replace : br/ payment_id | updatePayment(array)br/ [PUT] /payments/{payment_id} | payment_idbr/customer_idbr/amountbr/datebr/payment_modebr/descriptionbr/reference_numberbr/invoicesbr/exchange_ratebr/bank_chargesbr/tax_account_idbr/account_idbr/custom_fields | Update an existing new paymentbr/Placeholders to replace : br/ payment_idbr/API DOC | getWebhook(array)br/ [GET] /webhooks/{webhook_id} | webhook_id | Retrieving details of a particular webhooks that has been triggeredbr/PlaceHolders to replace : br/ webhook_id | getWebhooks()br/ [GET] /webhooks | [none] | Retrieving details of all webhooks triggeredbr/Allowed parameters and its allowed values :br/ 1)filter_by : WebhookInitiatedTime.(All \| LastMonth \| LastWeek \| Today \| ThisWeek \| ThisMonth \| CustomDate)br/ 2)status_filter : all | success | failurebr/ 3)sort_column : last_updated_time | webhook_idbr/ 4)webhook_initiated_start_date : Webhook Custom initiated start date. Needed if CustomDate option is chosen for filter_by param.br/ 5)webhook_initiated_end_date : Webhook Custom initiated end date. Needed if CustomDate option is chosen for filter_by param. | updateCustomerContactPerson(array)br/ [PUT] /customers/{customer_id}/contactpersons/{contactperson_id} | customer_idbr/contactperson_idbr/salutationbr/first_namebr/last_namebr/emailbr/phonebr/mobilebr/faxbr/twitterbr/designationbr/department | Updating a particular contact person for a particular customerbr/Placeholders to replace : br/ customer_idbr/ contactperson_idbr/API DOC br/HELP DOC | addCustomerContactPersons(array)br/ [POST] /customers/{customer_id}/contactpersons | customer_idbr/salutationbr/first_namebr/last_namebr/emailbr/phonebr/mobilebr/faxbr/twitterbr/designationbr/department | Creating a contact person for an existing customerbr/Placeholders to replace : br/ customer_idbr/API DOC br/HELP DOC | getCustomerContactPersons(array)br/ [GET] /customers/{customer_id}/contactpersons | customer_id | List of all contact persons for a particular customerbr/Placeholders to replace :br/ customer_idbr/API DOC br/HELP DOC | addCustomerPrimaryContactPerson(array)br/ [POST] /customers/{customer_id}/contactpersons/{contactperson_id}/primary | customer_idbr/contactperson_idbr/salutationbr/first_namebr/last_namebr/emailbr/phonebr/mobilebr/faxbr/twitterbr/facebook | Mark a contact person as primary contact for a customerbr/Placeholders to replace : br/ customer_idbr/ contactperson_id | deleteCustomerContactPerson(array)br/ [DELETE] /customers/{customer_id}/contactpersons/{contactperson_id} | customer_idbr/contactperson_id | Delete an existing contact person.br/Placeholders to replace : br/ customer_idbr/ contactperson_idbr/API DOC br/HELP DOC | getCustomerContactPerson(array)br/ [GET] /customers/{customer_id}/contactpersons/{contactperson_id} | customer_idbr/contactperson_id | Retrieving details of a particular contact person for a particular customerbr/Placeholders to replace : br/ customer_idbr/ contactperson_idbr/API DOC br/HELP DOC | deleteCustomerBankAccount(array)br/ [DELETE] /customers/{customer_id}/bankaccounts/{account_id} | customer_idbr/account_id | To delete a particular Bank account of a particular customerbr/PlaceHolders to replace :br/ customer_idbr/ account_id | updateCustomerBankAccount(array)br/ [PUT] /customers/{customer_id}/bankaccounts/{account_id} | customer_idbr/account_idbr/account_numberbr/routing_numberbr/account_typebr/bank_namebr/first_namebr/last_namebr/accept_licensebr/authorization_typebr/payment_gateway | Editing the existing Bank Account information for a particular customerbr/PlaceHolders to replace : br/ customer_id br/ account_idbr/ | addCustomerBankAccounts(array)br/ [POST] /customers/{customer_id}/bankaccounts | customer_idbr/account_numberbr/account_typebr/routing_numberbr/bank_namebr/first_namebr/last_namebr/accept_licensebr/authorization_typebr/payment_gateway | Creating a new bank account for a particular customerbr/PlaceHolder to replace : br/ customer_idbr/ | getCustomerBankAccount(array)br/ [GET] /customers/{customer_id}/bankaccounts/{account_id} | customer_idbr/account_id | Retrieving details of a particular bank account for a particular customerbr/Placeholders to replace : br/ customer_id br/ account_idbr/API DOC br/HELP DOC | activateAddon(array)br/ [POST] /addons/{addon_code}/markasactive | addon_code | Marking an addon as activebr/Place Holders to replace : br/ addon_codebr/API DOC br/HELP DOC | addAddon(array)br/ [POST] /addons | namebr/addon_codebr/descriptionbr/applicable_to_all_plansbr/plansbr/typebr/unit_namebr/pricing_scheme [default: package]br/price_bracketsbr/interval_unitbr/product_idbr/account_idbr/tax_id | Creating a new addon of package pricing scheme.br/API DOC br/HELP DOC br/To know more about Pricing Scheme | getAddon(array)br/ [GET] /addons/{addon_code} | addon_code | Getting the Details of a particular add-onbr/PlaceHolder to replace :br/ addon_codebr/API DOC br/HELP DOC | getAddons(array)br/ [GET] /addons?filter_by={filter_by}&product_id={product_id}&plan_code={plan_code} | filter_by [default: AddonStatus.All]br/product_idbr/plan_code | Listing all the add-onsbr/Allowed parameters and its allowed values :br/ 1)filter_by : AddonStatus.(All | ACTIVE | INACTIVE | ONETIME | RECURRING), searchbr/ 2)product_id : Product ID of a product. Allows to list all plans under the product.br/ 3)plan_code : Plan code. Filters add-ons associated to the provided plan code.br/ 4)search_text : Any text value. Allows to search add-ons matching the text providedbr/API DOC br/HELP DOC | getProductAddons(array)br/ [GET] /addons?product_id={product_id}&filter_by={filter_by}&plan_code={plan_code} | product_idbr/filter_by [default: AddonStatus.All]br/plan_code | Listing all the add-ons of a particular productbr/PlaceHolders to replace: product_idbr/Allowed filter_by valuesbr/ 1)filter_by : AddonStatus.(All | ACTIVE | INACTIVE | ONETIME | RECURRING), searchbr/ 2)product_id : Product ID of a product. Allows to list all plans under the product.br/ 3)plan_code : Plan code. Filters add-ons associated to the provided plan code.br/ 4)search_text : Any text value. Allows to search add-ons matching the text providedbr/HELP DOC | addTireAddon(array)br/ [POST] /addons | namebr/addon_codebr/descriptionbr/applicable_to_all_plansbr/plansbr/typebr/pricing_scheme [default: tire]br/unit_namebr/price_bracketsbr/interval_unitbr/product_idbr/account_idbr/tax_id | Creating a new addon of tier pricing scheme.br/API DOC br/HELP DOC br/To know more about Pricing Scheme | addUnitAddon(array)br/ [POST] /addons | namebr/addon_codebr/descriptionbr/applicable_to_all_plansbr/plansbr/typebr/pricing_scheme [default: unit]br/unit_namebr/price_bracketsbr/interval_unitbr/product_idbr/account_idbr/tax_id | Creating a new addon of unit pricing scheme.br/API DOC br/HELP DOC br/To know more about Pricing Scheme | updateAddon(array)br/ [PUT] /addons/{addon_code} | addon_codebr/namebr/unit_namebr/pricing_schemebr/price_bracketsbr/typebr/interval_unitbr/applicable_to_all_plansbr/plansbr/product_idbr/account_idbr/descriptionbr/tax_id | Updating the details of a particular addonbr/PlaceHolder to replace : br/ addon_codebr/API DOC br/HELP DOC | getPlanAddons(array)br/ [GET] /addons?plan_code={plan_code}&filter_by={filter_by} | plan_codebr/filter_by [default: AddonStatus.All] | Listing all the add-ons associated to a particular planbr/PlaceHolders to replace: br/ plan_codebr/Allowed filter_by valuesbr/ 1)filter_by : AddonStatus.(All | ACTIVE | INACTIVE | ONETIME | RECURRING), searchbr/ 2)product_id : Product ID of a product. Allows to list all plans under the product.br/ 3)plan_code : Plan code. Filters add-ons associated to the provided plan code.br/ 4)search_text : Any text value. Allows to search add-ons matching the text providedbr/HELP DOC | addVolumeAddon(array)br/ [POST] /addons | namebr/addon_codebr/descriptionbr/applicable_to_all_plansbr/plansbr/typebr/pricing_scheme [default: volume]br/unit_namebr/price_bracketsbr/interval_unitbr/product_idbr/account_idbr/tax_id | Creating a new addon of volume pricing scheme.br/API DOC br/HELP DOC br/To know more about Pricing Scheme | deleteAddon(array)br/ [DELETE] /addons/{addon_code} | addon_code | Deleting a particular addonbr/PlaceHolder to replace : br/ br/ addon_codebr/API DOC br/HELP DOC | deactivateAddon(array)br/ [POST] /addons/{addon_code}/markasinactive | addon_code | Marking an addon as inactivebr/Place Holders to replace : br/ addon_codebr/API DOC br/HELP DOC | addInvoiceCollect(array)br/ [POST] /invoices/{invoice_id}/collect | invoice_idbr/card_id | Charge a customer for an invoice with an existing cardbr/Placeholders to replace : br/ invoice_idbr/API DOC | updateInvoiceAddress(array)br/ [PUT] /invoices/{invoice_id}/address | invoice_idbr/billing_addressbr/shipping_address | Update shipping and billing address of an invoicebr/Placeholders to replace : br/ invoice_idbr/API DOC | getInvoice(array)br/ [GET] /invoices/{invoice_id} | invoice_id | Retrieve details of an existing invoicebr/Placeholders to replace : invoice_idbr/API DOC | downloadInvoiceAsPdf(array)br/ [GET] /invoices/{invoice_id}?accept={accept} | invoice_idbr/accept [default: pdf] | Download a particular invoice as a pdf filebr/Placeholders to replace : br/ invoice_id | setInvoicesAsSent(array)br/ [POST] /invoices/sent?invoice_ids={invoice_ids} | invoice_ids | Bulk making invoices as Sentbr/Placeholders to replace : br/ invoice_ids | getInvoices(array)br/ [GET] /invoices?filter_by={filter_by} | filter_by [default: Status.All] | List of all invoicesbr/Allowed parameters and its allowed values :br/ 1)filter_by : Status.(All \| Sent \| Draft \| OverDue \| Paid \| Void \| Unpaid \| PartiallyPaid \| Viewed)br/ ACHPaymentInitiatedbr/ InvoiceDate.(ThisMonth \| PreviousMonth)br/ 2)customer_id : Customer ID of a customer. Lists all invoices of a customer.br/ 3)subscription_id : Subscription ID of a subscription. Lists all invoices of a subscription.br/ br/API DOC | addInvoiceSalesPerson(array)br/ [POST] /invoices/{invoice_id}/salesperson | invoice_idbr/salesperson_name | Update sales person for a particular invoicebr/Placeholders to replace : br/ invoice_idbr/API DOC | addInvoiceComments(array)br/ [POST] /invoices/{invoice_id}/comments | invoice_idbr/description | Add comments to an invoicebr/Placeholders to replace : br/ invoice_id | enableInvoicePaymentReminder(array)br/ [POST] /invoices/{invoice_id}/paymentreminder/enable | invoice_id | Enabling payment reminder for a particular invoicebr/Placeholders to replace : br/ invoice_id | setInvoiceAsSent(array)br/ [POST] /invoices/{invoice_id}/sent | invoice_id | Making a draft invoice as Sentbr/Placeholders to replace : br/ invoice_id | openInvoice(array)br/ [POST] /invoices/{invoice_id}/converttoopen | invoice_id | Change the status of an invoice to openbr/Placeholders to replace : br/ invoice_idbr/API DOC | getInvoiceRecentActivities(array)br/ [GET] /invoices/{invoice_id}/recentactivities | invoice_id | Retrieving recent activities of a particular invoicebr/Placeholders to replace : br/ invoice_id | emailInvoice(array)br/ [POST] /invoices/{invoice_id}/email | invoice_idbr/to_mail_idsbr/cc_mail_idsbr/subjectbr/body | Email a particular invoicebr/Placeholders to replace : br/ invoice_id | deleteInvoiceComment(array)br/ [DELETE] /invoices/{invoice_id}/comments/{comment_id} | invoice_idbr/comment_id | Deleting a particular comment of an invoicebr/Placeholders to replace : br/ invoice_idbr/ comment_id | addInvoiceCustomFields(array)br/ [POST] /invoices/{invoice_id}/customfields | invoice_idbr/custom_fields | Updating custom fields for an invoicebr/You can update custom fields only if they are configuredbr/Placeholders to replace : br/ invoice_idbr/API DOC | disableInvoicePaymentReminder(array)br/ [POST] /invoices/{invoice_id}/paymentreminder/disable | invoice_id | Stop all payment reminder for a particular invoicebr/Placeholders to replace : br/ invoice_id | getBankAccountPendingInvoices(array)br/ [GET] /bankaccounts/{account_id}/pendinginvoices | account_id | Retrieving ACH pending invoices of a particular bank accountbr/Placeholders to replace : br/ account_id | getInvoiceComments(array)br/ [GET] /invoices/{invoice_id}/comments | invoice_id | Retrieving comments of a particular invoicebr/Placeholders to replace : br/ invoice_id | writeoffInvoice(array)br/ [POST] /invoices/{invoice_id}/writeoff | invoice_id | Write off a particularinvoicebr/Placeholders to replace : br/ invoice_idbr/API DOC | cancelInvoiceWriteoff(array)br/ [POST] /invoices/{invoice_id}/cancelwriteoff | invoice_id | Cancel write off for a particular invoicebr/Placeholders to replace : br/ invoice_idbr/API DOC | deleteInvoiceCreditsApplied(array)br/ [DELETE] /invoices/{invoice_id}/creditsapplied/{creditnotes_invoice_id} | invoice_idbr/creditnotes_invoice_id | Deleting an existing credit applied to the invoice.br/Placeholders to replace : br/ invoice_idbr/ creditnotes_invoice_id | deleteInvoice(array)br/ [DELETE] /invoices/{invoice_id} | invoice_id | Deleting an existing invoice.br/Placeholders to replace : br/ invoice_idbr/HELP DOC | addBankAccountCharge(array)br/ [POST] /invoices/{invoice_id}/collect | invoice_idbr/account_id | Charge a customer for an invoice with an existing bank accountbr/Placeholders to replace : br/ invoice_idbr/API DOC | setInvoicePaymentDate(array)br/ [POST] /invoices/{invoice_id}/paymentdate | invoice_idbr/payment_expected_datebr/stop_reminder_until_payment_expected_date | Update expected payment date fop the invoice. Reminders won't be sent till the date specifiedbr/Placeholders to replace : br/ invoice_id | voidInvoice(array)br/ [POST] /invoices/{invoice_id}/void | invoice_id | Making an invoice as voidbr/Placeholders to replace : br/ invoice_idbr/API DOC | addInvoiceCredits(array)br/ [POST] /invoices/{invoice_id}/credits | invoice_idbr/apply_creditnotes | Use the customer's open credits to the invoicebr/PlaceHolders to be replaced :br/ invoice_idbr/ | addInvoiceLineItems(array)br/ [POST] /invoices/{invoice_id}/lineitems | invoice_idbr/invoice_items | Add items to a pending invoicebr/Placeholders to replace : br/ invoice_idbr/API DOC | getPricebooks()br/ [GET] /pricebooks | [none] | Retreiving list of all pricebooks | deleteOrganization(array)br/ [DELETE] /organizations/{organization_id} | organization_id | Deleting a particular Organizationbr/PlaceHolders to be replaced :br/ organization_id | getOrganizations()br/ [GET] /organizations | [none] | Retrieving Details of all Organizations |, _(*13)