chargebee 2.26.1 → 2.28.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +40 -0
- package/lib/chargebee.js +1 -1
- package/lib/resources/api_endpoints.js +8 -1
- package/package.json +1 -1
- package/types/resources/Address.d.ts +0 -10
- package/types/resources/AttachedItem.d.ts +0 -20
- package/types/resources/Card.d.ts +0 -110
- package/types/resources/Comment.d.ts +0 -17
- package/types/resources/Coupon.d.ts +0 -37
- package/types/resources/CouponCode.d.ts +0 -10
- package/types/resources/CouponSet.d.ts +0 -30
- package/types/resources/CreditNote.d.ts +0 -102
- package/types/resources/Customer.d.ts +0 -313
- package/types/resources/DifferentialPrice.d.ts +0 -20
- package/types/resources/Estimate.d.ts +0 -160
- package/types/resources/Event.d.ts +0 -7
- package/types/resources/Export.d.ts +0 -81
- package/types/resources/Feature.d.ts +0 -69
- package/types/resources/Gift.d.ts +0 -55
- package/types/resources/HostedPage.d.ts +0 -166
- package/types/resources/InAppSubscription.d.ts +0 -267
- package/types/resources/Invoice.d.ts +0 -350
- package/types/resources/Item.d.ts +0 -20
- package/types/resources/ItemEntitlement.d.ts +0 -10
- package/types/resources/ItemFamily.d.ts +0 -20
- package/types/resources/ItemPrice.d.ts +0 -20
- package/types/resources/NonSubscription.d.ts +0 -5
- package/types/resources/Order.d.ts +0 -52
- package/types/resources/PaymentIntent.d.ts +0 -25
- package/types/resources/PaymentSource.d.ts +0 -275
- package/types/resources/PaymentVoucher.d.ts +0 -10
- package/types/resources/PortalSession.d.ts +0 -33
- package/types/resources/PromotionalCredit.d.ts +0 -51
- package/types/resources/Purchase.d.ts +0 -68
- package/types/resources/Quote.d.ts +0 -165
- package/types/resources/ResourceMigration.d.ts +0 -5
- package/types/resources/Subscription.d.ts +103 -1001
- package/types/resources/TimeMachine.d.ts +0 -17
- package/types/resources/Token.d.ts +0 -15
- package/types/resources/Transaction.d.ts +0 -30
- package/types/resources/UnbilledCharge.d.ts +0 -46
- package/types/resources/Usage.d.ts +0 -22
- package/types/resources/VirtualBankAccount.d.ts +0 -35
|
@@ -718,18 +718,8 @@ During this operation, if `billing_address` and `vat_number`
|
|
|
718
718
|
update_billing_info(customer_id:string, input?:UpdateBillingInfoInputParam):ChargebeeRequest<UpdateBillingInfoResponse>;
|
|
719
719
|
}
|
|
720
720
|
export interface DeleteResponse {
|
|
721
|
-
/**
|
|
722
|
-
* @description Deletes a particular customer identified by the a unique identifier.
|
|
723
|
-
|
|
724
|
-
*/
|
|
725
|
-
|
|
726
721
|
customer:Customer;
|
|
727
722
|
|
|
728
|
-
/**
|
|
729
|
-
* @description Deletes a particular customer identified by the a unique identifier.
|
|
730
|
-
|
|
731
|
-
*/
|
|
732
|
-
|
|
733
723
|
card?:Card;
|
|
734
724
|
}
|
|
735
725
|
export interface DeleteInputParam {
|
|
@@ -742,15 +732,6 @@ During this operation, if `billing_address` and `vat_number`
|
|
|
742
732
|
delete_payment_method?:boolean;
|
|
743
733
|
}
|
|
744
734
|
export interface RelationshipsResponse {
|
|
745
|
-
/**
|
|
746
|
-
* @description Sets a customer into a [hierarchical relationship](https://www.chargebee.com/docs/account-hierarchy.html) with another. The path parameter `customer_id` is the ID of the child in the relationship.
|
|
747
|
-
**Note**
|
|
748
|
-
|
|
749
|
-
* In the descriptions for `use_default_hierarchy_settings`, `parent_account_access`, and `child_account_access` parameters, the "parent" is the customer whose ID is [payment_owner_id](/docs/api/customers?prod_cat_ver=2#link_a_customer_payment_owner_id). However, if the `payment_owner_id` is set as the ID of the child itself (`{customer_id}`), then the "parent" is [parent_id](/docs/api/customers?prod_cat_ver=2#link_a_customer_parent_id).
|
|
750
|
-
* The parent and the child customers must belong to the same [business entity](/docs/api?prod_cat_ver=2#mbe).
|
|
751
|
-
|
|
752
|
-
*/
|
|
753
|
-
|
|
754
735
|
customer:Customer;
|
|
755
736
|
}
|
|
756
737
|
export interface RelationshipsInputParam {
|
|
@@ -809,27 +790,12 @@ During this operation, if `billing_address` and `vat_number`
|
|
|
809
790
|
child_account_access?:{portal_download_invoices?:'no' | 'yes' | 'view_only',portal_edit_subscriptions?:'yes' | 'view_only',send_invoice_emails?:boolean,send_payment_emails?:boolean,send_subscription_emails?:boolean};
|
|
810
791
|
}
|
|
811
792
|
export interface DeleteRelationshipResponse {
|
|
812
|
-
/**
|
|
813
|
-
* @description Disconnects a child customer from its parent. `customer_id` is the [id](/docs/api/customers#customer_id) of the child.
|
|
814
|
-
|
|
815
|
-
*/
|
|
816
|
-
|
|
817
793
|
customer:Customer;
|
|
818
794
|
}
|
|
819
795
|
|
|
820
796
|
export interface DeleteContactResponse {
|
|
821
|
-
/**
|
|
822
|
-
* @description Deletes a particular contact for a customer. You can delete a contact by giving the Contact ID as the input parameter.
|
|
823
|
-
|
|
824
|
-
*/
|
|
825
|
-
|
|
826
797
|
customer:Customer;
|
|
827
798
|
|
|
828
|
-
/**
|
|
829
|
-
* @description Deletes a particular contact for a customer. You can delete a contact by giving the Contact ID as the input parameter.
|
|
830
|
-
|
|
831
|
-
*/
|
|
832
|
-
|
|
833
799
|
card?:Card;
|
|
834
800
|
}
|
|
835
801
|
export interface DeleteContactInputParam {
|
|
@@ -842,18 +808,8 @@ During this operation, if `billing_address` and `vat_number`
|
|
|
842
808
|
contact?:{id:string};
|
|
843
809
|
}
|
|
844
810
|
export interface AssignPaymentRoleResponse {
|
|
845
|
-
/**
|
|
846
|
-
* @description Assign Primary or Backup payment role or unassign role for the payment source based on the preference for the payment collection.
|
|
847
|
-
|
|
848
|
-
*/
|
|
849
|
-
|
|
850
811
|
customer:Customer;
|
|
851
812
|
|
|
852
|
-
/**
|
|
853
|
-
* @description Assign Primary or Backup payment role or unassign role for the payment source based on the preference for the payment collection.
|
|
854
|
-
|
|
855
|
-
*/
|
|
856
|
-
|
|
857
813
|
payment_source:PaymentSource;
|
|
858
814
|
}
|
|
859
815
|
export interface AssignPaymentRoleInputParam {
|
|
@@ -873,11 +829,6 @@ During this operation, if `billing_address` and `vat_number`
|
|
|
873
829
|
role:Role;
|
|
874
830
|
}
|
|
875
831
|
export interface MoveResponse {
|
|
876
|
-
/**
|
|
877
|
-
* @description This API copies a customer object from one site to another. The destination site (the site to which the customer is copied) is specified by the path parameter `{site}`; whereas, the source site (the site from which the customer is copied) is specified by the query parameter `from_site`.
|
|
878
|
-
|
|
879
|
-
*/
|
|
880
|
-
|
|
881
832
|
resource_migration:ResourceMigration;
|
|
882
833
|
}
|
|
883
834
|
export interface MoveInputParam {
|
|
@@ -897,11 +848,6 @@ During this operation, if `billing_address` and `vat_number`
|
|
|
897
848
|
from_site:string;
|
|
898
849
|
}
|
|
899
850
|
export interface HierarchyResponse {
|
|
900
|
-
/**
|
|
901
|
-
* @description Retrieves the [account hierarchy tree](/docs/api/hierarchies) for the customer.
|
|
902
|
-
|
|
903
|
-
*/
|
|
904
|
-
|
|
905
851
|
hierarchies:Hierarchy[];
|
|
906
852
|
}
|
|
907
853
|
export interface HierarchyInputParam {
|
|
@@ -914,108 +860,8 @@ During this operation, if `billing_address` and `vat_number`
|
|
|
914
860
|
hierarchy_operation_type:'complete_hierarchy' | 'subordinates' | 'path_to_root';
|
|
915
861
|
}
|
|
916
862
|
export interface UpdatePaymentMethodResponse {
|
|
917
|
-
/**
|
|
918
|
-
* @description We recently released [Payment Sources](/docs/api/payment_sources), which comes with additional options and improvements to the [Card APIs](/docs/api/cards). For this operation, use the [Create using temporary token](/docs/api/payment_sources#create_using_temporary_token) API or [Create using permanent token](/docs/api/payment_sources#create_using_permanent_token) API under Payment Sources to update payment method for the customer.
|
|
919
|
-
|
|
920
|
-
Updates payment method details for a customer.
|
|
921
|
-
|
|
922
|
-
**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](cards#update_card_for_a_customer) API under Cards resource. This API is not supported for Chargebee Test Gateway, it is provided to help you understand the billing workflow in Chargebee.
|
|
923
|
-
|
|
924
|
-
**PayPal Express Checkout**
|
|
925
|
-
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*.
|
|
926
|
-
|
|
927
|
-
**Login and Pay with Amazon**
|
|
928
|
-
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*.
|
|
929
|
-
|
|
930
|
-
**Card Payments**
|
|
931
|
-
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
|
|
932
|
-
|
|
933
|
-
* `type` as `card`.
|
|
934
|
-
* `gateway` with the gateway associated with the card. If the gateway is not specified, the default gateway will be used.
|
|
935
|
-
* `reference_id` with the identifier provided by the gateway/Spreedly to reference that specific card.
|
|
936
|
-
|
|
937
|
-
**Reference id format for Card Payments**
|
|
938
|
-
The format of reference_id will differ based on where the card is stored.
|
|
939
|
-
**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.
|
|
940
|
-
|
|
941
|
-
**Braintree:** In case of Braintree, the reference_id consists of combination of Braintree Customer ID and Braintree Payment Method Token separated by forward slash
|
|
942
|
-
(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.
|
|
943
|
-
|
|
944
|
-
**Spreedly Card vault:** If the card details are stored in Spreedly vault, then you need to provide the Spreedly token as `reference_id`.
|
|
945
|
-
|
|
946
|
-
**Direct Debit Payments**
|
|
947
|
-
When the bank account details of your customer are stored in the gateway vault, you can use this API to update the reference id provided by them in Chargebee. To use this API, pass
|
|
948
|
-
|
|
949
|
-
* `type` as `direct_debit`.
|
|
950
|
-
* `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.
|
|
951
|
-
* `reference_id` with the identifier provided by the gateway to reference the customer's bank account details.
|
|
952
|
-
* `tmp_token` with the single use token provided by the gateway ( Should be passed only if reference_id is not passed ).
|
|
953
|
-
|
|
954
|
-
**Reference id format for Direct Debit Payments**
|
|
955
|
-
The format of reference_id will differ based on where the bank account is stored.
|
|
956
|
-
**Stripe:** In case of Stripe, the reference_id consists of combination of Stripe Customer ID and Stripe Bank Account ID separated by forward slash
|
|
957
|
-
(e.g. *cus_8suoHaLQH4G5AW/ba_18b8z2KmcbENlhgU03RznRYW*). If you are passing Stripe Customer ID alone, then Chargebee will store the first bank account details present in payment profile list of that customer in Stripe.
|
|
958
|
-
|
|
959
|
-
**Authorize.Net:** 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.
|
|
960
|
-
|
|
961
|
-
**GoCardless:** The reference_id is the GoCardless Customer Mandate ID (e.g. *MD0077Z99TTQXK*).
|
|
962
|
-
|
|
963
|
-
**Note:** While using this API to update payment method details, [Card Verification](https://www.chargebee.com/docs/cards.html#card-verification) will not happen even if it is enabled for that particular gateway.
|
|
964
|
-
|
|
965
|
-
*/
|
|
966
|
-
|
|
967
863
|
customer:Customer;
|
|
968
864
|
|
|
969
|
-
/**
|
|
970
|
-
* @description We recently released [Payment Sources](/docs/api/payment_sources), which comes with additional options and improvements to the [Card APIs](/docs/api/cards). For this operation, use the [Create using temporary token](/docs/api/payment_sources#create_using_temporary_token) API or [Create using permanent token](/docs/api/payment_sources#create_using_permanent_token) API under Payment Sources to update payment method for the customer.
|
|
971
|
-
|
|
972
|
-
Updates payment method details for a customer.
|
|
973
|
-
|
|
974
|
-
**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](cards#update_card_for_a_customer) API under Cards resource. This API is not supported for Chargebee Test Gateway, it is provided to help you understand the billing workflow in Chargebee.
|
|
975
|
-
|
|
976
|
-
**PayPal Express Checkout**
|
|
977
|
-
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*.
|
|
978
|
-
|
|
979
|
-
**Login and Pay with Amazon**
|
|
980
|
-
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*.
|
|
981
|
-
|
|
982
|
-
**Card Payments**
|
|
983
|
-
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
|
|
984
|
-
|
|
985
|
-
* `type` as `card`.
|
|
986
|
-
* `gateway` with the gateway associated with the card. If the gateway is not specified, the default gateway will be used.
|
|
987
|
-
* `reference_id` with the identifier provided by the gateway/Spreedly to reference that specific card.
|
|
988
|
-
|
|
989
|
-
**Reference id format for Card Payments**
|
|
990
|
-
The format of reference_id will differ based on where the card is stored.
|
|
991
|
-
**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.
|
|
992
|
-
|
|
993
|
-
**Braintree:** In case of Braintree, the reference_id consists of combination of Braintree Customer ID and Braintree Payment Method Token separated by forward slash
|
|
994
|
-
(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.
|
|
995
|
-
|
|
996
|
-
**Spreedly Card vault:** If the card details are stored in Spreedly vault, then you need to provide the Spreedly token as `reference_id`.
|
|
997
|
-
|
|
998
|
-
**Direct Debit Payments**
|
|
999
|
-
When the bank account details of your customer are stored in the gateway vault, you can use this API to update the reference id provided by them in Chargebee. To use this API, pass
|
|
1000
|
-
|
|
1001
|
-
* `type` as `direct_debit`.
|
|
1002
|
-
* `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.
|
|
1003
|
-
* `reference_id` with the identifier provided by the gateway to reference the customer's bank account details.
|
|
1004
|
-
* `tmp_token` with the single use token provided by the gateway ( Should be passed only if reference_id is not passed ).
|
|
1005
|
-
|
|
1006
|
-
**Reference id format for Direct Debit Payments**
|
|
1007
|
-
The format of reference_id will differ based on where the bank account is stored.
|
|
1008
|
-
**Stripe:** In case of Stripe, the reference_id consists of combination of Stripe Customer ID and Stripe Bank Account ID separated by forward slash
|
|
1009
|
-
(e.g. *cus_8suoHaLQH4G5AW/ba_18b8z2KmcbENlhgU03RznRYW*). If you are passing Stripe Customer ID alone, then Chargebee will store the first bank account details present in payment profile list of that customer in Stripe.
|
|
1010
|
-
|
|
1011
|
-
**Authorize.Net:** 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.
|
|
1012
|
-
|
|
1013
|
-
**GoCardless:** The reference_id is the GoCardless Customer Mandate ID (e.g. *MD0077Z99TTQXK*).
|
|
1014
|
-
|
|
1015
|
-
**Note:** While using this API to update payment method details, [Card Verification](https://www.chargebee.com/docs/cards.html#card-verification) will not happen even if it is enabled for that particular gateway.
|
|
1016
|
-
|
|
1017
|
-
*/
|
|
1018
|
-
|
|
1019
865
|
card?:Card;
|
|
1020
866
|
}
|
|
1021
867
|
export interface UpdatePaymentMethodInputParam {
|
|
@@ -1028,34 +874,14 @@ The format of reference_id will differ based on where the bank account is stored
|
|
|
1028
874
|
payment_method?:{additional_information?:object,gateway_account_id?:string,issuing_country?:string,reference_id?:string,tmp_token?:string,type:Type};
|
|
1029
875
|
}
|
|
1030
876
|
export interface RetrieveResponse {
|
|
1031
|
-
/**
|
|
1032
|
-
* @description Retrieves the details of the desired customer. You can use the unique identifier for a particular customer to retrieve the desired details.
|
|
1033
|
-
|
|
1034
|
-
*/
|
|
1035
|
-
|
|
1036
877
|
customer:Customer;
|
|
1037
878
|
|
|
1038
|
-
/**
|
|
1039
|
-
* @description Retrieves the details of the desired customer. You can use the unique identifier for a particular customer to retrieve the desired details.
|
|
1040
|
-
|
|
1041
|
-
*/
|
|
1042
|
-
|
|
1043
879
|
card?:Card;
|
|
1044
880
|
}
|
|
1045
881
|
|
|
1046
882
|
export interface UpdateResponse {
|
|
1047
|
-
/**
|
|
1048
|
-
* @description 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](/docs/api/customers#update_billing_info_for_a_customer) API.
|
|
1049
|
-
|
|
1050
|
-
*/
|
|
1051
|
-
|
|
1052
883
|
customer:Customer;
|
|
1053
884
|
|
|
1054
|
-
/**
|
|
1055
|
-
* @description 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](/docs/api/customers#update_billing_info_for_a_customer) API.
|
|
1056
|
-
|
|
1057
|
-
*/
|
|
1058
|
-
|
|
1059
885
|
card?:Card;
|
|
1060
886
|
}
|
|
1061
887
|
export interface UpdateInputParam {
|
|
@@ -1230,11 +1056,6 @@ Any invoices raised when a subscription activates from `in_trial` or &
|
|
|
1230
1056
|
consolidated_invoicing?:boolean;
|
|
1231
1057
|
}
|
|
1232
1058
|
export interface ChangeBillingDateResponse {
|
|
1233
|
-
/**
|
|
1234
|
-
* @description Applicable when *calendar billing* (with customer specific billing date support) is enabled. Changes the customer's *billing_date* and/or *billing_day_of_week*.
|
|
1235
|
-
|
|
1236
|
-
*/
|
|
1237
|
-
|
|
1238
1059
|
customer:Customer;
|
|
1239
1060
|
}
|
|
1240
1061
|
export interface ChangeBillingDateInputParam {
|
|
@@ -1434,50 +1255,8 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
1434
1255
|
relationship?:{invoice_owner_id?:{is?:string,is_not?:string,starts_with?:string},parent_id?:{is?:string,is_not?:string,starts_with?:string},payment_owner_id?:{is?:string,is_not?:string,starts_with?:string}};
|
|
1435
1256
|
}
|
|
1436
1257
|
export interface CreateResponse {
|
|
1437
|
-
/**
|
|
1438
|
-
* @description **Note:** This operation optionally supports 3DS verification flow. To achieve the same, create the [Payment Intent](/docs/api/3ds_card_payments?prod_cat_ver=1) and pass it as input parameter to this API.
|
|
1439
|
-
|
|
1440
|
-
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.
|
|
1441
|
-
|
|
1442
|
-
Passing raw card data via API involves PCI liability at your end due to the sensitivity of the data. Instead, you can use one of the following integration options as applicable:
|
|
1443
|
-
|
|
1444
|
-
Here's some resources you can use to collect card information within your checkout form based on the payment gateway you use:
|
|
1445
|
-
|
|
1446
|
-
* [Stripe.js](https://stripe.com/docs/js) for Stripe users.
|
|
1447
|
-
* [Braintree.js](https://developer.paypal.com/braintree/docs/guides/client-sdk/setup/javascript/v2) for Braintree users.
|
|
1448
|
-
* [Accept.js](https://developer.authorize.net/api/reference/features/acceptjs.html), if you use [Authorize.Net](https://www.authorize.net/).
|
|
1449
|
-
* If you are using the Adyen gateway, you will have to use the Adyen's [Client-Side Encryption](https://docs.adyen.com/developers/features/client-side-encryption) to encrypt sensitive cardholder data. Once the cardholder data is encrypted, pass the value in `adyen.encrypted.data`as temp token in this API.
|
|
1450
|
-
* You can also use our [Hosted Pages](https://www.chargebee.com/docs/1.0/hosted_pages.html) based integration.
|
|
1451
|
-
|
|
1452
|
-
When billing address is not passed (say, for customers making offline payments), you can always provide it later using the [Update billing info for a customer API](/docs/api/customers#update_billing_info_for_a_customer).
|
|
1453
|
-
|
|
1454
|
-
**Note:**When an invoice is generated for a customer, the billing address provided for the customer is stored with the invoice. If the First Name, Last Name, and Company fields of the billing address do not contain any information, they're picked up from the customer details.
|
|
1455
|
-
|
|
1456
|
-
*/
|
|
1457
|
-
|
|
1458
1258
|
customer:Customer;
|
|
1459
1259
|
|
|
1460
|
-
/**
|
|
1461
|
-
* @description **Note:** This operation optionally supports 3DS verification flow. To achieve the same, create the [Payment Intent](/docs/api/3ds_card_payments?prod_cat_ver=1) and pass it as input parameter to this API.
|
|
1462
|
-
|
|
1463
|
-
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.
|
|
1464
|
-
|
|
1465
|
-
Passing raw card data via API involves PCI liability at your end due to the sensitivity of the data. Instead, you can use one of the following integration options as applicable:
|
|
1466
|
-
|
|
1467
|
-
Here's some resources you can use to collect card information within your checkout form based on the payment gateway you use:
|
|
1468
|
-
|
|
1469
|
-
* [Stripe.js](https://stripe.com/docs/js) for Stripe users.
|
|
1470
|
-
* [Braintree.js](https://developer.paypal.com/braintree/docs/guides/client-sdk/setup/javascript/v2) for Braintree users.
|
|
1471
|
-
* [Accept.js](https://developer.authorize.net/api/reference/features/acceptjs.html), if you use [Authorize.Net](https://www.authorize.net/).
|
|
1472
|
-
* If you are using the Adyen gateway, you will have to use the Adyen's [Client-Side Encryption](https://docs.adyen.com/developers/features/client-side-encryption) to encrypt sensitive cardholder data. Once the cardholder data is encrypted, pass the value in `adyen.encrypted.data`as temp token in this API.
|
|
1473
|
-
* You can also use our [Hosted Pages](https://www.chargebee.com/docs/1.0/hosted_pages.html) based integration.
|
|
1474
|
-
|
|
1475
|
-
When billing address is not passed (say, for customers making offline payments), you can always provide it later using the [Update billing info for a customer API](/docs/api/customers#update_billing_info_for_a_customer).
|
|
1476
|
-
|
|
1477
|
-
**Note:**When an invoice is generated for a customer, the billing address provided for the customer is stored with the invoice. If the First Name, Last Name, and Company fields of the billing address do not contain any information, they're picked up from the customer details.
|
|
1478
|
-
|
|
1479
|
-
*/
|
|
1480
|
-
|
|
1481
1260
|
card?:Card;
|
|
1482
1261
|
}
|
|
1483
1262
|
export interface CreateInputParam {
|
|
@@ -1789,18 +1568,8 @@ An alternative way of passing this parameter is by means of a [custom HTTP heade
|
|
|
1789
1568
|
entity_identifiers?:{id?:string,scheme?:string,standard?:string,value?:string}[];
|
|
1790
1569
|
}
|
|
1791
1570
|
export interface AddContactResponse {
|
|
1792
|
-
/**
|
|
1793
|
-
* @description Adds the required contact to a customer. You can give the First Name, Last Name, Email ID and more details as input parameters to add them under the desired customer.
|
|
1794
|
-
|
|
1795
|
-
*/
|
|
1796
|
-
|
|
1797
1571
|
customer:Customer;
|
|
1798
1572
|
|
|
1799
|
-
/**
|
|
1800
|
-
* @description Adds the required contact to a customer. You can give the First Name, Last Name, Email ID and more details as input parameters to add them under the desired customer.
|
|
1801
|
-
|
|
1802
|
-
*/
|
|
1803
|
-
|
|
1804
1573
|
card?:Card;
|
|
1805
1574
|
}
|
|
1806
1575
|
export interface AddContactInputParam {
|
|
@@ -1844,24 +1613,10 @@ An alternative way of passing this parameter is by means of a [custom HTTP heade
|
|
|
1844
1613
|
offset?:string;
|
|
1845
1614
|
}
|
|
1846
1615
|
export interface ClearPersonalDataResponse {
|
|
1847
|
-
/**
|
|
1848
|
-
* @description Clear personal details of a customer using this API.
|
|
1849
|
-
|
|
1850
|
-
*/
|
|
1851
|
-
|
|
1852
1616
|
customer:Customer;
|
|
1853
1617
|
}
|
|
1854
1618
|
|
|
1855
1619
|
export interface MergeResponse {
|
|
1856
|
-
/**
|
|
1857
|
-
* @description This API moves a customer's payment methods, subscriptions, invoices, credit notes, transactions, unbilled charges, and orders to another customer. Events and email logs will not be moved. The API execution is asynchronous.
|
|
1858
|
-
**Note**
|
|
1859
|
-
|
|
1860
|
-
* Moving virtual bank accounts from one customer to another is not supported in this API.
|
|
1861
|
-
* Merging customers from different [business entities](/docs/api?prod_cat_ver=2#mbe) is not permitted.
|
|
1862
|
-
|
|
1863
|
-
*/
|
|
1864
|
-
|
|
1865
1620
|
customer:Customer;
|
|
1866
1621
|
}
|
|
1867
1622
|
export interface MergeInputParam {
|
|
@@ -1881,22 +1636,8 @@ An alternative way of passing this parameter is by means of a [custom HTTP heade
|
|
|
1881
1636
|
to_customer_id:string;
|
|
1882
1637
|
}
|
|
1883
1638
|
export interface CollectPaymentResponse {
|
|
1884
|
-
/**
|
|
1885
|
-
* @description **Note:** This operation optionally supports 3DS verification flow. To achieve the same, create the [Payment Intent](/docs/api/#3ds_card_payments) and pass it as input parameter to this API.
|
|
1886
|
-
|
|
1887
|
-
This API can be used to collect the payments for customer's **payment_due** and **not_paid** invoices. You can either choose to collect the payment from an existing payment source or a new payment source. You can choose to either retain or discard the new payment source, which is being used for payment. If the amount collected exceeds the invoice amount, the surplus will be counted in as excess payments.
|
|
1888
|
-
|
|
1889
|
-
*/
|
|
1890
|
-
|
|
1891
1639
|
customer:Customer;
|
|
1892
1640
|
|
|
1893
|
-
/**
|
|
1894
|
-
* @description **Note:** This operation optionally supports 3DS verification flow. To achieve the same, create the [Payment Intent](/docs/api/#3ds_card_payments) and pass it as input parameter to this API.
|
|
1895
|
-
|
|
1896
|
-
This API can be used to collect the payments for customer's **payment_due** and **not_paid** invoices. You can either choose to collect the payment from an existing payment source or a new payment source. You can choose to either retain or discard the new payment source, which is being used for payment. If the amount collected exceeds the invoice amount, the surplus will be counted in as excess payments.
|
|
1897
|
-
|
|
1898
|
-
*/
|
|
1899
|
-
|
|
1900
1641
|
transaction:Transaction;
|
|
1901
1642
|
}
|
|
1902
1643
|
export interface CollectPaymentInputParam {
|
|
@@ -1972,18 +1713,8 @@ This API can be used to collect the payments for customer's **payment_due**
|
|
|
1972
1713
|
invoice_allocations?:{allocation_amount?:number,invoice_id:string}[];
|
|
1973
1714
|
}
|
|
1974
1715
|
export interface RecordExcessPaymentResponse {
|
|
1975
|
-
/**
|
|
1976
|
-
* @description Use this API to record any [excess payments](//www.chargebee.com/docs/customers.html#excess-payments) made by the customer, such as advance payments. Such payments will be automatically applied to the future invoices. It can also be [manually applied](//www.chargebee.com/docs/invoice-operations.html#apply-excess-payments) to the existing *Not Paid* or *Payment Due* invoices.
|
|
1977
|
-
|
|
1978
|
-
*/
|
|
1979
|
-
|
|
1980
1716
|
customer:Customer;
|
|
1981
1717
|
|
|
1982
|
-
/**
|
|
1983
|
-
* @description Use this API to record any [excess payments](//www.chargebee.com/docs/customers.html#excess-payments) made by the customer, such as advance payments. Such payments will be automatically applied to the future invoices. It can also be [manually applied](//www.chargebee.com/docs/invoice-operations.html#apply-excess-payments) to the existing *Not Paid* or *Payment Due* invoices.
|
|
1984
|
-
|
|
1985
|
-
*/
|
|
1986
|
-
|
|
1987
1718
|
transaction:Transaction;
|
|
1988
1719
|
}
|
|
1989
1720
|
export interface RecordExcessPaymentInputParam {
|
|
@@ -2003,18 +1734,8 @@ This API can be used to collect the payments for customer's **payment_due**
|
|
|
2003
1734
|
transaction?:{amount:number,currency_code?:string,date:number,payment_method:PaymentMethod,reference_number?:string};
|
|
2004
1735
|
}
|
|
2005
1736
|
export interface UpdateContactResponse {
|
|
2006
|
-
/**
|
|
2007
|
-
* @description Updates the details of a contact for a customer. You can give the field data to be updated as input parameters along with the Contact ID to update it.
|
|
2008
|
-
|
|
2009
|
-
*/
|
|
2010
|
-
|
|
2011
1737
|
customer:Customer;
|
|
2012
1738
|
|
|
2013
|
-
/**
|
|
2014
|
-
* @description Updates the details of a contact for a customer. You can give the field data to be updated as input parameters along with the Contact ID to update it.
|
|
2015
|
-
|
|
2016
|
-
*/
|
|
2017
|
-
|
|
2018
1739
|
card?:Card;
|
|
2019
1740
|
}
|
|
2020
1741
|
export interface UpdateContactInputParam {
|
|
@@ -2027,22 +1748,6 @@ This API can be used to collect the payments for customer's **payment_due**
|
|
|
2027
1748
|
contact?:{email?:string,enabled?:boolean,first_name?:string,id:string,label?:string,last_name?:string,phone?:string,send_account_email?:boolean,send_billing_email?:boolean};
|
|
2028
1749
|
}
|
|
2029
1750
|
export interface UpdateHierarchySettingsResponse {
|
|
2030
|
-
/**
|
|
2031
|
-
* @description Changes the level of access that the parent or the child itself has to the child's information.
|
|
2032
|
-
|
|
2033
|
-
This data falls into two categories:
|
|
2034
|
-
|
|
2035
|
-
* **Self-Serve Portal data:** subscriptions and invoices of the child.
|
|
2036
|
-
* **Email Notifications:** subscription-, invoice- and payment-related notifications for the child.
|
|
2037
|
-
|
|
2038
|
-
The 'parent' is the customer whose id is [payment_owner_id](/docs/api/customers#customer_relationship_payment_owner_id). However, if the `payment_owner_id` is the child itself, then the parent is [parent_id](/docs/api/customers#customer_relationship_parent_id). The path parameter `customer_id` is the [id](/docs/api/customers#customer_id) of the child in the relationship.
|
|
2039
|
-
|
|
2040
|
-
|
|
2041
|
-
|
|
2042
|
-
**Note:** This endpoint cannot be used to change the `parent_id`, `invoice_owner_id` or `payment_owner_id` for the customer. To change them, [delink](/docs/api/customers#delink_a_customer) the customer and then call **Link a customer** again.
|
|
2043
|
-
|
|
2044
|
-
*/
|
|
2045
|
-
|
|
2046
1751
|
customer:Customer;
|
|
2047
1752
|
}
|
|
2048
1753
|
export interface UpdateHierarchySettingsInputParam {
|
|
@@ -2073,26 +1778,8 @@ The 'parent' is the customer whose id is [payment_owner_id](/docs/api/
|
|
|
2073
1778
|
child_account_access?:{portal_download_invoices?:'no' | 'yes' | 'view_only',portal_edit_subscriptions?:'yes' | 'view_only',send_invoice_emails?:boolean,send_payment_emails?:boolean,send_subscription_emails?:boolean};
|
|
2074
1779
|
}
|
|
2075
1780
|
export interface UpdateBillingInfoResponse {
|
|
2076
|
-
/**
|
|
2077
|
-
* @description This method is used for updating the `billing_address` and `vat_number` attributes of the `customer`. For updating the other customer attributes use [Update Customer API](customers#update_a_customer).
|
|
2078
|
-
|
|
2079
|
-
During this operation, if `billing_address` and `vat_number` are not already present, they're added. Whereas if present, the existing values are replaced with the new values passed. The only exception here is for `entity_identifiers[i]` when `entity_identifiers[operation][i]` is passed as `delete`.
|
|
2080
|
-
|
|
2081
|
-
**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.Please ensure that the VAT number is provided whenever the billing address is updated, as failing to do so will override any existing VAT numbers if new values are not provided.
|
|
2082
|
-
|
|
2083
|
-
*/
|
|
2084
|
-
|
|
2085
1781
|
customer:Customer;
|
|
2086
1782
|
|
|
2087
|
-
/**
|
|
2088
|
-
* @description This method is used for updating the `billing_address` and `vat_number` attributes of the `customer`. For updating the other customer attributes use [Update Customer API](customers#update_a_customer).
|
|
2089
|
-
|
|
2090
|
-
During this operation, if `billing_address` and `vat_number` are not already present, they're added. Whereas if present, the existing values are replaced with the new values passed. The only exception here is for `entity_identifiers[i]` when `entity_identifiers[operation][i]` is passed as `delete`.
|
|
2091
|
-
|
|
2092
|
-
**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.Please ensure that the VAT number is provided whenever the billing address is updated, as failing to do so will override any existing VAT numbers if new values are not provided.
|
|
2093
|
-
|
|
2094
|
-
*/
|
|
2095
|
-
|
|
2096
1783
|
card?:Card;
|
|
2097
1784
|
}
|
|
2098
1785
|
export interface UpdateBillingInfoInputParam {
|
|
@@ -131,11 +131,6 @@ declare module 'chargebee' {
|
|
|
131
131
|
update(differential_price_id:string, input:UpdateInputParam):ChargebeeRequest<UpdateResponse>;
|
|
132
132
|
}
|
|
133
133
|
export interface DeleteResponse {
|
|
134
|
-
/**
|
|
135
|
-
* @description Delete a differential price using a `differential_price_id` and `item_price_id`.
|
|
136
|
-
|
|
137
|
-
*/
|
|
138
|
-
|
|
139
134
|
differential_price:DifferentialPrice;
|
|
140
135
|
}
|
|
141
136
|
export interface DeleteInputParam {
|
|
@@ -148,11 +143,6 @@ declare module 'chargebee' {
|
|
|
148
143
|
item_price_id:string;
|
|
149
144
|
}
|
|
150
145
|
export interface CreateResponse {
|
|
151
|
-
/**
|
|
152
|
-
* @description Create a differential price for addon item price, addon item price with tiered pricing, or charge item price.
|
|
153
|
-
|
|
154
|
-
*/
|
|
155
|
-
|
|
156
146
|
differential_price:DifferentialPrice;
|
|
157
147
|
}
|
|
158
148
|
export interface CreateInputParam {
|
|
@@ -252,11 +242,6 @@ declare module 'chargebee' {
|
|
|
252
242
|
parent_item_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
253
243
|
}
|
|
254
244
|
export interface RetrieveResponse {
|
|
255
|
-
/**
|
|
256
|
-
* @description Retrieve a differential price using a `differential_price_id` and `item_price_id`.
|
|
257
|
-
|
|
258
|
-
*/
|
|
259
|
-
|
|
260
245
|
differential_price:DifferentialPrice;
|
|
261
246
|
}
|
|
262
247
|
export interface RetrieveInputParam {
|
|
@@ -269,11 +254,6 @@ declare module 'chargebee' {
|
|
|
269
254
|
item_price_id:string;
|
|
270
255
|
}
|
|
271
256
|
export interface UpdateResponse {
|
|
272
|
-
/**
|
|
273
|
-
* @description Update a differential price using a `differential_price_id` and `item_price_id`.
|
|
274
|
-
|
|
275
|
-
*/
|
|
276
|
-
|
|
277
257
|
differential_price:DifferentialPrice;
|
|
278
258
|
}
|
|
279
259
|
export interface UpdateInputParam {
|