Hosted-Pages
Zoho Billing provides a hosted payment page to integrate with your websites. You can securely integrate with Zoho Billing for collecting your customer's sensitive card information through the hosted page. These Hosted Pages will expire within one hour.
Retrieve a hosted page
Details of a specific hosted page. The data
field will be populated with the subscription details in case of successfull subscription via Hostedpage. In case of fresh hosted pages the data
field will be empty.
OAuth Scope : ZohoSubscriptions.hostedpages.READ
List of HostedPages
Retrieve the list of all hosted pages.
OAuth Scope : ZohoSubscriptions.hostedpages.READ
Create a subscription
Create a hosted page for a new subscription. To create a subscription for a new customer, you have to pass the customer object. To create a subscription for a existing customer pass the customer_id of that customer.
OAuth Scope : ZohoSubscriptions.hostedpages.CREATE
Arguments
display_name
, company_name
, first_name
, last_name
, email
, fax
, currency_code
and billing_address
.attention
, street
, city
, state
, zip
, country
and fax
.attention
, street
, city
, state
, zip
, country
and fax
.currency_code
is not specified here, the currency chosen in your Zoho Billing organization will be used for billing. currency_id
and currency_symbol
are set automatically in accordance to the currency_code.eu_vat_registered
. Length should be between 2 and 12 characters. (This node is only available for EU VAT registered customers.)eu_vat_registered
. (This node is only available for EU VAT registered customers.)is_taxable
is true
.Allowed values for
gst_treatment
: business_gst
, business_none
, consumer
, overseas
business_gst
- For a GST Registered business owner. business_none
- For a GST unregistered business owner. consumer
- For a consumer. overseas
- Customer for whom you export your goods/services.contactperson_id
and email
.plan_code
, name
, price
, exclude_setup_fee
, quantity
, exclude_setup_fee
, exclude_trial
, billing_cycles
and trial_days
.exclude_setup_fee
is true
setup_fee_tax_id
must be empty for applying tax Exemption.tax_id
must be empty for applying tax Exemption.billing_cycles
specified at the time of creation of the plan would be the default value. If this needs to be overridden for this particular subscription, a value can be provided here.exclude_trial
is true
addon_code
, name
, price
and quantity
.tax_id
must be empty for applying tax Exemption.Allowed values for
gst_treatment
: business_gst
, business_none
, consumer
, overseas
business_gst
- For a GST Registered business owner. business_none
- For a GST unregistered business owner. consumer
- For a consumer. overseas
- Customer for whom you export your goods/services.acquisition_of_merchandise
, return_discount_bonus
, general_expense
, buildings
, furniture_office_equipment
, transport_equipment
, computer_equipmentdye_molds_tools
, telephone_communication
, satellite_communication
, other_machinery_equipment
, hospital_expense
, medical_expense_disability
, funeral_expense
, donation
, interest_mortage_loans
, contribution_sar
, medical_expense_insurance_pormium
, school_transportation_expense
, deposit_saving_account
, payment_educational_service
, no_tax_effect
, payment
, payroll
.Update a subscription
Create a hosted page for a updating a subscription.
OAuth Scope : ZohoSubscriptions.hostedpages.CREATE
Arguments
plan_code
, name
, price
, exclude_setup_fee
, quantity
, exclude_setup_fee
, exclude_trial
, billing_cycles
and trial_days
.exclude_setup_fee
is true
tax_id
must be empty for applying tax Exemption.billing_cycles
specified at the time of creation of the plan would be the default value. If this needs to be overridden for this particular subscription, a value can be provided here.exclude_trial
is true
addon_code
, name
, price
and quantity
.tax_id
must be empty for applying tax Exemption.Allowed values for
gst_treatment
: business_gst
, business_none
, consumer
, overseas
business_gst
- For a GST Registered business owner. business_none
- For a GST unregistered business owner. consumer
- For a consumer. overseas
- Customer for whom you export your goods/services.acquisition_of_merchandise
, return_discount_bonus
, general_expense
, buildings
, furniture_office_equipment
, transport_equipment
, computer_equipmentdye_molds_tools
, telephone_communication
, satellite_communication
, other_machinery_equipment
, hospital_expense
, medical_expense_disability
, funeral_expense
, donation
, interest_mortage_loans
, contribution_sar
, medical_expense_insurance_pormium
, school_transportation_expense
, deposit_saving_account
, payment_educational_service
, no_tax_effect
, payment
, payroll
.Update card for a subscription
Create hosted page for updating card information for a subscription.
OAuth Scope : ZohoSubscriptions.hostedpages.CREATE
Arguments
Buy one-time addon for a subscription
Create hosted page for buying a one-time addon for a subscription.
OAuth Scope : ZohoSubscriptions.hostedpages.CREATE
Arguments
addon_code
, name
, price
and quantity
.tax_id
must be empty for applying tax Exemption.acquisition_of_merchandise
, return_discount_bonus
, general_expense
, buildings
, furniture_office_equipment
, transport_equipment
, computer_equipmentdye_molds_tools
, telephone_communication
, satellite_communication
, other_machinery_equipment
, hospital_expense
, medical_expense_disability
, funeral_expense
, donation
, interest_mortage_loans
, contribution_sar
, medical_expense_insurance_pormium
, school_transportation_expense
, deposit_saving_account
, payment_educational_service
, no_tax_effect
, payment
, payroll
.Associate a Payment method for a customer
Add payment method for a customer
OAuth Scope : ZohoSubscriptions.hostedpages.CREATE
Arguments
Record a Invoice Payment
Create a Hosted page for recording a Invoice payment for a subscription
OAuth Scope : ZohoSubscriptions.hostedpages.CREATE
Arguments
Update customer payment details
Create a Hosted Payment Page to update customers card, bank account (ACH) or PayPal details
OAuth Scope : ZohoSubscriptions.hostedpages.CREATE