API Version
Product Catalog
Library

Represents a customer. Subscriptions, Card and Billing Address are associated with the customer resource. Customer resource will be created along with subscription via "Create a Subscription" API. The id of the customer will be same as that of associated subscription id if not explicitly set.

The Billing Address is significant especially when EU VAT taxes are involved, for tax calculations will be based on this address. For customers without Billing Address, EU VAT taxes will not be included. Thus ensure to set this properly if you have configured EU VAT Tax.

Note: For the customers who signed up before 1st Mar 2014, Customer's Billing Address and 'vat_number' will be replaced automatically whenever the associated Card gets updated. i.e existing values for Billing Address and 'vat_number' will be cleared and the new values will be set. This behaviour is changed now - The VAT Number should always be passed along Billing Address and not with Card address. Both the addresses have to be dealt separately.

Sample customer [ JSON ]

{ "account_credits": 0, "allow_direct_debit": false, "auto_collection": "on", "billing_address": { "city": "Walnut", "country": "US", "first_name": "John", "last_name": "Doe", "line1": "PO Box 9999", "object": "billing_address", "state": "California", "state_code": "CA", "zip": "91789" }, "card_status": "no_card", "created_at": 1517506683, "email": "john@test.com", "excess_payments": 0, "first_name": "John", "id": "__test__5SK0bLNFRFuByp8Bu", "last_name": "Doe", "object": "customer", "refundable_credits": 0, "taxability": "taxable" }

API Index URL GET

https://{site}.chargebee.com/api/v1/customers

Model Class

id
string, max chars=50
Identifier of the customer.
first_name
optional, string, max chars=150
First name of the customer
last_name
optional, string, max chars=150
Last name of the customer
email
optional, string, max chars=70
Email of the customer. Configured email notifications will be sent to this email.
phone
optional, string, max chars=50
Phone number of the customer
company
optional, string, max chars=250
Company name of the customer.
vat_number
optional, string, max chars=20
The VAT/tax registration number for the customer. For customers with billing_address country as XI (which is United Kingdom - Northern Ireland), the first two characters of the full VAT number can be overridden by setting vat_number_prefix.
auto_collection
enumerated string, default=on
Whether payments needs to be collected automatically for this customer
Possible values are
onWhenever an invoice is created, an automatic attempt to charge the customer's payment method is made.offAutomatic collection of charges will not be made. All payments must be recorded offline.
Show all values[+]
allow_direct_debit
boolean, default=false
Whether the customer can pay via Direct Debit
created_at
timestamp(UTC) in seconds
Timestamp indicating when this customer resource is created.
created_from_ip
optional, string, max chars=50
The IP address of the customer. Used primarily for referral integrations and EU/UK VAT validation.
taxability
optional, enumerated string, default=taxable
Specifies if the customer is liable for tax
Possible values are
taxableComputes tax for the customer based on the site configuration. In some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that’s not available either, the tax is taken as zero.exempt
  • Customer is exempted from tax. When using Chargebee’s native Taxes feature or when using the TaxJar integration, no other action is needed.
  • However, when using our Avalara integration, optionally, specify entity_code or exempt_number attributes if you use Chargebee’s AvaTax for Sales or specify exemption_details attribute if you use Chargebee’s AvaTax for Communications integration. Tax may still be applied by Avalara for certain values of entity_code/exempt_number/exemption_details based on the state/region/province of the taxable address.
Show all values[+]
invoice_notes
optional, string, max chars=2000
A customer-facing note added to all invoices associated with this API resource. This note becomes one among all the notes displayed on the invoice PDF.
account_credits
in cents, min=0
Promotional credits balance of this customer
refundable_credits
in cents, min=0
Refundable credits balance of this customer
excess_payments
in cents, min=0
Total unused payments associated with the customer
meta_data
optional, jsonobject
A set of key-value pairs stored as additional information for the customer. Learn more.
billing_address
Show attributes [+]
optional, billing_address
Billing address for a customer.
optional, list of contact
contacts
payment_method
Show attributes [+]
optional, payment_method
Primary Payment Source of the customer.
id id
string, max chars=50
Identifier of the customer.
first_name first_name
optional, string, max chars=150
First name of the customer
last_name last_name
optional, string, max chars=150
Last name of the customer
email email
optional, string, max chars=70
Email of the customer. Configured email notifications will be sent to this email.
phone phone
optional, string, max chars=50
Phone number of the customer
company company
optional, string, max chars=250
Company name of the customer.
vat_number vat_number
optional, string, max chars=20
The VAT/tax registration number for the customer. For customers with billing_address country as XI (which is United Kingdom - Northern Ireland), the first two characters of the full VAT number can be overridden by setting vat_number_prefix.
auto_collection auto_collection
enumerated string, default=on
Whether payments needs to be collected automatically for this customer
allow_direct_debit allow_direct_debit
boolean, default=false
Whether the customer can pay via Direct Debit
created_at created_at
timestamp(UTC) in seconds
Timestamp indicating when this customer resource is created.
created_from_ip created_from_ip
optional, string, max chars=50
The IP address of the customer. Used primarily for referral integrations and EU/UK VAT validation.
taxability taxability
optional, enumerated string, default=taxable
Specifies if the customer is liable for tax
invoice_notes invoice_notes
optional, string, max chars=2000
A customer-facing note added to all invoices associated with this API resource. This note becomes one among all the notes displayed on the invoice PDF.
account_credits account_credits
in cents, min=0
Promotional credits balance of this customer
refundable_credits refundable_credits
in cents, min=0
Refundable credits balance of this customer
excess_payments excess_payments
in cents, min=0
Total unused payments associated with the customer
meta_data
optional, jsonobject
A set of key-value pairs stored as additional information for the customer. Learn more.
billing_address
optional, billing_address
Billing address for a customer.
contacts
optional, list of contact
contacts
payment_method
optional, payment_method
Primary Payment Source of the customer.
Note: This operation optionally supports 3DS verification flow. To achieve the same, create the Payment Intent and pass it as input parameter to this API.

