{ "operations": { "getHostedpage": { "httpMethod": "GET", "uri": "hostedpages/{hostedpage_id}", "responseModel": "getResponse", "parameters": { "hostedpage_id": { "location": "uri" } } }, "getHostedpages": { "httpMethod": "GET", "uri": "hostedpages", "responseModel": "getResponse", "parameters": [] }, "addNewSubscriptionHostedpages": { "httpMethod": "POST", "uri": "hostedpages/newsubscription", "responseModel": "getResponse", "parameters": { "customer_id": { "location": "json" }, "pricebook_id": { "location": "json" }, "customer": { "location": "json" }, "contactpersons": { "location": "json" }, "plan": { "location": "json" }, "addons": { "location": "json" }, "starts_at": { "location": "json" }, "custom_fields": { "location": "json" }, "coupon_code": { "location": "json" }, "reference_id": { "location": "json" }, "additional_param": { "location": "json" }, "salesperson_name": { "location": "json" }, "redirect_url": { "location": "json" } } }, "addNewCustomerNewSubscriptionHostedpages": { "httpMethod": "POST", "uri": "hostedpages/newsubscription", "responseModel": "getResponse", "parameters": { "plan": { "location": "json" }, "addons": { "location": "json" }, "starts_at": { "location": "json" }, "custom_fields": { "location": "json" }, "coupon_code": { "location": "json" }, "reference_id": { "location": "json" }, "additional_param": { "location": "json" }, "redirect_url": { "location": "json" } } }, "addUpdateCardHostedpages": { "httpMethod": "POST", "uri": "hostedpages/updatecard", "responseModel": "getResponse", "parameters": { "subscription_id": { "location": "json" }, "additional_param": { "location": "json" }, "redirect_url": { "location": "json" } } }, "addOnetimeAddonHostedpages": { "httpMethod": "POST", "uri": "hostedpages/buyonetimeaddon", "responseModel": "getResponse", "parameters": { "subscription_id": { "location": "json" }, "addons": { "location": "json" }, "additional_param": { "location": "json" }, "redirect_url": { "location": "json" } } }, "addUpdateSubscriptionHostedpages": { "httpMethod": "POST", "uri": "hostedpages/updatesubscription", "responseModel": "getResponse", "parameters": { "subscription_id": { "location": "json" }, "contactpersons": { "location": "json" }, "plan": { "location": "json" }, "addons": { "location": "json" }, "reference_id": { "location": "json" }, "starts_at": { "location": "json" }, "additional_param": { "location": "json" }, "redirect_url": { "location": "json" } } }, "getTransactions": { "httpMethod": "GET", "uri": "transactions?customer_id={customer_id}&filter_by={filter_by}", "responseModel": "getResponse", "parameters": { "customer_id": { "location": "uri" }, "filter_by": { "location": "uri", "default": "TransactionType.ALL" } } }, "deleteCustomerComment": { "httpMethod": "DELETE", "uri": "customers/{customer_id}/comments/{comment_id}", "responseModel": "getResponse", "parameters": { "customer_id": { "location": "uri" }, "comment_id": { "location": "uri" } } }, "activateCustomers": { "httpMethod": "POST", "uri": "customers/markasactive?customer_ids={customer_ids}", "responseModel": "getResponse", "parameters": { "customer_ids": { "location": "uri" } } }, "disableCustomerPaymentReminder": { "httpMethod": "POST", "uri": "customers/{customer_id}/paymentreminder/disable", "responseModel": "getResponse", "parameters": { "customer_id": { "location": "uri" } } }, "activateCustomer": { "httpMethod": "POST", "uri": "customers/{customer_id}/markasactive", "responseModel": "getResponse", "parameters": { "customer_id": { "location": "uri" } } }, "getCustomers": { "httpMethod": "GET", "uri": "customers?filter_by={filter_by}", "responseModel": "getResponse", "parameters": { "filter_by": { "location": "uri", "default": "Status.All" } } }, "getCustomer": { "httpMethod": "GET", "uri": "customers/{customer_id}", "responseModel": "getResponse", "parameters": { "customer_id": { "location": "uri" } } }, "getCustomerComments": { "httpMethod": "GET", "uri": "customers/{customer_id}/comments", "responseModel": "getResponse", "parameters": { "customer_id": { "location": "uri" } } }, "updateCustomer": { "httpMethod": "PUT", "uri": "customers/{customer_id}", "responseModel": "getResponse", "parameters": { "customer_id": { "location": "uri" }, "display_name": { "location": "json" }, "salutation": { "location": "json" }, "first_name": { "location": "json" }, "last_name": { "location": "json" }, "email": { "location": "json" }, "company_name": { "location": "json" }, "phone": { "location": "json" }, "mobile": { "location": "json" }, "website": { "location": "json" }, "twitter": { "location": "json" }, "facebook": { "location": "json" }, "billing_address": { "location": "json" }, "shipping_address": { "location": "json" }, "currency_code": { "location": "json" }, "notes": { "location": "json" }, "payment_terms": { "location": "json" }, "payment_terms_label": { "location": "json" }, "ach_supported": { "location": "json" }, "custom_fields": { "location": "json" }, "default_templates": { "location": "json" } } }, "deleteCustomer": { "httpMethod": "DELETE", "uri": "customers/{customer_id}", "responseModel": "getResponse", "parameters": { "customer_id": { "location": "uri" } } }, "getCustomerUnusedCredits": { "httpMethod": "GET", "uri": "customers/{customer_id}/unusedcredits", "responseModel": "getResponse", "parameters": { "customer_id": { "location": "uri" } } }, "deactivateCustomers": { "httpMethod": "POST", "uri": "customers/markasinactive?customer_ids={customer_ids}", "responseModel": "getResponse", "parameters": { "customer_ids": { "location": "uri" } } }, "addCustomer": { "httpMethod": "POST", "uri": "customers", "responseModel": "getResponse", "parameters": { "display_name": { "location": "json" }, "salutation": { "location": "json" }, "first_name": { "location": "json" }, "last_name": { "location": "json" }, "email": { "location": "json" }, "company_name": { "location": "json" }, "phone": { "location": "json" }, "mobile": { "location": "json" }, "website": { "location": "json" }, "twitter": { "location": "json" }, "facebook": { "location": "json" }, "billing_address": { "location": "json" }, "shipping_address": { "location": "json" }, "currency_code": { "location": "json" }, "notes": { "location": "json" }, "payment_terms": { "location": "json" }, "payment_terms_label": { "location": "json" }, "ach_supported": { "location": "json" }, "custom_fields": { "location": "json" }, "default_templates": { "location": "json" } } }, "deleteCustomers": { "httpMethod": "DELETE", "uri": "customers?customer_ids={customer_ids}", "responseModel": "getResponse", "parameters": { "customer_ids": { "location": "uri" } } }, "deactivateCustomer": { "httpMethod": "POST", "uri": "customers/{customer_id}/markasinactive", "responseModel": "getResponse", "parameters": { "customer_id": { "location": "uri" } } }, "enableCustomerPaymentReminder": { "httpMethod": "POST", "uri": "customers/{customer_id}/paymentreminder/enable", "responseModel": "getResponse", "parameters": { "customer_id": { "location": "uri" } } }, "deleteCustomerAddress": { "httpMethod": "DELETE", "uri": "customers/{customer_id}/address/{address_id}", "responseModel": "getResponse", "parameters": { "customer_id": { "location": "uri" }, "address_id": { "location": "uri" } } }, "deleteCustomerPaypalAccount": { "httpMethod": "DELETE", "uri": "customers/{customer_id}/paypalaccounts/{paypal_id}", "responseModel": "getResponse", "parameters": { "customer_id": { "location": "uri" }, "paypal_id": { "location": "uri" } } }, "deleteProduct": { "httpMethod": "DELETE", "uri": "products/{product_id}", "responseModel": "getResponse", "parameters": { "product_id": { "location": "uri" } } }, "updateProduct": { "httpMethod": "PUT", "uri": "products/{product_id}", "responseModel": "getResponse", "parameters": { "product_id": { "location": "uri" }, "name": { "location": "json" }, "description": { "location": "json" }, "email_ids": { "location": "json" }, "redirect_url": { "location": "json" } } }, "addProduct": { "httpMethod": "POST", "uri": "products", "responseModel": "getResponse", "parameters": { "name": { "location": "json" }, "description": { "location": "json" }, "email_ids": { "location": "json" }, "redirect_url": { "location": "json" } } }, "getProduct": { "httpMethod": "GET", "uri": "products/{product_id}?showchild={showchild}", "responseModel": "getResponse", "parameters": { "product_id": { "location": "uri" }, "showchild": { "location": "uri", "default": "true" } } }, "activateProduct": { "httpMethod": "POST", "uri": "products/{product_id}/markasactive", "responseModel": "getResponse", "parameters": { "product_id": { "location": "uri" } } }, "getProducts": { "httpMethod": "GET", "uri": "products?filter_by={filter_by}", "responseModel": "getResponse", "parameters": { "filter_by": { "location": "uri", "default": "ProductStatus.All" } } }, "deactivateProduct": { "httpMethod": "POST", "uri": "products/{product_id}/markasinactive", "responseModel": "getResponse", "parameters": { "product_id": { "location": "uri" } } }, "deleteSalesPerson": { "httpMethod": "DELETE", "uri": "salespersons/{salesperson_id}", "responseModel": "getResponse", "parameters": { "salesperson_id": { "location": "uri" } } }, "deleteSalesPersons": { "httpMethod": "DELETE", "uri": "salespersons?salesperson_ids={salesperson_ids}", "responseModel": "getResponse", "parameters": { "salesperson_ids": { "location": "uri" } } }, "getSalesPersons": { "httpMethod": "GET", "uri": "salespersons", "responseModel": "getResponse", "parameters": [] }, "deleteCreditnoteRefund": { "httpMethod": "DELETE", "uri": "creditnotes/{creditnote_id}/refunds/{refund_id}", "responseModel": "getResponse", "parameters": { "creditnote_id": { "location": "uri" }, "refund_id": { "location": "uri" } } }, "deleteCreditnote": { "httpMethod": "DELETE", "uri": "creditnotes/{creditnote_id}", "responseModel": "getResponse", "parameters": { "creditnote_id": { "location": "uri" } } }, "deleteCreditnoteComment": { "httpMethod": "DELETE", "uri": "creditnotes/{creditnote_id}/comments/{comment_id}", "responseModel": "getResponse", "parameters": { "creditnote_id": { "location": "uri" }, "comment_id": { "location": "uri" } } }, "getRefundCreditnote": { "httpMethod": "GET", "uri": "creditnotes/refunds/{refund_id}", "responseModel": "getResponse", "parameters": { "refund_id": { "location": "uri" } } }, "addCreditnoteRefunds": { "httpMethod": "POST", "uri": "creditnotes/{creditnote_id}/refunds", "responseModel": "getResponse", "parameters": { "creditnote_id": { "location": "uri" }, "amount": { "location": "json" }, "description": { "location": "json" } } }, "deleteCreditnoteInvoice": { "httpMethod": "DELETE", "uri": "creditnotes/{creditnote_id}/invoices/{creditnote_invoice_id}", "responseModel": "getResponse", "parameters": { "creditnote_id": { "location": "uri" }, "creditnote_invoice_id": { "location": "uri" } } }, "addCreditnoteInvoices": { "httpMethod": "POST", "uri": "creditnotes/{creditnote_id}/invoices", "responseModel": "getResponse", "parameters": { "creditnote_id": { "location": "uri" }, "invoices": { "location": "json" } } }, "addInvoiceEmail": { "httpMethod": "POST", "uri": "invoices/{creditnote_id}/email", "responseModel": "getResponse", "parameters": { "creditnote_id": { "location": "uri" }, "to_mail_ids": { "location": "json" }, "cc_mail_ids": { "location": "json" }, "subject": { "location": "json" }, "body": { "location": "json" } } }, "openVoidCreditnote": { "httpMethod": "POST", "uri": "creditnotes/{creditnote_id}/converttoopen", "responseModel": "getResponse", "parameters": { "creditnote_id": { "location": "uri" } } }, "voidCreditnote": { "httpMethod": "POST", "uri": "creditnotes/{creditnote_id}/void", "responseModel": "getResponse", "parameters": { "creditnote_id": { "location": "uri" } } }, "getCreditnote": { "httpMethod": "GET", "uri": "creditnotes/{creditnotes_id}", "responseModel": "getResponse", "parameters": { "creditnotes_id": { "location": "uri" } } }, "addCreditnoteCustomFields": { "httpMethod": "POST", "uri": "creditnotes/{creditnote_id}/customfields", "responseModel": "getResponse", "parameters": { "creditnote_id": { "location": "uri" }, "custom_fields": { "location": "json" } } }, "addCreditnote": { "httpMethod": "POST", "uri": "creditnotes", "responseModel": "getResponse", "parameters": { "customer_id": { "location": "json" }, "contact_persons": { "location": "json" }, "creditnote_number": { "location": "json" }, "ignore_auto_number_generation": { "location": "json" }, "reference_number": { "location": "json" }, "date": { "location": "json" }, "exchange_rate": { "location": "json" }, "creditnote_items": { "location": "json" }, "custom_fields": { "location": "json" }, "notes": { "location": "json" }, "terms": { "location": "json" }, "template_id": { "location": "json" } } }, "deleteCreditnotes": { "httpMethod": "DELETE", "uri": "creditnotes?creditnote_ids={creditnote_ids}", "responseModel": "getResponse", "parameters": { "creditnote_ids": { "location": "uri" } } }, "getProductPlans": { "httpMethod": "GET", "uri": "plans?product_id={product_id}&filter_by={filter_by}", "responseModel": "getResponse", "parameters": { "product_id": { "location": "uri" }, "filter_by": { "location": "uri", "default": "PlanStatus.All" } } }, "updatePlan": { "httpMethod": "PUT", "uri": "plans/{plan_code}", "responseModel": "getResponse", "parameters": { "plan_code": { "location": "json" }, "name": { "location": "json" }, "recurring_price": { "location": "json" }, "interval": { "location": "json" }, "interval_unit": { "location": "json" }, "billing_cycles": { "location": "json" }, "trial_period": { "location": "json" }, "setup_fee": { "location": "json" }, "addons": { "location": "json" }, "product_id": { "location": "json" }, "account_id": { "location": "json" }, "tax_id": { "location": "json" }, "description": { "location": "json" } } }, "addPlan": { "httpMethod": "POST", "uri": "plans", "responseModel": "getResponse", "parameters": { "name": { "location": "json" }, "plan_code": { "location": "json" }, "product_id": { "location": "json" }, "description": { "location": "json" }, "interval": { "location": "json" }, "interval_unit": { "location": "json" }, "billing_cycles": { "location": "json" }, "setup_price": { "location": "json" }, "trial_period": { "location": "json" }, "recurring_price": { "location": "json" }, "account_id": { "location": "json" }, "tax_id": { "location": "json" } } }, "deactivatePlan": { "httpMethod": "POST", "uri": "plans/{plan_code}/markasinactive", "responseModel": "getResponse", "parameters": { "plan_code": { "location": "uri" } } }, "activatePlan": { "httpMethod": "POST", "uri": "plans/{plan_code}/markasactive", "responseModel": "getResponse", "parameters": { "plan_code": { "location": "uri" } } }, "getPlan": { "httpMethod": "GET", "uri": "plans/{plan_code}", "responseModel": "getResponse", "parameters": { "plan_code": { "location": "uri" } } }, "deletePlan": { "httpMethod": "DELETE", "uri": "plans/{plan_code}", "responseModel": "getResponse", "parameters": { "plan_code": { "location": "uri" } } }, "getPlans": { "httpMethod": "GET", "uri": "plans?filter_by={filter_by}", "responseModel": "getResponse", "parameters": { "filter_by": { "location": "uri", "default": "PlanStatus.All" } } }, "createSubscription": { "httpMethod": "POST", "uri": "subscriptions", "responseModel": "getResponse", "additionalParameters": { "location": "json" } }, "addSubscriptionNotes": { "httpMethod": "POST", "uri": "subscriptions/{subscription_id}/notes", "responseModel": "getResponse", "parameters": { "subscription_id": { "location": "uri" }, "description": { "location": "json" } } }, "reactivateSubscription": { "httpMethod": "POST", "uri": "subscriptions/{subscription_id}/reactivate", "responseModel": "getResponse", "parameters": { "subscription_id": { "location": "uri" } } }, "deleteSubscriptionNote": { "httpMethod": "DELETE", "uri": "subscriptions/{subscription_id}/notes/{note_id}", "responseModel": "getResponse", "parameters": { "subscription_id": { "location": "uri" }, "note_id": { "location": "uri" } } }, "addSubscription": { "httpMethod": "POST", "uri": "subscriptions", "responseModel": "getResponse", "parameters": { "customer_id": { "location": "json" }, "plan": { "location": "json" }, "addons": { "location": "json" }, "coupon_code": { "location": "json" }, "payment_terms": { "location": "json" }, "payment_terms_label": { "location": "json" }, "starts_at": { "location": "json" }, "exchange_rate": { "location": "json" }, "salesperson_name": { "location": "json" }, "reference_id": { "location": "json" }, "custom_fields": { "location": "json" }, "auto_collect": { "location": "json" }, "card": { "location": "json" }, "payment_gateways": { "location": "json" } } }, "cancelSubscriptions": { "httpMethod": "POST", "uri": "subscriptions/bulkcancel?subscription_ids={subscription_ids}", "responseModel": "getResponse", "parameters": { "subscription_ids": { "location": "uri" } } }, "addSubscriptionLineItem": { "httpMethod": "POST", "uri": "subscriptions/{subscription_id}/lineitems/{plan_code}", "responseModel": "getResponse", "parameters": { "subscription_id": { "location": "uri" }, "plan_code": { "location": "uri" }, "description": { "location": "json" } } }, "deleteSubscriptionCard": { "httpMethod": "DELETE", "uri": "subscriptions/{subscription_id}/card", "responseModel": "getResponse", "parameters": { "subscription_id": { "location": "uri" } } }, "updateSubscription": { "httpMethod": "PUT", "uri": "subscriptions/{subscription_id}", "responseModel": "getResponse", "parameters": { "subscription_id": { "location": "uri" } } }, "addSubscriptionBankAccount": { "httpMethod": "POST", "uri": "subscriptions/{subscription_id}/bankaccount", "responseModel": "getResponse", "parameters": { "subscription_id": { "location": "uri" }, "auto_collect": { "location": "json" }, "account_id": { "location": "json" } } }, "getSubscriptions": { "httpMethod": "GET", "uri": "subscriptions?filter_by={filter_by}&customer_id={customer_id}", "responseModel": "getResponse", "parameters": { "filter_by": { "location": "uri", "default": "SubscriptionStatus.All" }, "customer_id": { "location": "uri" } } }, "setSubscriptionOnline": { "httpMethod": "POST", "uri": "subscriptions/{subscription_id}/autocollect", "responseModel": "getResponse", "parameters": { "subscription_id": { "location": "uri" }, "auto_collect": { "location": "json", "default": "true" } } }, "getSubscription": { "httpMethod": "GET", "uri": "subscriptions/{subscription_id}", "responseModel": "getResponse", "parameters": { "subscription_id": { "location": "uri" } } }, "addSubscriptionOnetimeAddon": { "httpMethod": "POST", "uri": "subscriptions/{subscription_id}/buyonetimeaddon", "responseModel": "getResponse", "parameters": { "subscription_id": { "location": "uri" }, "addons": { "location": "json" }, "exchange_rate": { "location": "json" }, "coupon_code": { "location": "json" } } }, "addOfflineSubscription": { "httpMethod": "POST", "uri": "subscriptions", "responseModel": "getResponse", "parameters": { "customer_id": { "location": "json" }, "plan": { "location": "json" }, "addons": { "location": "json" }, "coupon_code": { "location": "json" }, "starts_at": { "location": "json" }, "exchange_rate": { "location": "json" }, "payment_terms": { "location": "json" }, "payment_terms_label": { "location": "json" }, "salesperson_name": { "location": "json" }, "reference_id": { "location": "json" }, "custom_fields": { "location": "json" }, "auto_collect": { "location": "json", "default": "false" }, "payment_gateways": { "location": "json" } } }, "addSubscriptionCoupon": { "httpMethod": "POST", "uri": "subscriptions/{subscription_id}/coupons/{coupon_code}", "responseModel": "getResponse", "parameters": { "subscription_id": { "location": "uri" }, "coupon_code": { "location": "uri" } } }, "deleteSubscription": { "httpMethod": "DELETE", "uri": "subscriptions/{subscription_id}", "responseModel": "getResponse", "parameters": { "subscription_id": { "location": "uri" } } }, "getSubscriptionScheduledChanges": { "httpMethod": "GET", "uri": "subscriptions/{subscription_id}/scheduledchanges", "responseModel": "getResponse", "parameters": { "subscription_id": { "location": "uri" } } }, "addSubscriptionCard": { "httpMethod": "POST", "uri": "subscriptions/{subscription_id}/card", "responseModel": "getResponse", "parameters": { "subscription_id": { "location": "uri" }, "card_id": { "location": "json" }, "auto_collect": { "location": "json" } } }, "getSubscriptionRecentActivities": { "httpMethod": "GET", "uri": "subscriptions/{subscription_id}/recentactivities", "responseModel": "getResponse", "parameters": { "subscription_id": { "location": "uri" } } }, "getSubscriptionNotes": { "httpMethod": "GET", "uri": "subscriptions/{subscription_id}/notes", "responseModel": "getResponse", "parameters": { "subscription_id": { "location": "uri" } } }, "deleteSubscriptionScheduledChanges": { "httpMethod": "DELETE", "uri": "subscriptions/{subscription_id}/scheduledchanges", "responseModel": "getResponse", "parameters": { "subscription_id": { "location": "uri" } } }, "addSubscriptionCustomFields": { "httpMethod": "POST", "uri": "subscriptions/{subscription_id}/customfields", "responseModel": "getResponse", "parameters": { "subscription_id": { "location": "uri" }, "custom_fields": { "location": "json" } } }, "addSubscriptionNewBankAccount": { "httpMethod": "POST", "uri": "subscriptions/{subscription_id}/bankaccount", "responseModel": "getResponse", "parameters": { "subscription_id": { "location": "uri" }, "bank_account": { "location": "json" }, "auto_collect": { "location": "json" } } }, "addSubscriptionsCompute": { "httpMethod": "POST", "uri": "subscriptions/compute", "responseModel": "getResponse", "parameters": { "subscription_id": { "location": "json" }, "plan": { "location": "json" }, "addons": { "location": "json" }, "coupon_code": { "location": "json" }, "starts_at": { "location": "json" }, "exchange_rate": { "location": "json" }, "payment_terms": { "location": "json" }, "payment_terms_label": { "location": "json" }, "salesperson_name": { "location": "json" }, "reference_id": { "location": "json" }, "custom_fields": { "location": "json" }, "auto_collect": { "location": "json" }, "payment_gateways": { "location": "json" } } }, "setSubscriptionOffline": { "httpMethod": "POST", "uri": "subscriptions/{subscription_id}/autocollect", "responseModel": "getResponse", "parameters": { "subscription_id": { "location": "uri" }, "auto_collect": { "location": "json", "default": "false" } } }, "updateSubscriptionCard": { "httpMethod": "POST", "uri": "subscriptions/{subscription_id}/card", "responseModel": "getResponse", "parameters": { "subscription_id": { "location": "uri" }, "card": { "location": "json" }, "auto_collect": { "location": "json" } } }, "addSubscriptionOnetimeCharge": { "httpMethod": "POST", "uri": "subscriptions/{subscription_id}/charge", "responseModel": "getResponse", "parameters": { "subscription_id": { "location": "uri" }, "amount": { "location": "json" }, "description": { "location": "json" } } }, "addNewCustomerSubscription": { "httpMethod": "POST", "uri": "subscriptions", "responseModel": "getResponse", "parameters": { "customer": { "location": "json" }, "card": { "location": "json" }, "starts_at": { "location": "json" }, "exchange_rate": { "location": "json" }, "plan": { "location": "json" }, "addons": { "location": "json" }, "custom_fields": { "location": "json" }, "payment_terms": { "location": "json" }, "payment_terms_label": { "location": "json" }, "coupon_code": { "location": "json" }, "auto_collect": { "location": "json" }, "salesperson_name": { "location": "json" }, "reference_id": { "location": "json" }, "payment_gateways": { "location": "json" } } }, "cancelSubscriptionNow": { "httpMethod": "POST", "uri": "subscriptions/{subscription_id}/cancel?cancel_at_end={cancel_at_end}", "responseModel": "getResponse", "parameters": { "subscription_id": { "location": "uri" }, "cancel_at_end": { "location": "uri", "default": "false" } } }, "addSubscriptionPaypalAccount": { "httpMethod": "POST", "uri": "subscriptions/{subscription_id}/paypalaccount", "responseModel": "getResponse", "parameters": { "subscription_id": { "location": "uri" }, "paypal_id": { "location": "json" } } }, "postponeSubscription": { "httpMethod": "POST", "uri": "subscriptions/{subscription_id}/postpone", "responseModel": "getResponse", "parameters": { "subscription_id": { "location": "uri" }, "renewal_at": { "location": "json" } } }, "deleteSubscriptionBankAccount": { "httpMethod": "DELETE", "uri": "subscriptions/{subscription_id}/bankaccount", "responseModel": "getResponse", "parameters": { "subscription_id": { "location": "uri" } } }, "addSubscriptionContactPersons": { "httpMethod": "POST", "uri": "subscriptions/{subscription_id}/contactpersons", "responseModel": "getResponse", "parameters": { "subscription_id": { "location": "uri" }, "contactpersons": { "location": "json" } } }, "addSubscriptionReference": { "httpMethod": "POST", "uri": "subscriptions/{subscription_id}/reference", "responseModel": "getResponse", "parameters": { "subscription_id": { "location": "uri" }, "reference_id": { "location": "json" } } }, "getCustomersSubscriptions": { "httpMethod": "GET", "uri": "subscriptions?filter_by={filter_by}&customer_id={customer_id}", "responseModel": "getResponse", "parameters": { "filter_by": { "location": "uri", "default": "SubscriptionStatus.All" }, "customer_id": { "location": "uri" } } }, "addSubscriptionAddonLineItem": { "httpMethod": "POST", "uri": "subscriptions/{subscription_id}/lineitems/{addon_code}", "responseModel": "getResponse", "parameters": { "subscription_id": { "location": "uri" }, "addon_code": { "location": "uri" }, "description": { "location": "json" } } }, "deleteSubscriptionCoupons": { "httpMethod": "DELETE", "uri": "subscriptions/{subscription_id}/coupons", "responseModel": "getResponse", "parameters": { "subscription_id": { "location": "uri" } } }, "cancelSubscription": { "httpMethod": "POST", "uri": "subscriptions/{subscription_id}/cancel?cancel_at_end={cancel_at_end}", "responseModel": "getResponse", "parameters": { "subscription_id": { "location": "uri" }, "cancel_at_end": { "location": "uri", "default": "true" } } }, "addSubscriptionSalesPerson": { "httpMethod": "POST", "uri": "subscriptions/{subscription_id}/salesperson", "responseModel": "getResponse", "parameters": { "subscription_id": { "location": "uri" }, "salesperson_name": { "location": "json" } } }, "getCustomerCard": { "httpMethod": "GET", "uri": "customers/{customer_id}/cards/{card_id}", "responseModel": "getResponse", "parameters": { "customer_id": { "location": "uri" }, "card_id": { "location": "uri" } } }, "deleteCustomerCard": { "httpMethod": "DELETE", "uri": "customers/{customer_id}/cards/{card_id}", "responseModel": "getResponse", "parameters": { "customer_id": { "location": "uri" }, "card_id": { "location": "uri" } } }, "addCustomerCards": { "httpMethod": "POST", "uri": "customers/{customer_id}/cards", "responseModel": "getResponse", "parameters": { "customer_id": { "location": "uri" }, "card_number": { "location": "json" }, "expiry_month": { "location": "json" }, "expiry_year": { "location": "json" }, "cvv_number": { "location": "json" }, "first_name": { "location": "json" }, "last_name": { "location": "json" }, "street": { "location": "json" }, "city": { "location": "json" }, "state": { "location": "json" }, "country": { "location": "json" }, "zip": { "location": "json" }, "payment_gateway": { "location": "json" } } }, "getCustomerCards": { "httpMethod": "GET", "uri": "customers/{customer_id}/cards", "responseModel": "getResponse", "parameters": { "customer_id": { "location": "uri" } } }, "updateCustomerCard": { "httpMethod": "PUT", "uri": "customers/{customer_id}/cards/{card_id}", "responseModel": "getResponse", "parameters": { "customer_id": { "location": "uri" }, "card_id": { "location": "uri" }, "card_number": { "location": "json" }, "expiry_month": { "location": "json" }, "expiry_year": { "location": "json" }, "cvv_number": { "location": "json" }, "first_name": { "location": "json" }, "last_name": { "location": "json" }, "street": { "location": "json" }, "city": { "location": "json" }, "state": { "location": "json" }, "country": { "location": "json" }, "zip": { "location": "json" }, "payment_gateway": { "location": "json" } } }, "activateCoupon": { "httpMethod": "POST", "uri": "coupons/{coupon_code}/markasactive", "responseModel": "getResponse", "parameters": { "coupon_code": { "location": "uri" } } }, "deleteCoupon": { "httpMethod": "DELETE", "uri": "coupons/{coupon_code}", "responseModel": "getResponse", "parameters": { "coupon_code": { "location": "uri" } } }, "updateCoupon": { "httpMethod": "PUT", "uri": "coupons/{coupon_code}", "responseModel": "getResponse", "parameters": { "coupon_code": { "location": "uri" }, "name": { "location": "json" }, "description": { "location": "json" }, "max_redemption": { "location": "json" }, "expiry_at": { "location": "json" } } }, "deactivateCoupon": { "httpMethod": "POST", "uri": "coupons/{coupon_code}/markasinactive", "responseModel": "getResponse", "parameters": { "coupon_code": { "location": "uri" } } }, "addCoupon": { "httpMethod": "POST", "uri": "coupons", "responseModel": "getResponse", "parameters": { "coupon_code": { "location": "json" }, "name": { "location": "json" }, "description": { "location": "json" }, "type": { "location": "json" }, "discount_by": { "location": "json" }, "discount_value": { "location": "json" }, "product_id": { "location": "json" }, "max_redemption": { "location": "json" }, "expiry_at": { "location": "json" }, "apply_to_plans": { "location": "json" }, "plans": { "location": "json" }, "apply_to_addons": { "location": "json" }, "addons": { "location": "json" } } }, "getCoupons": { "httpMethod": "GET", "uri": "coupons?filter_by={filter_by}&product_id={product_id}", "responseModel": "getResponse", "parameters": { "filter_by": { "location": "uri", "default": "CouponStatus.All" }, "product_id": { "location": "uri" } } }, "getCoupon": { "httpMethod": "GET", "uri": "coupons/{coupon_code}", "responseModel": "getResponse", "parameters": { "coupon_code": { "location": "uri" } } }, "get": { "httpMethod": "GET", "uri": "", "responseModel": "getResponse", "parameters": [] }, "getEvent": { "httpMethod": "GET", "uri": "events/{event_id}", "responseModel": "getResponse", "parameters": { "event_id": { "location": "uri" } } }, "getEvents": { "httpMethod": "GET", "uri": "events?filter_by={filter_by}", "responseModel": "getResponse", "parameters": { "filter_by": { "location": "uri", "default": "EventTime.All" } } }, "addPayment": { "httpMethod": "POST", "uri": "payments", "responseModel": "getResponse", "parameters": { "customer_id": { "location": "json" }, "amount": { "location": "json" }, "date": { "location": "json" }, "payment_mode": { "location": "json" }, "description": { "location": "json" }, "reference_number": { "location": "json" }, "invoices": { "location": "json" }, "exchange_rate": { "location": "json" }, "bank_charges": { "location": "json" }, "tax_account_id": { "location": "json" }, "account_id": { "location": "json" }, "custom_fields": { "location": "json" } } }, "getPayment": { "httpMethod": "GET", "uri": "payments/{payment_id}", "responseModel": "getResponse", "parameters": { "payment_id": { "location": "uri" } } }, "addPaymentRefunds": { "httpMethod": "POST", "uri": "payments/{payment_id}/refunds", "responseModel": "getResponse", "parameters": { "payment_id": { "location": "uri" }, "amount": { "location": "json" }, "description": { "location": "json" } } }, "deletePayment": { "httpMethod": "DELETE", "uri": "payments/{payment_id}", "responseModel": "getResponse", "parameters": { "payment_id": { "location": "uri" } } }, "addProductCustomFields": { "httpMethod": "POST", "uri": "products/{product_id}/customfields", "responseModel": "getResponse", "parameters": { "product_id": { "location": "uri" }, "custom_fields": { "location": "json" } } }, "updatePayment": { "httpMethod": "PUT", "uri": "payments/{payment_id}", "responseModel": "getResponse", "parameters": { "payment_id": { "location": "uri" }, "customer_id": { "location": "json" }, "amount": { "location": "json" }, "date": { "location": "json" }, "payment_mode": { "location": "json" }, "description": { "location": "json" }, "reference_number": { "location": "json" }, "invoices": { "location": "json" }, "exchange_rate": { "location": "json" }, "bank_charges": { "location": "json" }, "tax_account_id": { "location": "json" }, "account_id": { "location": "json" }, "custom_fields": { "location": "json" } } }, "getWebhook": { "httpMethod": "GET", "uri": "webhooks/{webhook_id}", "responseModel": "getResponse", "parameters": { "webhook_id": { "location": "uri" } } }, "getWebhooks": { "httpMethod": "GET", "uri": "webhooks", "responseModel": "getResponse", "parameters": [] }, "updateCustomerContactPerson": { "httpMethod": "PUT", "uri": "customers/{customer_id}/contactpersons/{contactperson_id}", "responseModel": "getResponse", "parameters": { "customer_id": { "location": "uri" }, "contactperson_id": { "location": "uri" }, "salutation": { "location": "json" }, "first_name": { "location": "json" }, "last_name": { "location": "json" }, "email": { "location": "json" }, "phone": { "location": "json" }, "mobile": { "location": "json" }, "fax": { "location": "json" }, "twitter": { "location": "json" }, "designation": { "location": "json" }, "department": { "location": "json" } } }, "addCustomerContactPersons": { "httpMethod": "POST", "uri": "customers/{customer_id}/contactpersons", "responseModel": "getResponse", "parameters": { "customer_id": { "location": "uri" }, "salutation": { "location": "json" }, "first_name": { "location": "json" }, "last_name": { "location": "json" }, "email": { "location": "json" }, "phone": { "location": "json" }, "mobile": { "location": "json" }, "fax": { "location": "json" }, "twitter": { "location": "json" }, "designation": { "location": "json" }, "department": { "location": "json" } } }, "getCustomerContactPersons": { "httpMethod": "GET", "uri": "customers/{customer_id}/contactpersons", "responseModel": "getResponse", "parameters": { "customer_id": { "location": "uri" } } }, "addCustomerPrimaryContactPerson": { "httpMethod": "POST", "uri": "customers/{customer_id}/contactpersons/{contactperson_id}/primary", "responseModel": "getResponse", "parameters": { "customer_id": { "location": "uri" }, "contactperson_id": { "location": "uri" }, "salutation": { "location": "json" }, "first_name": { "location": "json" }, "last_name": { "location": "json" }, "email": { "location": "json" }, "phone": { "location": "json" }, "mobile": { "location": "json" }, "fax": { "location": "json" }, "twitter": { "location": "json" }, "facebook": { "location": "json" } } }, "deleteCustomerContactPerson": { "httpMethod": "DELETE", "uri": "customers/{customer_id}/contactpersons/{contactperson_id}", "responseModel": "getResponse", "parameters": { "customer_id": { "location": "uri" }, "contactperson_id": { "location": "uri" } } }, "getCustomerContactPerson": { "httpMethod": "GET", "uri": "customers/{customer_id}/contactpersons/{contactperson_id}", "responseModel": "getResponse", "parameters": { "customer_id": { "location": "uri" }, "contactperson_id": { "location": "uri" } } }, "deleteCustomerBankAccount": { "httpMethod": "DELETE", "uri": "customers/{customer_id}/bankaccounts/{account_id}", "responseModel": "getResponse", "parameters": { "customer_id": { "location": "uri" }, "account_id": { "location": "uri" } } }, "updateCustomerBankAccount": { "httpMethod": "PUT", "uri": "customers/{customer_id}/bankaccounts/{account_id}", "responseModel": "getResponse", "parameters": { "customer_id": { "location": "uri" }, "account_id": { "location": "uri" }, "account_number": { "location": "json" }, "routing_number": { "location": "json" }, "account_type": { "location": "json" }, "bank_name": { "location": "json" }, "first_name": { "location": "json" }, "last_name": { "location": "json" }, "accept_license": { "location": "json" }, "authorization_type": { "location": "json" }, "payment_gateway": { "location": "json" } } }, "addCustomerBankAccounts": { "httpMethod": "POST", "uri": "customers/{customer_id}/bankaccounts", "responseModel": "getResponse", "parameters": { "customer_id": { "location": "uri" }, "account_number": { "location": "json" }, "account_type": { "location": "json" }, "routing_number": { "location": "json" }, "bank_name": { "location": "json" }, "first_name": { "location": "json" }, "last_name": { "location": "json" }, "accept_license": { "location": "json" }, "authorization_type": { "location": "json" }, "payment_gateway": { "location": "json" } } }, "getCustomerBankAccount": { "httpMethod": "GET", "uri": "customers/{customer_id}/bankaccounts/{account_id}", "responseModel": "getResponse", "parameters": { "customer_id": { "location": "uri" }, "account_id": { "location": "uri" } } }, "activateAddon": { "httpMethod": "POST", "uri": "addons/{addon_code}/markasactive", "responseModel": "getResponse", "parameters": { "addon_code": { "location": "uri" } } }, "addAddon": { "httpMethod": "POST", "uri": "addons", "responseModel": "getResponse", "parameters": { "name": { "location": "json" }, "addon_code": { "location": "json" }, "description": { "location": "json" }, "applicable_to_all_plans": { "location": "json" }, "plans": { "location": "json" }, "type": { "location": "json" }, "unit_name": { "location": "json" }, "pricing_scheme": { "location": "json", "default": "package" }, "price_brackets": { "location": "json" }, "interval_unit": { "location": "json" }, "product_id": { "location": "json" }, "account_id": { "location": "json" }, "tax_id": { "location": "json" } } }, "getAddon": { "httpMethod": "GET", "uri": "addons/{addon_code}", "responseModel": "getResponse", "parameters": { "addon_code": { "location": "uri" } } }, "getAddons": { "httpMethod": "GET", "uri": "addons?filter_by={filter_by}&product_id={product_id}&plan_code={plan_code}", "responseModel": "getResponse", "parameters": { "filter_by": { "location": "uri", "default": "AddonStatus.All" }, "product_id": { "location": "uri" }, "plan_code": { "location": "uri" } } }, "getProductAddons": { "httpMethod": "GET", "uri": "addons?product_id={product_id}&filter_by={filter_by}&plan_code={plan_code}", "responseModel": "getResponse", "parameters": { "product_id": { "location": "uri" }, "filter_by": { "location": "uri", "default": "AddonStatus.All" }, "plan_code": { "location": "uri" } } }, "addTireAddon": { "httpMethod": "POST", "uri": "addons", "responseModel": "getResponse", "parameters": { "name": { "location": "json" }, "addon_code": { "location": "json" }, "description": { "location": "json" }, "applicable_to_all_plans": { "location": "json" }, "plans": { "location": "json" }, "type": { "location": "json" }, "pricing_scheme": { "location": "json", "default": "tire" }, "unit_name": { "location": "json" }, "price_brackets": { "location": "json" }, "interval_unit": { "location": "json" }, "product_id": { "location": "json" }, "account_id": { "location": "json" }, "tax_id": { "location": "json" } } }, "addUnitAddon": { "httpMethod": "POST", "uri": "addons", "responseModel": "getResponse", "parameters": { "name": { "location": "json" }, "addon_code": { "location": "json" }, "description": { "location": "json" }, "applicable_to_all_plans": { "location": "json" }, "plans": { "location": "json" }, "type": { "location": "json" }, "pricing_scheme": { "location": "json", "default": "unit" }, "unit_name": { "location": "json" }, "price_brackets": { "location": "json" }, "interval_unit": { "location": "json" }, "product_id": { "location": "json" }, "account_id": { "location": "json" }, "tax_id": { "location": "json" } } }, "updateAddon": { "httpMethod": "PUT", "uri": "addons/{addon_code}", "responseModel": "getResponse", "parameters": { "addon_code": { "location": "json" }, "name": { "location": "json" }, "unit_name": { "location": "json" }, "pricing_scheme": { "location": "json" }, "price_brackets": { "location": "json" }, "type": { "location": "json" }, "interval_unit": { "location": "json" }, "applicable_to_all_plans": { "location": "json" }, "plans": { "location": "json" }, "product_id": { "location": "json" }, "account_id": { "location": "json" }, "description": { "location": "json" }, "tax_id": { "location": "json" } } }, "getPlanAddons": { "httpMethod": "GET", "uri": "addons?plan_code={plan_code}&filter_by={filter_by}", "responseModel": "getResponse", "parameters": { "plan_code": { "location": "uri" }, "filter_by": { "location": "uri", "default": "AddonStatus.All" } } }, "addVolumeAddon": { "httpMethod": "POST", "uri": "addons", "responseModel": "getResponse", "parameters": { "name": { "location": "json" }, "addon_code": { "location": "json" }, "description": { "location": "json" }, "applicable_to_all_plans": { "location": "json" }, "plans": { "location": "json" }, "type": { "location": "json" }, "pricing_scheme": { "location": "json", "default": "volume" }, "unit_name": { "location": "json" }, "price_brackets": { "location": "json" }, "interval_unit": { "location": "json" }, "product_id": { "location": "json" }, "account_id": { "location": "json" }, "tax_id": { "location": "json" } } }, "deleteAddon": { "httpMethod": "DELETE", "uri": "addons/{addon_code}", "responseModel": "getResponse", "parameters": { "addon_code": { "location": "uri" } } }, "deactivateAddon": { "httpMethod": "POST", "uri": "addons/{addon_code}/markasinactive", "responseModel": "getResponse", "parameters": { "addon_code": { "location": "uri" } } }, "addInvoiceCollect": { "httpMethod": "POST", "uri": "invoices/{invoice_id}/collect", "responseModel": "getResponse", "parameters": { "invoice_id": { "location": "uri" }, "card_id": { "location": "json" } } }, "updateInvoiceAddress": { "httpMethod": "PUT", "uri": "invoices/{invoice_id}/address", "responseModel": "getResponse", "parameters": { "invoice_id": { "location": "uri" }, "billing_address": { "location": "json" }, "shipping_address": { "location": "json" } } }, "getInvoice": { "httpMethod": "GET", "uri": "invoices/{invoice_id}", "responseModel": "getResponse", "parameters": { "invoice_id": { "location": "uri" } } }, "downloadInvoiceAsPdf": { "httpMethod": "GET", "uri": "invoices/{invoice_id}?accept={accept}", "responseModel": "getResponse", "parameters": { "invoice_id": { "location": "uri" }, "accept": { "location": "uri", "default": "pdf" } } }, "setInvoicesAsSent": { "httpMethod": "POST", "uri": "invoices/sent?invoice_ids={invoice_ids}", "responseModel": "getResponse", "parameters": { "invoice_ids": { "location": "uri" } } }, "getInvoices": { "httpMethod": "GET", "uri": "invoices?filter_by={filter_by}", "responseModel": "getResponse", "parameters": { "filter_by": { "location": "uri", "default": "Status.All" } } }, "addInvoiceSalesPerson": { "httpMethod": "POST", "uri": "invoices/{invoice_id}/salesperson", "responseModel": "getResponse", "parameters": { "invoice_id": { "location": "uri" }, "salesperson_name": { "location": "json" } } }, "addInvoiceComments": { "httpMethod": "POST", "uri": "invoices/{invoice_id}/comments", "responseModel": "getResponse", "parameters": { "invoice_id": { "location": "uri" }, "description": { "location": "json" } } }, "enableInvoicePaymentReminder": { "httpMethod": "POST", "uri": "invoices/{invoice_id}/paymentreminder/enable", "responseModel": "getResponse", "parameters": { "invoice_id": { "location": "uri" } } }, "setInvoiceAsSent": { "httpMethod": "POST", "uri": "invoices/{invoice_id}/sent", "responseModel": "getResponse", "parameters": { "invoice_id": { "location": "uri" } } }, "openInvoice": { "httpMethod": "POST", "uri": "invoices/{invoice_id}/convertoopen", "responseModel": "getResponse", "parameters": { "invoice_id": { "location": "uri" } } }, "getInvoiceRecentActivities": { "httpMethod": "GET", "uri": "invoices/{invoice_id}/recentactivities", "responseModel": "getResponse", "parameters": { "invoice_id": { "location": "uri" } } }, "emailInvoice": { "httpMethod": "POST", "uri": "invoices/{invoice_id}/email", "responseModel": "getResponse", "parameters": { "invoice_id": { "location": "uri" }, "to_mail_ids": { "location": "json" }, "cc_mail_ids": { "location": "json" }, "subject": { "location": "json" }, "body": { "location": "json" } } }, "deleteInvoiceComment": { "httpMethod": "DELETE", "uri": "invoices/{invoice_id}/comments/{comment_id}", "responseModel": "getResponse", "parameters": { "invoice_id": { "location": "uri" }, "comment_id": { "location": "uri" } } }, "addInvoiceCustomFields": { "httpMethod": "POST", "uri": "invoices/{invoice_id}/customfields", "responseModel": "getResponse", "parameters": { "invoice_id": { "location": "uri" }, "custom_fields": { "location": "json" } } }, "disableInvoicePaymentReminder": { "httpMethod": "POST", "uri": "invoices/{invoice_id}/paymentreminder/disable", "responseModel": "getResponse", "parameters": { "invoice_id": { "location": "uri" } } }, "getBankAccountPendingInvoices": { "httpMethod": "GET", "uri": "bankaccounts/{account_id}/pendinginvoices", "responseModel": "getResponse", "parameters": { "account_id": { "location": "uri" } } }, "getInvoiceComments": { "httpMethod": "GET", "uri": "invoices/{invoice_id}/comments", "responseModel": "getResponse", "parameters": { "invoice_id": { "location": "uri" } } }, "writeoffInvoice": { "httpMethod": "POST", "uri": "invoices/{invoice_id}/writeoff", "responseModel": "getResponse", "parameters": { "invoice_id": { "location": "uri" } } }, "cancelInvoiceWriteoff": { "httpMethod": "POST", "uri": "invoices/{invoice_id}/cancelwriteoff", "responseModel": "getResponse", "parameters": { "invoice_id": { "location": "uri" } } }, "deleteInvoiceCreditsApplied": { "httpMethod": "DELETE", "uri": "invoices/{invoice_id}/creditsapplied/{creditnotes_invoice_id}", "responseModel": "getResponse", "parameters": { "invoice_id": { "location": "uri" }, "creditnotes_invoice_id": { "location": "uri" } } }, "deleteInvoice": { "httpMethod": "DELETE", "uri": "invoices/{invoice_id}", "responseModel": "getResponse", "parameters": { "invoice_id": { "location": "uri" } } }, "addBankAccountCharge": { "httpMethod": "POST", "uri": "invoices/{invoice_id}/collect", "responseModel": "getResponse", "parameters": { "invoice_id": { "location": "uri" }, "account_id": { "location": "json" } } }, "setInvoicePaymentDate": { "httpMethod": "POST", "uri": "invoices/{invoice_id}/paymentdate", "responseModel": "getResponse", "parameters": { "invoice_id": { "location": "uri" }, "payment_expected_date": { "location": "json" }, "stop_reminder_until_payment_expected_date": { "location": "json" } } }, "voidInvoice": { "httpMethod": "POST", "uri": "invoices/{invoice_id}/void", "responseModel": "getResponse", "parameters": { "invoice_id": { "location": "uri" } } }, "addInvoiceCredits": { "httpMethod": "POST", "uri": "invoices/{invoice_id}/credits", "responseModel": "getResponse", "parameters": { "invoice_id": { "location": "uri" }, "apply_creditnotes": { "location": "json" } } }, "addInvoiceLineItems": { "httpMethod": "POST", "uri": "invoices/{invoice_id}/lineitems", "responseModel": "getResponse", "parameters": { "invoice_id": { "location": "uri" }, "invoice_items": { "location": "json" } } }, "getPricebooks": { "httpMethod": "GET", "uri": "pricebooks", "responseModel": "getResponse", "parameters": [] }, "deleteOrganization": { "httpMethod": "DELETE", "uri": "organizations/{organization_id}", "responseModel": "getResponse", "parameters": { "organization_id": { "location": "uri" } } }, "getOrganizations": { "httpMethod": "GET", "uri": "organizations", "responseModel": "getResponse", "parameters": [] } }, "models": { "getResponse": { "type": "object", "additionalProperties": { "location": "json" } } } }