Creates a customer. You can create a customer and then create subscriptions for the customer when required. When creating a customer, you can pass along the billing address and card details.

Passing credit card details to through the API involves PCI liability at your end as sensitive card information passes through your servers. If you wish to avoid that, you can use one of the following integration methodologies if applicable:

  • If you use Stripe, you can also use Stripe.js with your checkout form, to collect card information.
  • If you are using Braintree gateway, you can use Braintree.js with your checkout form.
  • You can also use our Hosted Pages based integration.

The Billing Address is significant especially when EU VAT taxes are involved, for tax calculations will be based on this address. For customers without a billing address, EU VAT taxes will not be included. Thus ensure to set this properly if you have configured EU VAT Tax.

Billing Address attributes shall be explicitly passed for customers paying offline(Cash, Check, Bank Transfer etc).

Note: When an invoice is generated for a customer, the billing address provided for the customer will be stored with the invoice. If the First Name, Last Name, and Company fields do not contain any information under Billing Info, the same will be picked from Customer Details if the same is available there.

Notes

Sample Request
# creates a customer with billing address.
curl  https://{site}.chargebee.com/api/v1/customers \
     -u {site_api_key}:\
     -d first_name="John" \
     -d last_name="Doe" \
     -d email="john@test.com" \
     -d billing_address[first_name]="John" \
     -d billing_address[last_name]="Doe" \
     -d billing_address[line1]="PO Box 9999" \
     -d billing_address[city]="Walnut" \
     -d billing_address[state]="California" \
     -d billing_address[zip]="91789" \
     -d billing_address[country]="US"
copy
Click to Copy

Sample Response [ JSON ]

Show more...
{
    "customer": {
        "account_credits": 0,
        "allow_direct_debit": false,
        "auto_collection": "on",
        "billing_address": {
            "city": "Walnut",
            "country": "US",
            "first_name": "John",
            "last_name": "Doe",
            "line1": "PO Box 9999",
            "object": "billing_address",
            "state": "California",
            "state_code": "CA",
            "zip": "91789"
        },
        "card_status": "no_card",
        "created_at": 1517506683,
        "email": "john@test.com",
        "excess_payments": 0,
        "first_name": "John",
        "id": "__test__5SK0bLNFRFuByp8Bu",
        "last_name": "Doe",
        "object": "customer",
        "refundable_credits": 0,
        "taxability": "taxable"
    }
}

URL Format POST

https://{site}.chargebee.com/api/v1/customers

Method

id[]
optional, string, max chars=50
Id for the new customer. If not given, this will be auto-generated.
first_name[]
optional, string, max chars=150
First name of the customer.
last_name[]
optional, string, max chars=150
Last name of the customer.
email[]
optional, string, max chars=70
Email of the customer. Configured email notifications will be sent to this email.
phone[]
optional, string, max chars=50
Phone number of the customer.
company[]
optional, string, max chars=250
Company name of the customer.
auto_collection[]
optional, enumerated string, default=on
Whether payments needs to be collected automatically for this customer.
Possible values are
onWhenever an invoice is created, an automatic attempt to charge the customer's payment method is made.offAutomatic collection of charges will not be made. All payments must be recorded offline.
Show all values[+]
allow_direct_debit[]
optional, boolean, default=false
Whether the customer can pay via Direct Debit.
vat_number[]
optional, string, max chars=20
The VAT/tax registration number for the customer. For customers with billing_address country as XI (which is United Kingdom - Northern Ireland), the first two characters of the full VAT number can be overridden by setting vat_number_prefix.
taxability[]
optional, enumerated string, default=taxable
Specifies if the customer is liable for tax.
Possible values are
taxableComputes tax for the customer based on the site configuration. In some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that’s not available either, the tax is taken as zero.exempt
  • Customer is exempted from tax. When using Chargebee’s native Taxes feature or when using the TaxJar integration, no other action is needed.
  • However, when using our Avalara integration, optionally, specify entity_code or exempt_number attributes if you use Chargebee’s AvaTax for Sales or specify exemption_details attribute if you use Chargebee’s AvaTax for Communications integration. Tax may still be applied by Avalara for certain values of entity_code/exempt_number/exemption_details based on the state/region/province of the taxable address.
Show all values[+]
meta_data[]
optional, jsonobject
A set of key-value pairs stored as additional information for the customer. Learn more.
created_from_ip[]
optional, string, max chars=50
The IP address of the customer. Used primarily for referral integrations and EU/UK VAT validation.
invoice_notes[]
optional, string, max chars=2000
A customer-facing note added to all invoices associated with this API resource. This note becomes one among all the notes displayed on the invoice PDF.
card[gateway]
optional, enumerated string
Possible values are
chargebeeChargebee test gateway.stripeStripe is a payment gateway.braintreeBraintree is a payment gateway.authorize_netAuthorize.net is a payment gateway
Show all values[+]
card[tmp_token]
optional, string, max chars=300
card[first_name]
optional, string, max chars=50
card[last_name]
optional, string, max chars=50
card[number]
required if card provided, string, max chars=1500
card[expiry_month]
required if card provided, integer, min=1, max=12
card[expiry_year]
required if card provided, integer
card[cvv]
optional, string, max chars=520
card[billing_addr1]
optional, string, max chars=150
card[billing_addr2]
optional, string, max chars=150
card[billing_city]
optional, string, max chars=50
card[billing_state_code]
optional, string, max chars=50
card[billing_state]
optional, string, max chars=50
card[billing_zip]
optional, string, max chars=20
card[billing_country]
optional, string, max chars=50
card[ip_address]
optional, string, max chars=50
payment_method[type]
optional, enumerated string
Possible values are
cardCard based payment including credit cards and debit cards. Details about the card can be obtained from the card resource.paypal_express_checkoutPayments made via PayPal Express Checkout.amazon_paymentsPayments made via Amazon Payments.direct_debitRepresents bank account for which the direct debit or ACH agreement/mandate is created.
Show all values[+]
payment_method[gateway]
optional, enumerated string
Possible values are
stripeStripe is a payment gateway.braintreeBraintree is a payment gateway.authorize_netAuthorize.net is a payment gatewaypaypal_proPayPal Pro Account is a payment gateway.
Show all values[+]
payment_method[reference_id]
optional, string, max chars=200
payment_intent[id]
optional, string, max chars=150
payment_intent[gateway_account_id]
required if payment intent token provided, string, max chars=50
payment_intent[gw_token]
optional, string, max chars=65k
payment_intent[reference_id]
optional, string, max chars=65k
billing_address[first_name]
optional, string, max chars=150
billing_address[last_name]
optional, string, max chars=150
billing_address[email]
optional, string, max chars=70
billing_address[company]
optional, string, max chars=250
billing_address[phone]
optional, string, max chars=50
billing_address[line1]
optional, string, max chars=150
billing_address[line2]
optional, string, max chars=150
billing_address[line3]
optional, string, max chars=150
billing_address[city]
optional, string, max chars=50
billing_address[state_code]
optional, string, max chars=50
billing_address[state]
optional, string, max chars=50
billing_address[zip]
optional, string, max chars=20
billing_address[country]
optional, string, max chars=50
customer customer
always returned
Resource object representing customer
card card
optional
Resource object representing card

Sample admin console URL

https://{site}.chargebee.com/admin-console/customers/123x
Retrieves a list of customers added to your Chargebee site. The list contains the necessary customer details such as First Name, Last Name and the Customer ID.

Notes

Sample Request
curl  https://{site}.chargebee.com/api/v1/customers \
     -G  \
     -u {site_api_key}:
copy
Click to Copy

Sample Response [ JSON ]

Show more...
{
    "list": [
        {
            "customer": {
                "account_credits": 0,
                "allow_direct_debit": false,
                "auto_collection": "on",
                "card_status": "no_card",
                "created_at": 1517506685,
                "email": "john@test.com",
                "excess_payments": 0,
                "first_name": "John",
                "id": "__test__5SK0bLNFRFuBzHXC8",
                "last_name": "Doe",
                "object": "customer",
                "refundable_credits": 0,
                "taxability": "taxable"
            }
        },
        {..}
    ],
    "next_offset": "[\"1517506680000\",\"154000000144\"]"
}

URL Format GET

https://{site}.chargebee.com/api/v1/customers

Method

limit[]
optional, integer, default=10, min=1, max=100
The number of resources to be returned.
offset[]
optional, string, max chars=1000
Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset to the value of next_offset obtained in the previous iteration of the API call.
customer customer
always returned
Resource object representing customer
card card
optional
Resource object representing card
next_offset next_offset
optional, string, max chars=1000
This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.

Sample admin console URL

https://{site}.chargebee.com/admin-console/customers/123x
Retrieves the details of the desired customer. You can use the unique identifier for a particular customer to retrieve the desired details.

Notes

Sample Request
curl  https://{site}.chargebee.com/api/v1/customers/__test__5SK0bLNFRFuBzQTCQ \
     -u {site_api_key}:
copy
Click to Copy

Sample Response [ JSON ]

Show more...
{
    "customer": {
        "account_credits": 0,
        "allow_direct_debit": false,
        "auto_collection": "on",
        "card_status": "no_card",
        "created_at": 1517506685,
        "excess_payments": 0,
        "first_name": "David",
        "id": "__test__5SK0bLNFRFuBzQTCQ",
        "last_name": "Louis",
        "object": "customer",
        "refundable_credits": 0,
        "taxability": "taxable"
    }
}

URL Format GET

https://{site}.chargebee.com/api/v1/customers/{customer-id}

Method

customer customer
always returned
Resource object representing customer
card card
optional
Resource object representing card

Sample admin console URL

https://{site}.chargebee.com/admin-console/customers/123x

Updates the customer resource. However this method cannot be used for updating the 'Billing Info' - the Billing Address and 'vat_number' attributes - of the customer. To update the same, use our Update Billing Info API.

Notes

Sample Request
curl  https://{site}.chargebee.com/api/v1/customers/__test__5SK0bLNFRFuBzRjCS \
     -u {site_api_key}:\
     -d first_name="Denise" \
     -d last_name="Barone"
copy
Click to Copy

Sample Response [ JSON ]

Show more...
{
    "customer": {
        "account_credits": 0,
        "allow_direct_debit": false,
        "auto_collection": "on",
        "card_status": "no_card",
        "created_at": 1517506685,
        "excess_payments": 0,
        "first_name": "Denise",
        "id": "__test__5SK0bLNFRFuBzRjCS",
        "last_name": "Barone",
        "object": "customer",
        "refundable_credits": 0,
        "taxability": "taxable"
    }
}

URL Format POST

https://{site}.chargebee.com/api/v1/customers/{customer-id}

Method

first_name[]
optional, string, max chars=150
First name of the customer.
last_name[]
optional, string, max chars=150
Last name of the customer.
email[]
optional, string, max chars=70
Email of the customer. Configured email notifications will be sent to this email.
phone[]
optional, string, max chars=50
Phone number of the customer.
company[]
optional, string, max chars=250
Company name of the customer.
auto_collection[]
optional, enumerated string, default=on
Whether payments needs to be collected automatically for this customer.
Possible values are
onWhenever an invoice is created, an automatic attempt to charge the customer's payment method is made.offAutomatic collection of charges will not be made. All payments must be recorded offline.
Show all values[+]
allow_direct_debit[]
optional, boolean, default=false
Whether the customer can pay via Direct Debit.
taxability[]
optional, enumerated string, default=taxable
Specifies if the customer is liable for tax.
Possible values are
taxableComputes tax for the customer based on the site configuration. In some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that’s not available either, the tax is taken as zero.exempt
  • Customer is exempted from tax. When using Chargebee’s native Taxes feature or when using the TaxJar integration, no other action is needed.
  • However, when using our Avalara integration, optionally, specify entity_code or exempt_number attributes if you use Chargebee’s AvaTax for Sales or specify exemption_details attribute if you use Chargebee’s AvaTax for Communications integration. Tax may still be applied by Avalara for certain values of entity_code/exempt_number/exemption_details based on the state/region/province of the taxable address.
Show all values[+]
invoice_notes[]
optional, string, max chars=2000
A customer-facing note added to all invoices associated with this API resource. This note becomes one among all the notes displayed on the invoice PDF.
meta_data[]
optional, jsonobject
A set of key-value pairs stored as additional information for the customer. Learn more.
customer customer
always returned
Resource object representing customer
card card
optional
Resource object representing card

Sample admin console URL

https://{site}.chargebee.com/admin-console/customers/123x

Updates payment method details for a customer.

Note: If you wish to pass the card number, CVV, or the single-use card tokens provided by gateways like Stripe, then use the Update card for a customer API under Cards resource. This API is not supported for Chargebee Test Gateway, which is provided to help you understand the billing workflow in Chargebee.

PayPal Express Checkout
You can use this API if you are directly integrating PayPal Express Checkout in your website instead of using Chargebee's hosted pages. When your customer updates his payment method using PayPal Express Checkout, you will be provided with the Billing Agreement ID by PayPal. You can update the payment method for that customer in Chargebee by passing type as paypal_express_checkout and reference_id with the Billing Agreement ID.

Login and Pay with Amazon
You can use this API if you are directly integrating Login and Pay with Amazon in your website instead of using Chargebee's hosted pages. When your customer updates Amazon as a payment method, you will be provided with the Billing Agreement ID by Amazon. You can update the payment method for that customer in Chargebee by passing type as amazon_payments and reference_id with the Billing Agreement ID.

Card Payments
When the card details of your customer are stored in the vault of gateways such as Stripe or Braintree, you can use this API to update the reference id provided by them in Chargebee. To use this API, pass

  • type as card.
  • gateway with the gateway associated with the card. If the gateway is not specified, the default gateway will be used.
  • reference_id with the identifier provided by the gateway/Spreedly to reference that specific card.

Reference id format for Card Payments
The format of reference_id will differ based on where the card is stored.
Stripe: In case of Stripe, the reference_id consists of combination of Stripe Customer ID and Stripe Card ID separated by forward slash (e.g. cus_63MnDn0t6kfDW7/card_6WjCF20vT9WN1G). If you are passing Stripe Customer ID alone, then Chargebee will store the card marked as active for that customer in Stripe.
Braintree: In case of Braintree, the reference_id consists of combination of Braintree Customer ID and Braintree Payment Method Token separated by forward slash (e.g. cus_63MnDn0t6kfDW7/card_6WjCF20vT9WN1G). If you are passing Braintree Customer ID alone, then Chargebee will store the card marked as default for that customer in Braintree.
Spreedly Card vault: If the card details are stored in Spreedly vault, then you need to provide the Spreedly token as reference_id.

Direct Debit Payments
When the bank account details of your customer is stored in the vault of Authorize.Net, you can use this API to update the reference id provided by them in Chargebee. To use this API, pass

  • type as direct_debit.
  • gateway with the gateway where the bank account details are stored (e.g. authorize_net). If the gateway is not specified, the gateway supporting the direct debit will be used.
  • reference_id with the identifier provided by the gateway to reference the customer's bank account details.

Reference id format for Direct Debit Payments
The reference_id consists of combination of Authorize.Net's Customer Profile ID and Payment Profile ID separated by forward slash (e.g. 2384383/34834382). If you are passing Authorize.Net's Customer Profile ID alone, then Chargebee will store the first bank account details present in payment profile list of that customer in Authorize.Net.

Note: While using this API to update payment method details, Card Verification will not happen even if it is enabled for that particular gateway.

Notes

Storing card after successful 3DS flow not supported in this API. Use create using Payment Intent API under Payment source to store the card after successful 3DS flow completion.
Sample Request
curl  https://{site}.chargebee.com/api/v1/customers/__test__5SK0bLNFRFuBzXuCd/update_payment_method \
     -u {site_api_key}:\
     -d payment_method[type]="CARD" \
     -d payment_method[reference_id]="cus_EOFhU9kPO6xU5G" \
     -d payment_method[gateway]="STRIPE"
copy
Click to Copy

Sample Response [ JSON ]

Show more...
{
    "card": {
        "card_type": "visa",
        "customer_id": "__test__5SK0bLNFRFuBzXuCd",
        "expiry_month": 12,
        "expiry_year": 2019,
        "gateway": "stripe",
        "iin": "******",
        "last4": "1111",
        "masked_number": "************1111",
        "object": "card",
        "status": "valid"
    },
    "customer": {
        "account_credits": 0,
        "allow_direct_debit": false,
        "auto_collection": "on",
        "card_status": "valid",
        "created_at": 1517506686,
        "excess_payments": 0,
        "first_name": "David",
        "id": "__test__5SK0bLNFRFuBzXuCd",
        "last_name": "Young",
        "object": "customer",
        "payment_method": {
            "gateway": "stripe",
            "object": "payment_method",
            "reference_id": "cus_EOFhU9kPO6xU5G/card_1DvTCMJv9j0DyntJmVTtsFci",
            "status": "valid",
            "type": "card"
        },
        "refundable_credits": 0,
        "taxability": "taxable"
    }
}

URL Format POST

https://{site}.chargebee.com/api/v1/customers/{customer-id}/update_payment_method

Method

payment_method[type]
required, enumerated string
Possible values are
cardCard based payment including credit cards and debit cards. Details about the card can be obtained from the card resource.paypal_express_checkoutPayments made via PayPal Express Checkout.amazon_paymentsPayments made via Amazon Payments.direct_debitRepresents bank account for which the direct debit or ACH agreement/mandate is created.
Show all values[+]
payment_method[gateway]
optional, enumerated string
Possible values are
stripeStripe is a payment gateway.braintreeBraintree is a payment gateway.authorize_netAuthorize.net is a payment gatewaypaypal_proPayPal Pro Account is a payment gateway.
Show all values[+]
payment_method[reference_id]
required, string, max chars=200
customer customer
always returned
Resource object representing customer
card card
optional
Resource object representing card

Sample admin console URL

https://{site}.chargebee.com/admin-console/customers/123x

This method is used for updating the 'Billing Info' - the Billing Address and 'vat_number' attributes - of the customer. For updating the other customer attributes use our Update Customer API.

During this operation if Billing Info(Billing Address and vat_number) is not already present it will get added. Whereas if it is present already, the existing values will be replaced. i.e existing values for Billing Address and vat_number will be cleared and the new values will be set.

Note: When an invoice is generated for a customer, the billing address provided for the customer will be stored with the invoice. If the First Name, Last Name, and Company fields do not contain any information under Billing Info, the same will be picked from Customer Details if the same is available there.

Notes

Sample Request
curl  https://{site}.chargebee.com/api/v1/customers/__test__5SK0bLNFRFuBzTbCV/update_billing_info \
     -u {site_api_key}:\
     -d billing_address[first_name]="John" \
     -d billing_address[last_name]="Doe" \
     -d billing_address[line1]="PO Box 9999" \
     -d billing_address[city]="Walnut" \
     -d billing_address[state]="California" \
     -d billing_address[zip]="91789" \
     -d billing_address[country]="US"
copy
Click to Copy

Sample Response [ JSON ]

Show more...
{
    "customer": {
        "account_credits": 0,
        "allow_direct_debit": false,
        "auto_collection": "on",
        "billing_address": {
            "city": "Walnut",
            "country": "US",
            "first_name": "John",
            "last_name": "Doe",
            "line1": "PO Box 9999",
            "object": "billing_address",
            "state": "California",
            "state_code": "CA",
            "zip": "91789"
        },
        "card_status": "no_card",
        "created_at": 1517506685,
        "excess_payments": 0,
        "first_name": "David",
        "id": "__test__5SK0bLNFRFuBzTbCV",
        "last_name": "Lewis",
        "object": "customer",
        "refundable_credits": 0,
        "taxability": "taxable"
    }
}

URL Format POST

https://{site}.chargebee.com/api/v1/customers/{customer-id}/update_billing_info

Method

vat_number[]
optional, string, max chars=20
The VAT/tax registration number for the customer. For customers with billing_address country as XI (which is United Kingdom - Northern Ireland), the first two characters of the full VAT number can be overridden by setting vat_number_prefix.
billing_address[first_name]
optional, string, max chars=150
billing_address[last_name]
optional, string, max chars=150
billing_address[email]
optional, string, max chars=70
billing_address[company]
optional, string, max chars=250
billing_address[phone]
optional, string, max chars=50
billing_address[line1]
optional, string, max chars=150
billing_address[line2]
optional, string, max chars=150
billing_address[line3]
optional, string, max chars=150
billing_address[city]
optional, string, max chars=50
billing_address[state_code]
optional, string, max chars=50
billing_address[state]
optional, string, max chars=50
billing_address[zip]
optional, string, max chars=20
billing_address[country]
optional, string, max chars=50
customer customer
always returned
Resource object representing customer
card card
optional
Resource object representing card

Sample admin console URL

https://{site}.chargebee.com/admin-console/customers/123x

Creates an additional contact for the customer. You can add up to a maximum of 6 contacts. Learn more about Contacts.

Notes

Sample Request
curl  https://{site}.chargebee.com/api/v1/customers/__test__5SK0bLNFRFuBy8HBN/add_contact \
     -u {site_api_key}:\
     -d contact[first_name]="Jane" \
     -d contact[last_name]="Doe" \
     -d contact[email]="jane@test.com" \
     -d contact[label]="dev" \
     -d contact[enabled]=true \
     -d contact[send_billing_email]=true \
     -d contact[send_account_email]=true
copy
Click to Copy

Sample Response [ JSON ]

Show more...
{
    "customer": {
        "account_credits": 0,
        "allow_direct_debit": false,
        "auto_collection": "on",
        "card_status": "no_card",
        "contacts": [
            {
                "email": "jane@test.com",
                "enabled": true,
                "first_name": "Jane",
                "id": "contact___test__5SK0bLNFRFuBy8kBP",
                "label": "dev",
                "last_name": "Doe",
                "object": "contact",
                "send_account_email": true,
                "send_billing_email": true
            },
            {..}
        ],
        "created_at": 1517506680,
        "excess_payments": 0,
        "first_name": "John",
        "id": "__test__5SK0bLNFRFuBy8HBN",
        "last_name": "Doe",
        "object": "customer",
        "refundable_credits": 0,
        "taxability": "taxable"
    }
}

URL Format POST

https://{site}.chargebee.com/api/v1/customers/{customer-id}/add_contact

Method

contact[id]
optional, string, max chars=150
contact[first_name]
optional, string, max chars=150
contact[last_name]
optional, string, max chars=150
contact[email]
required, string, max chars=70
contact[phone]
optional, string, max chars=50
contact[label]
optional, string, max chars=50
contact[enabled]
optional, boolean, default=false
contact[send_billing_email]
optional, boolean, default=false
contact[send_account_email]
optional, boolean, default=false
customer customer
always returned
Resource object representing customer
card card
optional
Resource object representing card

Sample admin console URL

https://{site}.chargebee.com/admin-console/customers/123x

Updates the contact information. Learn more about Contacts.

Notes

Sample Request
curl  https://{site}.chargebee.com/api/v1/customers/__test__5SK0bLNFRFuBzV0CY/update_contact \
     -u {site_api_key}:\
     -d contact[id]="contact___test__5SK0bLNFRFuBzVVCa" \
     -d contact[first_name]="Jane" \
     -d contact[last_name]="Doe" \
     -d contact[email]="jane@test.com" \
     -d contact[label]="dev" \
     -d contact[enabled]=true \
     -d contact[send_billing_email]=true \
     -d contact[send_account_email]=true
copy
Click to Copy

Sample Response [ JSON ]

Show more...
{
    "customer": {
        "account_credits": 0,
        "allow_direct_debit": false,
        "auto_collection": "on",
        "card_status": "no_card",
        "contacts": [
            {
                "email": "jane@test.com",
                "enabled": true,
                "first_name": "Jane",
                "id": "contact___test__5SK0bLNFRFuBzVVCa",
                "label": "dev",
                "last_name": "Doe",
                "object": "contact",
                "send_account_email": true,
                "send_billing_email": true
            },
            {..}
        ],
        "created_at": 1517506686,
        "excess_payments": 0,
        "first_name": "John",
        "id": "__test__5SK0bLNFRFuBzV0CY",
        "last_name": "Doe",
        "object": "customer",
        "refundable_credits": 0,
        "taxability": "taxable"
    }
}

URL Format POST

https://{site}.chargebee.com/api/v1/customers/{customer-id}/update_contact

Method

contact[id]
required, string, max chars=150
contact[first_name]
optional, string, max chars=150
contact[last_name]
optional, string, max chars=150
contact[email]
optional, string, max chars=70
contact[phone]
optional, string, max chars=50
contact[label]
optional, string, max chars=50
contact[enabled]
optional, boolean, default=false
contact[send_billing_email]
optional, boolean, default=false
contact[send_account_email]
optional, boolean, default=false
customer customer
always returned
Resource object representing customer
card card
optional
Resource object representing card

Sample admin console URL

https://{site}.chargebee.com/admin-console/customers/123x

Deletes the contact information. Learn more about Contacts.

Notes

Sample Request
curl  https://{site}.chargebee.com/api/v1/customers/__test__5SK0bLNFRFuBzFdC3/delete_contact \
     -u {site_api_key}:\
     -d contact[id]="contact___test__5SK0bLNFRFuBzG9C5"
copy
Click to Copy

Sample Response [ JSON ]

Show more...
{
    "customer": {
        "account_credits": 0,
        "allow_direct_debit": false,
        "auto_collection": "on",
        "card_status": "no_card",
        "created_at": 1517506685,
        "excess_payments": 0,
        "first_name": "John",
        "id": "__test__5SK0bLNFRFuBzFdC3",
        "last_name": "Doe",
        "object": "customer",
        "refundable_credits": 0,
        "taxability": "taxable"
    }
}

URL Format POST

https://{site}.chargebee.com/api/v1/customers/{customer-id}/delete_contact

Method

contact[id]
required, string, max chars=150
customer customer
always returned
Resource object representing customer
card card
optional
Resource object representing card

Sample admin console URL

https://{site}.chargebee.com/admin-console/customers/123x

This API call can be used to add credits to a customer. Learn more about Promotional Credits.

For example, if a customer has credits of $10, if you pass the amount as $10, then the customer’s credit balance would become $20.

Notes

Sample Request
curl  https://{site}.chargebee.com/api/v1/customers/__test__3Nl9RLTRcPq8ZI3q/add_account_credits \
     -u {site_api_key}:\
     -d amount=500 \
     -d description="Loyalty credits"
copy
Click to Copy

Sample Response [ JSON ]

Show more...
{
    "customer": {
        "account_credits": 500,
        "allow_direct_debit": false,
        "auto_collection": "on",
        "card_status": "valid",
        "created_at": 1517479642,
        "excess_payments": 0,
        "first_name": "Mark",
        "id": "__test__3Nl9RLTRcPq8ZI3q",
        "last_name": "Henry",
        "object": "customer",
        "payment_method": {
            "gateway": "chargebee",
            "object": "payment_method",
            "reference_id": "tok___test__3Nl9RLTRcPq8a13r",
            "status": "valid",
            "type": "card"
        },
        "refundable_credits": 0,
        "taxability": "taxable"
    }
}

URL Format POST

https://{site}.chargebee.com/api/v1/customers/{customer-id}/add_account_credits

Method

amount[]
required, in cents, min=1
Credit amount to be added.
description[]
required, string, max chars=250
Description for this credit.
customer customer
always returned
Resource object representing customer

Sample admin console URL

https://{site}.chargebee.com/admin-console/customers/123x

This API call can be used to deduct credits for a customer. Learn more about Promotional Credits.

For example, if a customer has a credit balance of $20, if you pass the amount as $5, then the customer’s credit balance would become $15.

Notes

Sample Request
curl  https://{site}.chargebee.com/api/v1/customers/__test__3Nl9RLTRcPqBDO4m/deduct_account_credits \
     -u {site_api_key}:\
     -d amount=200 \
     -d description="Correcting credits given by mistake"
copy
Click to Copy

Sample Response [ JSON ]

Show more...
{
    "customer": {
        "account_credits": 300,
        "allow_direct_debit": false,
        "auto_collection": "on",
        "card_status": "valid",
        "created_at": 1517479652,
        "excess_payments": 0,
        "first_name": "Mark",
        "id": "__test__3Nl9RLTRcPqBDO4m",
        "last_name": "Henry",
        "object": "customer",
        "payment_method": {
            "gateway": "chargebee",
            "object": "payment_method",
            "reference_id": "tok___test__3Nl9RLTRcPqBDa4n",
            "status": "valid",
            "type": "card"
        },
        "refundable_credits": 0,
        "taxability": "taxable"
    }
}

URL Format POST

https://{site}.chargebee.com/api/v1/customers/{customer-id}/deduct_account_credits

Method

amount[]
required, in cents, min=1
Credit amount to be deducted.
description[]
required, string, max chars=250
Description for this credit.
customer customer
always returned
Resource object representing customer

Sample admin console URL

https://{site}.chargebee.com/admin-console/customers/123x

This API call can be used to set credits for a customer. Learn more about Promotional Credits.

For example, if a customer has a credit balance of $10 and if you would like to set the balance to $100, you could pass the amount as $100.

Notes

Sample Request
curl  https://{site}.chargebee.com/api/v1/customers/__test__3Nl9RLTRcPqBqT5I/set_account_credits \
     -u {site_api_key}:\
     -d amount=500 \
     -d description="Loyalty credits"
copy
Click to Copy

Sample Response [ JSON ]

Show more...
{
    "customer": {
        "account_credits": 500,
        "allow_direct_debit": false,
        "auto_collection": "on",
        "card_status": "valid",
        "created_at": 1517479655,
        "excess_payments": 0,
        "first_name": "Mark",
        "id": "__test__3Nl9RLTRcPqBqT5I",
        "last_name": "Henry",
        "object": "customer",
        "payment_method": {
            "gateway": "chargebee",
            "object": "payment_method",
            "reference_id": "tok___test__3Nl9RLTRcPqBqi5J",
            "status": "valid",
            "type": "card"
        },
        "refundable_credits": 0,
        "taxability": "taxable"
    }
}

URL Format POST

https://{site}.chargebee.com/api/v1/customers/{customer-id}/set_account_credits

Method

amount[]
required, in cents, min=0
Credit amount to be set.
description[]
required, string, max chars=250
Description for this credit.
customer customer
always returned
Resource object representing customer

Sample admin console URL

https://{site}.chargebee.com/admin-console/customers/123x

Deletes the customer resource.

Notes

This will delete the Payment Method from the gateway/vault. If you do not want the Payment Method to be deleted from the vault, set the value for the delete_payment_method parameter to false.

This operation is irreversible - all data related to the customer, such as subscriptions, invoices, transactions, and reports, will be deleted.

Note: This operation schedules the customer resource for deletion. It will be deleted in a few minutes.

Sample Request
curl  https://{site}.chargebee.com/api/v1/customers/__test__5SK0bLNFRFuBzESC1/delete \
     -X POST  \
     -u {site_api_key}:
copy
Click to Copy

Sample Response [ JSON ]

Show more...
{
    "customer": {
        "account_credits": 0,
        "allow_direct_debit": false,
        "auto_collection": "on",
        "card_status": "no_card",
        "created_at": 1517506685,
        "excess_payments": 0,
        "first_name": "John",
        "id": "__test__5SK0bLNFRFuBzESC1",
        "last_name": "Doe",
        "object": "customer",
        "refundable_credits": 0,
        "taxability": "taxable"
    }
}

URL Format POST

https://{site}.chargebee.com/api/v1/customers/{customer-id}/delete

Method

delete_payment_method[]
optional, boolean, default=true
Deletes the Payment Method from the gateway/vault.
customer customer
always returned
Resource object representing customer
card card
optional
Resource object representing card

Sample admin console URL

https://{site}.chargebee.com/admin-console/customers/123x