class Stripe::CustomersApi

Defined in:

stripe/api/customers_api.cr

Constant Summary

DELETE_CUSTOMERS_CUSTOMER_DISCOUNT_MAX_LENGTH_FOR_CUSTOMER = 5000
DELETE_CUSTOMERS_CUSTOMER_MAX_LENGTH_FOR_CUSTOMER = 5000
DELETE_CUSTOMERS_CUSTOMER_SOURCES_ID_MAX_LENGTH_FOR_CUSTOMER = 5000
DELETE_CUSTOMERS_CUSTOMER_TAX_IDS_ID_MAX_LENGTH_FOR_CUSTOMER = 5000
GET_CUSTOMERS_CUSTOMER_BALANCE_TRANSACTIONS_MAX_LENGTH_FOR_CUSTOMER = 5000
GET_CUSTOMERS_CUSTOMER_BALANCE_TRANSACTIONS_MAX_LENGTH_FOR_ENDING_BEFORE = 5000
GET_CUSTOMERS_CUSTOMER_BALANCE_TRANSACTIONS_MAX_LENGTH_FOR_STARTING_AFTER = 5000
GET_CUSTOMERS_CUSTOMER_BALANCE_TRANSACTIONS_TRANSACTION_MAX_LENGTH_FOR_CUSTOMER = 5000
GET_CUSTOMERS_CUSTOMER_CASH_BALANCE_MAX_LENGTH_FOR_CUSTOMER = 5000
GET_CUSTOMERS_CUSTOMER_CASH_BALANCE_TRANSACTIONS_MAX_LENGTH_FOR_CUSTOMER = 5000
GET_CUSTOMERS_CUSTOMER_CASH_BALANCE_TRANSACTIONS_MAX_LENGTH_FOR_ENDING_BEFORE = 5000
GET_CUSTOMERS_CUSTOMER_CASH_BALANCE_TRANSACTIONS_MAX_LENGTH_FOR_STARTING_AFTER = 5000
GET_CUSTOMERS_CUSTOMER_CASH_BALANCE_TRANSACTIONS_TRANSACTION_MAX_LENGTH_FOR_CUSTOMER = 5000
GET_CUSTOMERS_CUSTOMER_MAX_LENGTH_FOR_CUSTOMER = 5000
GET_CUSTOMERS_CUSTOMER_PAYMENT_METHODS_MAX_LENGTH_FOR_CUSTOMER = 5000
GET_CUSTOMERS_CUSTOMER_PAYMENT_METHODS_PAYMENT_METHOD_MAX_LENGTH_FOR_CUSTOMER = 5000
GET_CUSTOMERS_CUSTOMER_PAYMENT_METHODS_PAYMENT_METHOD_MAX_LENGTH_FOR_PAYMENT_METHOD = 5000
GET_CUSTOMERS_CUSTOMER_PAYMENT_METHODS_VALID_VALUES_FOR__TYPE = String.static_array("acss_debit", "affirm", "afterpay_clearpay", "alipay", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "blik", "boleto", "card", "cashapp", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "klarna", "konbini", "link", "mobilepay", "multibanco", "oxxo", "p24", "paynow", "paypal", "pix", "promptpay", "revolut_pay", "sepa_debit", "sofort", "swish", "twint", "us_bank_account", "wechat_pay", "zip")
GET_CUSTOMERS_CUSTOMER_PAYMENT_METHODS_VALID_VALUES_FOR_ALLOW_REDISPLAY = String.static_array("always", "limited", "unspecified")
GET_CUSTOMERS_CUSTOMER_SOURCES_ID_MAX_LENGTH_FOR_CUSTOMER = 5000
GET_CUSTOMERS_CUSTOMER_SOURCES_ID_MAX_LENGTH_FOR_ID = 500
GET_CUSTOMERS_CUSTOMER_SOURCES_MAX_LENGTH_FOR_CUSTOMER = 5000
GET_CUSTOMERS_CUSTOMER_SOURCES_MAX_LENGTH_FOR_OBJECT = 5000
GET_CUSTOMERS_CUSTOMER_TAX_IDS_ID_MAX_LENGTH_FOR_CUSTOMER = 5000
GET_CUSTOMERS_CUSTOMER_TAX_IDS_MAX_LENGTH_FOR_CUSTOMER = 5000
GET_CUSTOMERS_CUSTOMER_TAX_IDS_MAX_LENGTH_FOR_ENDING_BEFORE = 5000
GET_CUSTOMERS_CUSTOMER_TAX_IDS_MAX_LENGTH_FOR_STARTING_AFTER = 5000
GET_CUSTOMERS_MAX_LENGTH_FOR_EMAIL = 512
GET_CUSTOMERS_MAX_LENGTH_FOR_ENDING_BEFORE = 5000
GET_CUSTOMERS_MAX_LENGTH_FOR_STARTING_AFTER = 5000
GET_CUSTOMERS_MAX_LENGTH_FOR_TEST_CLOCK = 5000
GET_CUSTOMERS_SEARCH_MAX_LENGTH_FOR_PAGE = 5000
GET_CUSTOMERS_SEARCH_MAX_LENGTH_FOR_QUERY = 5000
POST_CUSTOMERS_CUSTOMER_BALANCE_TRANSACTIONS_MAX_LENGTH_FOR_CUSTOMER = 5000
POST_CUSTOMERS_CUSTOMER_BALANCE_TRANSACTIONS_MAX_LENGTH_FOR_DESCRIPTION = 350
POST_CUSTOMERS_CUSTOMER_BALANCE_TRANSACTIONS_TRANSACTION_MAX_LENGTH_FOR_CUSTOMER = 5000
POST_CUSTOMERS_CUSTOMER_BALANCE_TRANSACTIONS_TRANSACTION_MAX_LENGTH_FOR_DESCRIPTION = 350
POST_CUSTOMERS_CUSTOMER_BALANCE_TRANSACTIONS_TRANSACTION_MAX_LENGTH_FOR_TRANSACTION = 5000
POST_CUSTOMERS_CUSTOMER_CASH_BALANCE_MAX_LENGTH_FOR_CUSTOMER = 5000
POST_CUSTOMERS_CUSTOMER_MAX_LENGTH_FOR_COUPON = 5000
POST_CUSTOMERS_CUSTOMER_MAX_LENGTH_FOR_CUSTOMER = 5000
POST_CUSTOMERS_CUSTOMER_MAX_LENGTH_FOR_DEFAULT_SOURCE = 500
POST_CUSTOMERS_CUSTOMER_MAX_LENGTH_FOR_DESCRIPTION = 5000
POST_CUSTOMERS_CUSTOMER_MAX_LENGTH_FOR_EMAIL = 512
POST_CUSTOMERS_CUSTOMER_MAX_LENGTH_FOR_INVOICE_PREFIX = 5000
POST_CUSTOMERS_CUSTOMER_MAX_LENGTH_FOR_NAME = 256
POST_CUSTOMERS_CUSTOMER_MAX_LENGTH_FOR_PHONE = 20
POST_CUSTOMERS_CUSTOMER_MAX_LENGTH_FOR_PROMOTION_CODE = 5000
POST_CUSTOMERS_CUSTOMER_MAX_LENGTH_FOR_SOURCE = 5000
POST_CUSTOMERS_CUSTOMER_SOURCES_ID_MAX_LENGTH_FOR_ACCOUNT_HOLDER_NAME = 5000
POST_CUSTOMERS_CUSTOMER_SOURCES_ID_MAX_LENGTH_FOR_ACCOUNT_HOLDER_TYPE = 5000
POST_CUSTOMERS_CUSTOMER_SOURCES_ID_MAX_LENGTH_FOR_ADDRESS_CITY = 5000
POST_CUSTOMERS_CUSTOMER_SOURCES_ID_MAX_LENGTH_FOR_ADDRESS_COUNTRY = 5000
POST_CUSTOMERS_CUSTOMER_SOURCES_ID_MAX_LENGTH_FOR_ADDRESS_LINE1 = 5000
POST_CUSTOMERS_CUSTOMER_SOURCES_ID_MAX_LENGTH_FOR_ADDRESS_LINE2 = 5000
POST_CUSTOMERS_CUSTOMER_SOURCES_ID_MAX_LENGTH_FOR_ADDRESS_STATE = 5000
POST_CUSTOMERS_CUSTOMER_SOURCES_ID_MAX_LENGTH_FOR_ADDRESS_ZIP = 5000
POST_CUSTOMERS_CUSTOMER_SOURCES_ID_MAX_LENGTH_FOR_CUSTOMER = 5000
POST_CUSTOMERS_CUSTOMER_SOURCES_ID_MAX_LENGTH_FOR_EXP_MONTH = 5000
POST_CUSTOMERS_CUSTOMER_SOURCES_ID_MAX_LENGTH_FOR_EXP_YEAR = 5000
POST_CUSTOMERS_CUSTOMER_SOURCES_ID_MAX_LENGTH_FOR_ID = 5000
POST_CUSTOMERS_CUSTOMER_SOURCES_ID_MAX_LENGTH_FOR_NAME = 5000
POST_CUSTOMERS_CUSTOMER_SOURCES_ID_VALID_VALUES_FOR_ACCOUNT_HOLDER_TYPE = String.static_array("company", "individual")
POST_CUSTOMERS_CUSTOMER_SOURCES_ID_VERIFY_MAX_LENGTH_FOR_CUSTOMER = 5000
POST_CUSTOMERS_CUSTOMER_SOURCES_ID_VERIFY_MAX_LENGTH_FOR_ID = 5000
POST_CUSTOMERS_CUSTOMER_SOURCES_MAX_LENGTH_FOR_CUSTOMER = 5000
POST_CUSTOMERS_CUSTOMER_SOURCES_MAX_LENGTH_FOR_SOURCE = 5000
POST_CUSTOMERS_CUSTOMER_TAX_IDS_MAX_LENGTH_FOR__TYPE = 5000
POST_CUSTOMERS_CUSTOMER_TAX_IDS_MAX_LENGTH_FOR_CUSTOMER = 5000
POST_CUSTOMERS_CUSTOMER_TAX_IDS_VALID_VALUES_FOR__TYPE = String.static_array("ad_nrt", "ae_trn", "ar_cuit", "au_abn", "au_arn", "bg_uic", "bh_vat", "bo_tin", "br_cnpj", "br_cpf", "ca_bn", "ca_gst_hst", "ca_pst_bc", "ca_pst_mb", "ca_pst_sk", "ca_qst", "ch_uid", "ch_vat", "cl_tin", "cn_tin", "co_nit", "cr_tin", "de_stn", "do_rcn", "ec_ruc", "eg_tin", "es_cif", "eu_oss_vat", "eu_vat", "gb_vat", "ge_vat", "hk_br", "hr_oib", "hu_tin", "id_npwp", "il_vat", "in_gst", "is_vat", "jp_cn", "jp_rn", "jp_trn", "ke_pin", "kr_brn", "kz_bin", "li_uid", "mx_rfc", "my_frp", "my_itn", "my_sst", "ng_tin", "no_vat", "no_voec", "nz_gst", "om_vat", "pe_ruc", "ph_tin", "ro_tin", "rs_pib", "ru_inn", "ru_kpp", "sa_vat", "sg_gst", "sg_uen", "si_tin", "sv_nit", "th_vat", "tr_tin", "tw_vat", "ua_vat", "us_ein", "uy_ruc", "ve_rif", "vn_tin", "za_vat")
POST_CUSTOMERS_CUSTOMER_VALID_VALUES_FOR_TAX_EXEMPT = String.static_array("", "exempt", "none", "reverse")
POST_CUSTOMERS_MAX_LENGTH_FOR_COUPON = 5000
POST_CUSTOMERS_MAX_LENGTH_FOR_DESCRIPTION = 5000
POST_CUSTOMERS_MAX_LENGTH_FOR_EMAIL = 512
POST_CUSTOMERS_MAX_LENGTH_FOR_INVOICE_PREFIX = 5000
POST_CUSTOMERS_MAX_LENGTH_FOR_NAME = 256
POST_CUSTOMERS_MAX_LENGTH_FOR_PAYMENT_METHOD = 5000
POST_CUSTOMERS_MAX_LENGTH_FOR_PHONE = 20
POST_CUSTOMERS_MAX_LENGTH_FOR_PROMOTION_CODE = 5000
POST_CUSTOMERS_MAX_LENGTH_FOR_SOURCE = 5000
POST_CUSTOMERS_MAX_LENGTH_FOR_TEST_CLOCK = 5000
POST_CUSTOMERS_VALID_VALUES_FOR_TAX_EXEMPT = String.static_array("", "exempt", "none", "reverse")

Constructors

Instance Method Summary

Constructor Detail

def self.new(api_client : Stripe::ApiClient = ApiClient.default) #

[View source]

Instance Method Detail

def api_client : ApiClient #

[View source]
def api_client=(api_client : ApiClient) #

[View source]
def build_api_request_for_delete_customers_customer(*, customer : String | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_delete_customers_customer_discount(*, customer : String | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_delete_customers_customer_sources_id(*, customer : String | Nil = nil, id : String | Nil = nil, expand : Array(String) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_delete_customers_customer_tax_ids_id(*, customer : String | Nil = nil, id : String | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_get_customers(*, email : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, test_clock : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_get_customers_customer(*, customer : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_get_customers_customer_balance_transactions(*, customer : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_get_customers_customer_balance_transactions_transaction(*, customer : String | Nil = nil, transaction : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_get_customers_customer_cash_balance(*, customer : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_get_customers_customer_cash_balance_transactions(*, customer : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_get_customers_customer_cash_balance_transactions_transaction(*, customer : String | Nil = nil, transaction : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_get_customers_customer_payment_methods(*, customer : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, _type : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, allow_redisplay : String | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_get_customers_customer_payment_methods_payment_method(*, customer : String | Nil = nil, payment_method : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_get_customers_customer_sources(*, customer : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, object : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_get_customers_customer_sources_id(*, customer : String | Nil = nil, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_get_customers_customer_tax_ids(*, customer : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_get_customers_customer_tax_ids_id(*, customer : String | Nil = nil, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_get_customers_search(*, query : String | Nil = nil, page : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_customers(*, address : Stripe::PostCustomersRequestAddress | Nil = nil, balance : Int64 | Nil = nil, cash_balance : Stripe::CashBalanceParam | Nil = nil, coupon : String | Nil = nil, description : String | Nil = nil, email : String | Nil = nil, expand : Array(String) | Nil = nil, invoice_prefix : String | Nil = nil, invoice_settings : Stripe::CustomerParam | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, name : String | Nil = nil, next_invoice_sequence : Int64 | Nil = nil, payment_method : String | Nil = nil, phone : String | Nil = nil, preferred_locales : Array(String) | Nil = nil, promotion_code : String | Nil = nil, shipping : Stripe::PostCustomersRequestShipping | Nil = nil, source : String | Nil = nil, tax : Stripe::TaxParam | Nil = nil, tax_exempt : String | Nil = nil, tax_id_data : Array(Stripe::DataParams) | Nil = nil, test_clock : String | Nil = nil, validate : Bool | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_customers_customer(*, customer : String | Nil = nil, address : Stripe::PostCustomersRequestAddress | Nil = nil, balance : Int64 | Nil = nil, cash_balance : Stripe::CashBalanceParam | Nil = nil, coupon : String | Nil = nil, default_source : String | Nil = nil, description : String | Nil = nil, email : String | Nil = nil, expand : Array(String) | Nil = nil, invoice_prefix : String | Nil = nil, invoice_settings : Stripe::CustomerParam | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, name : String | Nil = nil, next_invoice_sequence : Int64 | Nil = nil, phone : String | Nil = nil, preferred_locales : Array(String) | Nil = nil, promotion_code : String | Nil = nil, shipping : Stripe::PostCustomersRequestShipping | Nil = nil, source : String | Nil = nil, tax : Stripe::TaxParam | Nil = nil, tax_exempt : String | Nil = nil, validate : Bool | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_customers_customer_balance_transactions(*, customer : String | Nil = nil, amount : Int64 | Nil = nil, currency : String | Nil = nil, description : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_customers_customer_balance_transactions_transaction(*, customer : String | Nil = nil, transaction : String | Nil = nil, description : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_customers_customer_cash_balance(*, customer : String | Nil = nil, expand : Array(String) | Nil = nil, settings : Stripe::BalanceSettingsParam | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_customers_customer_sources(*, customer : String | Nil = nil, source : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Hash(String, String) | Nil = nil, validate : Bool | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_customers_customer_sources_id(*, customer : String | Nil = nil, id : String | Nil = nil, account_holder_name : String | Nil = nil, account_holder_type : String | Nil = nil, address_city : String | Nil = nil, address_country : String | Nil = nil, address_line1 : String | Nil = nil, address_line2 : String | Nil = nil, address_state : String | Nil = nil, address_zip : String | Nil = nil, exp_month : String | Nil = nil, exp_year : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, name : String | Nil = nil, owner : Stripe::Owner | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_customers_customer_sources_id_verify(*, customer : String | Nil = nil, id : String | Nil = nil, amounts : Array(Int32) | Nil = nil, expand : Array(String) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_customers_customer_tax_ids(*, customer : String | Nil = nil, _type : String | Nil = nil, value : String | Nil = nil, expand : Array(String) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def client_side_validation?(*args, **options) #

[View source]
def client_side_validation?(*args, **options, &) #

[View source]
def debugging?(*args, **options) #

[View source]
def debugging?(*args, **options, &) #

[View source]
def delete_customers_customer(*, customer : String | Nil = nil) : Stripe::DeletedCustomer #

Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.

@required @param customer [String?] @return [Stripe::DeletedCustomer]

[View source]
def delete_customers_customer(*, customer : String | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.</p> @required @param customer [String?] @return nil


[View source]
def delete_customers_customer_discount(*, customer : String | Nil = nil) : Stripe::DeletedDiscount #

Removes the currently applied discount on a customer.

@required @param customer [String?] @return [Stripe::DeletedDiscount]

[View source]
def delete_customers_customer_discount(*, customer : String | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Removes the currently applied discount on a customer.</p> @required @param customer [String?] @return nil


[View source]
def delete_customers_customer_discount_with_http_info(*, customer : String | Nil = nil) : Tuple(Stripe::DeletedDiscount, Int32, Hash(String, Array(String) | String)) #

<p>Removes the currently applied discount on a customer.</p> @required @param customer [String?] @return [Tuple(Stripe::DeletedDiscount, Integer, Hash)] Stripe::DeletedDiscount, response status code and response headers


[View source]
def delete_customers_customer_sources_id(*, customer : String | Nil = nil, id : String | Nil = nil, expand : Array(String) | Nil = nil) : Stripe::DeleteCustomersCustomerSourcesId200Response #

Delete a specified source for a given customer.

@required @param customer [String?] @required @param id [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Stripe::DeleteCustomersCustomerSourcesId200Response]

[View source]
def delete_customers_customer_sources_id(*, customer : String | Nil = nil, id : String | Nil = nil, expand : Array(String) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Delete a specified source for a given customer.</p> @required @param customer [String?] @required @param id [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return nil


[View source]
def delete_customers_customer_sources_id_with_http_info(*, customer : String | Nil = nil, id : String | Nil = nil, expand : Array(String) | Nil = nil) : Tuple(Stripe::DeleteCustomersCustomerSourcesId200Response, Int32, Hash(String, Array(String) | String)) #

<p>Delete a specified source for a given customer.</p> @required @param customer [String?] @required @param id [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::DeleteCustomersCustomerSourcesId200Response, Integer, Hash)] Stripe::DeleteCustomersCustomerSourcesId200Response, response status code and response headers


[View source]
def delete_customers_customer_tax_ids_id(*, customer : String | Nil = nil, id : String | Nil = nil) : Stripe::DeletedTaxId #

Deletes an existing tax_id object.

@required @param customer [String?] @required @param id [String?] @return [Stripe::DeletedTaxId]

[View source]
def delete_customers_customer_tax_ids_id(*, customer : String | Nil = nil, id : String | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Deletes an existing <code>tax_id</code> object.</p> @required @param customer [String?] @required @param id [String?] @return nil


[View source]
def delete_customers_customer_tax_ids_id_with_http_info(*, customer : String | Nil = nil, id : String | Nil = nil) : Tuple(Stripe::DeletedTaxId, Int32, Hash(String, Array(String) | String)) #

<p>Deletes an existing <code>tax_id</code> object.</p> @required @param customer [String?] @required @param id [String?] @return [Tuple(Stripe::DeletedTaxId, Integer, Hash)] Stripe::DeletedTaxId, response status code and response headers


[View source]
def delete_customers_customer_with_http_info(*, customer : String | Nil = nil) : Tuple(Stripe::DeletedCustomer, Int32, Hash(String, Array(String) | String)) #

<p>Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.</p> @required @param customer [String?] @return [Tuple(Stripe::DeletedCustomer, Integer, Hash)] Stripe::DeletedCustomer, response status code and response headers


[View source]
def get_customers(*, email : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, test_clock : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::CustomerResourceCustomerList #

Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.

@optional @param email [String?] A case-sensitive filter on the list based on the customer's `email` field. The value must be a string. @optional @param ending_before [String?] A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param created [Stripe::GetAccountsCreatedParameter?] Only return customers that were created during the given date interval. @optional @param test_clock [String?] Provides a list of customers that are associated with the specified test clock. The response will not include customers with test clocks if this parameter is not set. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::CustomerResourceCustomerList]

[View source]
def get_customers(*, email : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, test_clock : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.</p> @optional @param email [String?] A case-sensitive filter on the list based on the customer's email field. The value must be a string. @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param created [Stripe::GetAccountsCreatedParameter?] Only return customers that were created during the given date interval. @optional @param test_clock [String?] Provides a list of customers that are associated with the specified test clock. The response will not include customers with test clocks if this parameter is not set. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil


[View source]
def get_customers_customer(*, customer : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::GetCustomersCustomer200Response #

Retrieves a Customer object.

@required @param customer [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::GetCustomersCustomer200Response]

[View source]
def get_customers_customer(*, customer : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Retrieves a Customer object.</p> @required @param customer [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil


[View source]
def get_customers_customer_balance_transactions(*, customer : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::CustomerBalanceTransactionList #

Returns a list of transactions that updated the customer’s balances.

@required @param customer [String?] @optional @param ending_before [String?] A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::CustomerBalanceTransactionList]

[View source]
def get_customers_customer_balance_transactions(*, customer : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Returns a list of transactions that updated the customer’s <a href=&quot;/docs/billing/customer/balance&quot;>balances</a>.</p> @required @param customer [String?] @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil


[View source]
def get_customers_customer_balance_transactions_transaction(*, customer : String | Nil = nil, transaction : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::CustomerBalanceTransaction #

Retrieves a specific customer balance transaction that updated the customer’s balances.

@required @param customer [String?] @required @param transaction [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::CustomerBalanceTransaction]

[View source]
def get_customers_customer_balance_transactions_transaction(*, customer : String | Nil = nil, transaction : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Retrieves a specific customer balance transaction that updated the customer’s <a href=&quot;/docs/billing/customer/balance&quot;>balances</a>.</p> @required @param customer [String?] @required @param transaction [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil


[View source]
def get_customers_customer_balance_transactions_transaction_with_http_info(*, customer : String | Nil = nil, transaction : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::CustomerBalanceTransaction, Int32, Hash(String, Array(String) | String)) #

<p>Retrieves a specific customer balance transaction that updated the customer’s <a href=&quot;/docs/billing/customer/balance&quot;>balances</a>.</p> @required @param customer [String?] @required @param transaction [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::CustomerBalanceTransaction, Integer, Hash)] Stripe::CustomerBalanceTransaction, response status code and response headers


[View source]
def get_customers_customer_balance_transactions_with_http_info(*, customer : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::CustomerBalanceTransactionList, Int32, Hash(String, Array(String) | String)) #

<p>Returns a list of transactions that updated the customer’s <a href=&quot;/docs/billing/customer/balance&quot;>balances</a>.</p> @required @param customer [String?] @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::CustomerBalanceTransactionList, Integer, Hash)] Stripe::CustomerBalanceTransactionList, response status code and response headers


[View source]
def get_customers_customer_cash_balance(*, customer : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::CashBalance #

Retrieves a customer’s cash balance.

@required @param customer [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::CashBalance]

[View source]
def get_customers_customer_cash_balance(*, customer : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Retrieves a customer’s cash balance.</p> @required @param customer [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil


[View source]
def get_customers_customer_cash_balance_transactions(*, customer : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::CustomerCashBalanceTransactionList #

Returns a list of transactions that modified the customer’s cash balance.

@required @param customer [String?] @optional @param ending_before [String?] A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::CustomerCashBalanceTransactionList]

[View source]
def get_customers_customer_cash_balance_transactions(*, customer : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Returns a list of transactions that modified the customer’s <a href=&quot;/docs/payments/customer-balance&quot;>cash balance</a>.</p> @required @param customer [String?] @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil


[View source]
def get_customers_customer_cash_balance_transactions_transaction(*, customer : String | Nil = nil, transaction : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::CustomerCashBalanceTransaction #

Retrieves a specific cash balance transaction, which updated the customer’s cash balance.

@required @param customer [String?] @required @param transaction [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::CustomerCashBalanceTransaction]

[View source]
def get_customers_customer_cash_balance_transactions_transaction(*, customer : String | Nil = nil, transaction : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Retrieves a specific cash balance transaction, which updated the customer’s <a href=&quot;/docs/payments/customer-balance&quot;>cash balance</a>.</p> @required @param customer [String?] @required @param transaction [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil


[View source]
def get_customers_customer_cash_balance_transactions_transaction_with_http_info(*, customer : String | Nil = nil, transaction : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::CustomerCashBalanceTransaction, Int32, Hash(String, Array(String) | String)) #

<p>Retrieves a specific cash balance transaction, which updated the customer’s <a href=&quot;/docs/payments/customer-balance&quot;>cash balance</a>.</p> @required @param customer [String?] @required @param transaction [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::CustomerCashBalanceTransaction, Integer, Hash)] Stripe::CustomerCashBalanceTransaction, response status code and response headers


[View source]
def get_customers_customer_cash_balance_transactions_with_http_info(*, customer : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::CustomerCashBalanceTransactionList, Int32, Hash(String, Array(String) | String)) #

<p>Returns a list of transactions that modified the customer’s <a href=&quot;/docs/payments/customer-balance&quot;>cash balance</a>.</p> @required @param customer [String?] @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::CustomerCashBalanceTransactionList, Integer, Hash)] Stripe::CustomerCashBalanceTransactionList, response status code and response headers


[View source]
def get_customers_customer_cash_balance_with_http_info(*, customer : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::CashBalance, Int32, Hash(String, Array(String) | String)) #

<p>Retrieves a customer’s cash balance.</p> @required @param customer [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::CashBalance, Integer, Hash)] Stripe::CashBalance, response status code and response headers


[View source]
def get_customers_customer_payment_methods(*, customer : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, _type : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, allow_redisplay : String | Nil = nil) : Stripe::CustomerPaymentMethodResourceList #

Returns a list of PaymentMethods for a given Customer

@required @param customer [String?] @optional @param ending_before [String?] A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param _type [String?] An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @optional @param allow_redisplay [String?] This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`. @return [Stripe::CustomerPaymentMethodResourceList]

[View source]
def get_customers_customer_payment_methods(*, customer : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, _type : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, allow_redisplay : String | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Returns a list of PaymentMethods for a given Customer</p> @required @param customer [String?] @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param _type [String?] An optional filter on the list, based on the object type field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @optional @param allow_redisplay [String?] This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to unspecified. @return nil


[View source]
def get_customers_customer_payment_methods_payment_method(*, customer : String | Nil = nil, payment_method : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::PaymentMethod #

Retrieves a PaymentMethod object for a given Customer.

@required @param customer [String?] @required @param payment_method [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::PaymentMethod]

[View source]
def get_customers_customer_payment_methods_payment_method(*, customer : String | Nil = nil, payment_method : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Retrieves a PaymentMethod object for a given Customer.</p> @required @param customer [String?] @required @param payment_method [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil


[View source]
def get_customers_customer_payment_methods_payment_method_with_http_info(*, customer : String | Nil = nil, payment_method : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::PaymentMethod, Int32, Hash(String, Array(String) | String)) #

<p>Retrieves a PaymentMethod object for a given Customer.</p> @required @param customer [String?] @required @param payment_method [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::PaymentMethod, Integer, Hash)] Stripe::PaymentMethod, response status code and response headers


[View source]
def get_customers_customer_payment_methods_with_http_info(*, customer : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, _type : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, allow_redisplay : String | Nil = nil) : Tuple(Stripe::CustomerPaymentMethodResourceList, Int32, Hash(String, Array(String) | String)) #

<p>Returns a list of PaymentMethods for a given Customer</p> @required @param customer [String?] @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param _type [String?] An optional filter on the list, based on the object type field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @optional @param allow_redisplay [String?] This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to unspecified. @return [Tuple(Stripe::CustomerPaymentMethodResourceList, Integer, Hash)] Stripe::CustomerPaymentMethodResourceList, response status code and response headers


[View source]
def get_customers_customer_sources(*, customer : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, object : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::ApmsSourcesSourceList #

List sources for a specified customer.

@required @param customer [String?] @optional @param ending_before [String?] A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param object [String?] Filter sources according to a particular object type. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::ApmsSourcesSourceList]

[View source]
def get_customers_customer_sources(*, customer : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, object : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>List sources for a specified customer.</p> @required @param customer [String?] @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param object [String?] Filter sources according to a particular object type. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil


[View source]
def get_customers_customer_sources_id(*, customer : String | Nil = nil, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::PaymentSource #

Retrieve a specified source for a given customer.

@required @param customer [String?] @required @param id [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::PaymentSource]

[View source]
def get_customers_customer_sources_id(*, customer : String | Nil = nil, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Retrieve a specified source for a given customer.</p> @required @param customer [String?] @required @param id [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil


[View source]
def get_customers_customer_sources_id_with_http_info(*, customer : String | Nil = nil, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::PaymentSource, Int32, Hash(String, Array(String) | String)) #

<p>Retrieve a specified source for a given customer.</p> @required @param customer [String?] @required @param id [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::PaymentSource, Integer, Hash)] Stripe::PaymentSource, response status code and response headers


[View source]
def get_customers_customer_sources_with_http_info(*, customer : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, object : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::ApmsSourcesSourceList, Int32, Hash(String, Array(String) | String)) #

<p>List sources for a specified customer.</p> @required @param customer [String?] @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param object [String?] Filter sources according to a particular object type. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::ApmsSourcesSourceList, Integer, Hash)] Stripe::ApmsSourcesSourceList, response status code and response headers


[View source]
def get_customers_customer_tax_ids(*, customer : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::TaxIDsList #

Returns a list of tax IDs for a customer.

@required @param customer [String?] @optional @param ending_before [String?] A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::TaxIDsList]

[View source]
def get_customers_customer_tax_ids(*, customer : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Returns a list of tax IDs for a customer.</p> @required @param customer [String?] @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil


[View source]
def get_customers_customer_tax_ids_id(*, customer : String | Nil = nil, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::TaxId #

Retrieves the tax_id object with the given identifier.

@required @param customer [String?] @required @param id [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::TaxId]

[View source]
def get_customers_customer_tax_ids_id(*, customer : String | Nil = nil, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Retrieves the <code>tax_id</code> object with the given identifier.</p> @required @param customer [String?] @required @param id [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil


[View source]
def get_customers_customer_tax_ids_id_with_http_info(*, customer : String | Nil = nil, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::TaxId, Int32, Hash(String, Array(String) | String)) #

<p>Retrieves the <code>tax_id</code> object with the given identifier.</p> @required @param customer [String?] @required @param id [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::TaxId, Integer, Hash)] Stripe::TaxId, response status code and response headers


[View source]
def get_customers_customer_tax_ids_with_http_info(*, customer : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::TaxIDsList, Int32, Hash(String, Array(String) | String)) #

<p>Returns a list of tax IDs for a customer.</p> @required @param customer [String?] @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::TaxIDsList, Integer, Hash)] Stripe::TaxIDsList, response status code and response headers


[View source]
def get_customers_customer_with_http_info(*, customer : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::GetCustomersCustomer200Response, Int32, Hash(String, Array(String) | String)) #

<p>Retrieves a Customer object.</p> @required @param customer [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::GetCustomersCustomer200Response, Integer, Hash)] Stripe::GetCustomersCustomer200Response, response status code and response headers


[View source]
def get_customers_search(*, query : String | Nil = nil, page : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::SearchResult #

Search for customers you’ve previously created using Stripe’s Search Query Language. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.

@required @param query [String?] The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for customers](https://stripe.com/docs/search#query-fields-for-customers). @optional @param page [String?] A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::SearchResult]

[View source]
def get_customers_search(*, query : String | Nil = nil, page : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Search for customers you’ve previously created using Stripe’s <a href=&quot;/docs/search#search-query-language&quot;>Search Query Language</a>. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.</p> @required @param query [String?] The search query string. See search query language and the list of supported query fields for customers. @optional @param page [String?] A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil


[View source]
def get_customers_search_with_http_info(*, query : String | Nil = nil, page : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::SearchResult, Int32, Hash(String, Array(String) | String)) #

<p>Search for customers you’ve previously created using Stripe’s <a href=&quot;/docs/search#search-query-language&quot;>Search Query Language</a>. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.</p> @required @param query [String?] The search query string. See search query language and the list of supported query fields for customers. @optional @param page [String?] A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::SearchResult, Integer, Hash)] Stripe::SearchResult, response status code and response headers


[View source]
def get_customers_with_http_info(*, email : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, test_clock : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::CustomerResourceCustomerList, Int32, Hash(String, Array(String) | String)) #

<p>Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.</p> @optional @param email [String?] A case-sensitive filter on the list based on the customer's email field. The value must be a string. @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param created [Stripe::GetAccountsCreatedParameter?] Only return customers that were created during the given date interval. @optional @param test_clock [String?] Provides a list of customers that are associated with the specified test clock. The response will not include customers with test clocks if this parameter is not set. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::CustomerResourceCustomerList, Integer, Hash)] Stripe::CustomerResourceCustomerList, response status code and response headers


[View source]
def post_customers(*, address : Stripe::PostCustomersRequestAddress | Nil = nil, balance : Int64 | Nil = nil, cash_balance : Stripe::CashBalanceParam | Nil = nil, coupon : String | Nil = nil, description : String | Nil = nil, email : String | Nil = nil, expand : Array(String) | Nil = nil, invoice_prefix : String | Nil = nil, invoice_settings : Stripe::CustomerParam | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, name : String | Nil = nil, next_invoice_sequence : Int64 | Nil = nil, payment_method : String | Nil = nil, phone : String | Nil = nil, preferred_locales : Array(String) | Nil = nil, promotion_code : String | Nil = nil, shipping : Stripe::PostCustomersRequestShipping | Nil = nil, source : String | Nil = nil, tax : Stripe::TaxParam | Nil = nil, tax_exempt : String | Nil = nil, tax_id_data : Array(Stripe::DataParams) | Nil = nil, test_clock : String | Nil = nil, validate : Bool | Nil = nil) : Stripe::Customer #

Creates a new customer object.

@optional @param address [Stripe::PostCustomersRequestAddress?] @optional @param balance [Int32?] An integer amount in cents (or local equivalent) that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice. @optional @param cash_balance [Stripe::CashBalanceParam?] @optional @param coupon [String?] @optional @param description [String?] An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard. @optional @param email [String?] Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param invoice_prefix [String?] The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers. @optional @param invoice_settings [Stripe::CustomerParam?] @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @optional @param name [String?] The customer's full name or business name. @optional @param next_invoice_sequence [Int32?] The sequence to be used on the customer's next invoice. Defaults to 1. @optional @param payment_method [String?] @optional @param phone [String?] The customer's phone number. @optional @param preferred_locales [Array(String)?] Customer's preferred languages, ordered by preference. @optional @param promotion_code [String?] The ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount. @optional @param shipping [Stripe::PostCustomersRequestShipping?] @optional @param source [String?] @optional @param tax [Stripe::TaxParam?] @optional @param tax_exempt [String?] The customer's tax exemption. One of `none`, `exempt`, or `reverse`. @optional @param tax_id_data [Array(Stripe::DataParams)?] The customer's tax IDs. @optional @param test_clock [String?] ID of the test clock to attach to the customer. @optional @param validate [Bool?] @return [Stripe::Customer]

[View source]
def post_customers(*, address : Stripe::PostCustomersRequestAddress | Nil = nil, balance : Int64 | Nil = nil, cash_balance : Stripe::CashBalanceParam | Nil = nil, coupon : String | Nil = nil, description : String | Nil = nil, email : String | Nil = nil, expand : Array(String) | Nil = nil, invoice_prefix : String | Nil = nil, invoice_settings : Stripe::CustomerParam | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, name : String | Nil = nil, next_invoice_sequence : Int64 | Nil = nil, payment_method : String | Nil = nil, phone : String | Nil = nil, preferred_locales : Array(String) | Nil = nil, promotion_code : String | Nil = nil, shipping : Stripe::PostCustomersRequestShipping | Nil = nil, source : String | Nil = nil, tax : Stripe::TaxParam | Nil = nil, tax_exempt : String | Nil = nil, tax_id_data : Array(Stripe::DataParams) | Nil = nil, test_clock : String | Nil = nil, validate : Bool | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Creates a new customer object.</p> @optional @param address [Stripe::PostCustomersRequestAddress?] @optional @param balance [Int32?] An integer amount in cents (or local equivalent) that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice. @optional @param cash_balance [Stripe::CashBalanceParam?] @optional @param coupon [String?] @optional @param description [String?] An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard. @optional @param email [String?] Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to 512 characters. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param invoice_prefix [String?] The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers. @optional @param invoice_settings [Stripe::CustomerParam?] @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @optional @param name [String?] The customer's full name or business name. @optional @param next_invoice_sequence [Int32?] The sequence to be used on the customer's next invoice. Defaults to 1. @optional @param payment_method [String?] @optional @param phone [String?] The customer's phone number. @optional @param preferred_locales [Array(String)?] Customer's preferred languages, ordered by preference. @optional @param promotion_code [String?] The ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount. @optional @param shipping [Stripe::PostCustomersRequestShipping?] @optional @param source [String?] @optional @param tax [Stripe::TaxParam?] @optional @param tax_exempt [String?] The customer's tax exemption. One of none, exempt, or reverse. @optional @param tax_id_data [Array(Stripe::DataParams)?] The customer's tax IDs. @optional @param test_clock [String?] ID of the test clock to attach to the customer. @optional @param validate [Bool?] @return nil


[View source]
def post_customers_customer(*, customer : String | Nil = nil, address : Stripe::PostCustomersRequestAddress | Nil = nil, balance : Int64 | Nil = nil, cash_balance : Stripe::CashBalanceParam | Nil = nil, coupon : String | Nil = nil, default_source : String | Nil = nil, description : String | Nil = nil, email : String | Nil = nil, expand : Array(String) | Nil = nil, invoice_prefix : String | Nil = nil, invoice_settings : Stripe::CustomerParam | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, name : String | Nil = nil, next_invoice_sequence : Int64 | Nil = nil, phone : String | Nil = nil, preferred_locales : Array(String) | Nil = nil, promotion_code : String | Nil = nil, shipping : Stripe::PostCustomersRequestShipping | Nil = nil, source : String | Nil = nil, tax : Stripe::TaxParam | Nil = nil, tax_exempt : String | Nil = nil, validate : Bool | Nil = nil) : Stripe::Customer #

Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the source parameter, that becomes the customer’s active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the source parameter: for each of the customer’s current subscriptions, if the subscription bills automatically and is in the past_due state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer will not trigger this behavior.

This request accepts mostly the same arguments as the customer creation call.

@required @param customer [String?] @optional @param address [Stripe::PostCustomersRequestAddress?] @optional @param balance [Int32?] An integer amount in cents (or local equivalent) that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice. @optional @param cash_balance [Stripe::CashBalanceParam?] @optional @param coupon [String?] @optional @param default_source [String?] If you are using payment methods created via the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method) parameter. Provide the ID of a payment source already attached to this customer to make it this customer's default payment source. If you want to add a new payment source and make it the default, see the [source](https://stripe.com/docs/api/customers/update#update_customer-source) property. @optional @param description [String?] An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard. @optional @param email [String?] Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param invoice_prefix [String?] The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers. @optional @param invoice_settings [Stripe::CustomerParam?] @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @optional @param name [String?] The customer's full name or business name. @optional @param next_invoice_sequence [Int32?] The sequence to be used on the customer's next invoice. Defaults to 1. @optional @param phone [String?] The customer's phone number. @optional @param preferred_locales [Array(String)?] Customer's preferred languages, ordered by preference. @optional @param promotion_code [String?] The ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount. @optional @param shipping [Stripe::PostCustomersRequestShipping?] @optional @param source [String?] @optional @param tax [Stripe::TaxParam?] @optional @param tax_exempt [String?] The customer's tax exemption. One of `none`, `exempt`, or `reverse`. @optional @param validate [Bool?] @return [Stripe::Customer]

[View source]
def post_customers_customer(*, customer : String | Nil = nil, address : Stripe::PostCustomersRequestAddress | Nil = nil, balance : Int64 | Nil = nil, cash_balance : Stripe::CashBalanceParam | Nil = nil, coupon : String | Nil = nil, default_source : String | Nil = nil, description : String | Nil = nil, email : String | Nil = nil, expand : Array(String) | Nil = nil, invoice_prefix : String | Nil = nil, invoice_settings : Stripe::CustomerParam | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, name : String | Nil = nil, next_invoice_sequence : Int64 | Nil = nil, phone : String | Nil = nil, preferred_locales : Array(String) | Nil = nil, promotion_code : String | Nil = nil, shipping : Stripe::PostCustomersRequestShipping | Nil = nil, source : String | Nil = nil, tax : Stripe::TaxParam | Nil = nil, tax_exempt : String | Nil = nil, validate : Bool | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the <strong>source</strong> parameter, that becomes the customer’s active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the <strong>source</strong> parameter: for each of the customer’s current subscriptions, if the subscription bills automatically and is in the <code>past_due</code> state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the <strong>default_source</strong> for a customer will not trigger this behavior.</p> <p>This request accepts mostly the same arguments as the customer creation call.</p> @required @param customer [String?] @optional @param address [Stripe::PostCustomersRequestAddress?] @optional @param balance [Int32?] An integer amount in cents (or local equivalent) that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice. @optional @param cash_balance [Stripe::CashBalanceParam?] @optional @param coupon [String?] @optional @param default_source [String?] If you are using payment methods created via the PaymentMethods API, see the invoice_settings.default_payment_method parameter. Provide the ID of a payment source already attached to this customer to make it this customer's default payment source. If you want to add a new payment source and make it the default, see the source property. @optional @param description [String?] An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard. @optional @param email [String?] Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to 512 characters. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param invoice_prefix [String?] The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers. @optional @param invoice_settings [Stripe::CustomerParam?] @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @optional @param name [String?] The customer's full name or business name. @optional @param next_invoice_sequence [Int32?] The sequence to be used on the customer's next invoice. Defaults to 1. @optional @param phone [String?] The customer's phone number. @optional @param preferred_locales [Array(String)?] Customer's preferred languages, ordered by preference. @optional @param promotion_code [String?] The ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount. @optional @param shipping [Stripe::PostCustomersRequestShipping?] @optional @param source [String?] @optional @param tax [Stripe::TaxParam?] @optional @param tax_exempt [String?] The customer's tax exemption. One of none, exempt, or reverse. @optional @param validate [Bool?] @return nil


[View source]
def post_customers_customer_balance_transactions(*, customer : String | Nil = nil, amount : Int64 | Nil = nil, currency : String | Nil = nil, description : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil) : Stripe::CustomerBalanceTransaction #

Creates an immutable transaction that updates the customer’s credit balance.

@required @param customer [String?] @required @param amount [Int32?] The integer amount in **cents (or local equivalent)** to apply to the customer's credit balance. @required @param currency [String?] Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Specifies the [`invoice_credit_balance`](https://stripe.com/docs/api/customers/object#customer_object-invoice_credit_balance) that this transaction will apply to. If the customer's `currency` is not set, it will be updated to this value. @optional @param description [String?] An arbitrary string attached to the object. Often useful for displaying to users. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @return [Stripe::CustomerBalanceTransaction]

[View source]
def post_customers_customer_balance_transactions(*, customer : String | Nil = nil, amount : Int64 | Nil = nil, currency : String | Nil = nil, description : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Creates an immutable transaction that updates the customer’s credit <a href=&quot;/docs/billing/customer/balance&quot;>balance</a>.</p> @required @param customer [String?] @required @param amount [Int32?] The integer amount in cents (or local equivalent) to apply to the customer's credit balance. @required @param currency [String?] Three-letter ISO currency code, in lowercase. Must be a supported currency. Specifies the invoice_credit_balance that this transaction will apply to. If the customer's currency is not set, it will be updated to this value. @optional @param description [String?] An arbitrary string attached to the object. Often useful for displaying to users. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @return nil


[View source]
def post_customers_customer_balance_transactions_transaction(*, customer : String | Nil = nil, transaction : String | Nil = nil, description : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil) : Stripe::CustomerBalanceTransaction #

Most credit balance transaction fields are immutable, but you may update its description and metadata.

@required @param customer [String?] @required @param transaction [String?] @optional @param description [String?] An arbitrary string attached to the object. Often useful for displaying to users. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @return [Stripe::CustomerBalanceTransaction]

[View source]
def post_customers_customer_balance_transactions_transaction(*, customer : String | Nil = nil, transaction : String | Nil = nil, description : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Most credit balance transaction fields are immutable, but you may update its <code>description</code> and <code>metadata</code>.</p> @required @param customer [String?] @required @param transaction [String?] @optional @param description [String?] An arbitrary string attached to the object. Often useful for displaying to users. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @return nil


[View source]
def post_customers_customer_balance_transactions_transaction_with_http_info(*, customer : String | Nil = nil, transaction : String | Nil = nil, description : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil) : Tuple(Stripe::CustomerBalanceTransaction, Int32, Hash(String, Array(String) | String)) #

<p>Most credit balance transaction fields are immutable, but you may update its <code>description</code> and <code>metadata</code>.</p> @required @param customer [String?] @required @param transaction [String?] @optional @param description [String?] An arbitrary string attached to the object. Often useful for displaying to users. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @return [Tuple(Stripe::CustomerBalanceTransaction, Integer, Hash)] Stripe::CustomerBalanceTransaction, response status code and response headers


[View source]
def post_customers_customer_balance_transactions_with_http_info(*, customer : String | Nil = nil, amount : Int64 | Nil = nil, currency : String | Nil = nil, description : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil) : Tuple(Stripe::CustomerBalanceTransaction, Int32, Hash(String, Array(String) | String)) #

<p>Creates an immutable transaction that updates the customer’s credit <a href=&quot;/docs/billing/customer/balance&quot;>balance</a>.</p> @required @param customer [String?] @required @param amount [Int32?] The integer amount in cents (or local equivalent) to apply to the customer's credit balance. @required @param currency [String?] Three-letter ISO currency code, in lowercase. Must be a supported currency. Specifies the invoice_credit_balance that this transaction will apply to. If the customer's currency is not set, it will be updated to this value. @optional @param description [String?] An arbitrary string attached to the object. Often useful for displaying to users. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @return [Tuple(Stripe::CustomerBalanceTransaction, Integer, Hash)] Stripe::CustomerBalanceTransaction, response status code and response headers


[View source]
def post_customers_customer_cash_balance(*, customer : String | Nil = nil, expand : Array(String) | Nil = nil, settings : Stripe::BalanceSettingsParam | Nil = nil) : Stripe::CashBalance #

Changes the settings on a customer’s cash balance.

@required @param customer [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param settings [Stripe::BalanceSettingsParam?] @return [Stripe::CashBalance]

[View source]
def post_customers_customer_cash_balance(*, customer : String | Nil = nil, expand : Array(String) | Nil = nil, settings : Stripe::BalanceSettingsParam | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Changes the settings on a customer’s cash balance.</p> @required @param customer [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param settings [Stripe::BalanceSettingsParam?] @return nil


[View source]
def post_customers_customer_cash_balance_with_http_info(*, customer : String | Nil = nil, expand : Array(String) | Nil = nil, settings : Stripe::BalanceSettingsParam | Nil = nil) : Tuple(Stripe::CashBalance, Int32, Hash(String, Array(String) | String)) #

<p>Changes the settings on a customer’s cash balance.</p> @required @param customer [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param settings [Stripe::BalanceSettingsParam?] @return [Tuple(Stripe::CashBalance, Integer, Hash)] Stripe::CashBalance, response status code and response headers


[View source]
def post_customers_customer_sources(*, customer : String | Nil = nil, source : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Hash(String, String) | Nil = nil, validate : Bool | Nil = nil) : Stripe::PaymentSource #

When you create a new credit card, you must specify a customer or recipient on which to create it.

If the card’s owner has no default card, then the new card will become the default. However, if the owner already has a default, then it will not change. To change the default, you should update the customer to have a new default_source.

@required @param customer [String?] @required @param source [String?] Please refer to full [documentation](https://stripe.com/docs/api) instead. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Hash(String, String)?] @optional @param validate [Bool?] @return [Stripe::PaymentSource]

[View source]
def post_customers_customer_sources(*, customer : String | Nil = nil, source : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Hash(String, String) | Nil = nil, validate : Bool | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>When you create a new credit card, you must specify a customer or recipient on which to create it.</p> <p>If the card’s owner has no default card, then the new card will become the default. However, if the owner already has a default, then it will not change. To change the default, you should <a href=&quot;/docs/api#update_customer&quot;>update the customer</a> to have a new <code>default_source</code>.</p> @required @param customer [String?] @required @param source [String?] Please refer to full documentation instead. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Hash(String, String)?] @optional @param validate [Bool?] @return nil


[View source]
def post_customers_customer_sources_id(*, customer : String | Nil = nil, id : String | Nil = nil, account_holder_name : String | Nil = nil, account_holder_type : String | Nil = nil, address_city : String | Nil = nil, address_country : String | Nil = nil, address_line1 : String | Nil = nil, address_line2 : String | Nil = nil, address_state : String | Nil = nil, address_zip : String | Nil = nil, exp_month : String | Nil = nil, exp_year : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, name : String | Nil = nil, owner : Stripe::Owner | Nil = nil) : Stripe::PostCustomersCustomerSourcesId200Response #

Update a specified source for a given customer.

@required @param customer [String?] @required @param id [String?] @optional @param account_holder_name [String?] The name of the person or business that owns the bank account. @optional @param account_holder_type [String?] The type of entity that holds the account. This can be either `individual` or `company`. @optional @param address_city [String?] City/District/Suburb/Town/Village. @optional @param address_country [String?] Billing address country, if provided when creating card. @optional @param address_line1 [String?] Address line 1 (Street address/PO Box/Company name). @optional @param address_line2 [String?] Address line 2 (Apartment/Suite/Unit/Building). @optional @param address_state [String?] State/County/Province/Region. @optional @param address_zip [String?] ZIP or postal code. @optional @param exp_month [String?] Two digit number representing the card’s expiration month. @optional @param exp_year [String?] Four digit number representing the card’s expiration year. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @optional @param name [String?] Cardholder name. @optional @param owner [Stripe::Owner?] @return [Stripe::PostCustomersCustomerSourcesId200Response]

[View source]
def post_customers_customer_sources_id(*, customer : String | Nil = nil, id : String | Nil = nil, account_holder_name : String | Nil = nil, account_holder_type : String | Nil = nil, address_city : String | Nil = nil, address_country : String | Nil = nil, address_line1 : String | Nil = nil, address_line2 : String | Nil = nil, address_state : String | Nil = nil, address_zip : String | Nil = nil, exp_month : String | Nil = nil, exp_year : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, name : String | Nil = nil, owner : Stripe::Owner | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Update a specified source for a given customer.</p> @required @param customer [String?] @required @param id [String?] @optional @param account_holder_name [String?] The name of the person or business that owns the bank account. @optional @param account_holder_type [String?] The type of entity that holds the account. This can be either individual or company. @optional @param address_city [String?] City/District/Suburb/Town/Village. @optional @param address_country [String?] Billing address country, if provided when creating card. @optional @param address_line1 [String?] Address line 1 (Street address/PO Box/Company name). @optional @param address_line2 [String?] Address line 2 (Apartment/Suite/Unit/Building). @optional @param address_state [String?] State/County/Province/Region. @optional @param address_zip [String?] ZIP or postal code. @optional @param exp_month [String?] Two digit number representing the card’s expiration month. @optional @param exp_year [String?] Four digit number representing the card’s expiration year. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @optional @param name [String?] Cardholder name. @optional @param owner [Stripe::Owner?] @return nil


[View source]
def post_customers_customer_sources_id_verify(*, customer : String | Nil = nil, id : String | Nil = nil, amounts : Array(Int32) | Nil = nil, expand : Array(String) | Nil = nil) : Stripe::BankAccount #

Verify a specified bank account for a given customer.

@required @param customer [String?] @required @param id [String?] @optional @param amounts [Array(Int32)?] Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Stripe::BankAccount]

[View source]
def post_customers_customer_sources_id_verify(*, customer : String | Nil = nil, id : String | Nil = nil, amounts : Array(Int32) | Nil = nil, expand : Array(String) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Verify a specified bank account for a given customer.</p> @required @param customer [String?] @required @param id [String?] @optional @param amounts [Array(Int32)?] Two positive integers, in cents, equal to the values of the microdeposits sent to the bank account. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return nil


[View source]
def post_customers_customer_sources_id_verify_with_http_info(*, customer : String | Nil = nil, id : String | Nil = nil, amounts : Array(Int32) | Nil = nil, expand : Array(String) | Nil = nil) : Tuple(Stripe::BankAccount, Int32, Hash(String, Array(String) | String)) #

<p>Verify a specified bank account for a given customer.</p> @required @param customer [String?] @required @param id [String?] @optional @param amounts [Array(Int32)?] Two positive integers, in cents, equal to the values of the microdeposits sent to the bank account. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::BankAccount, Integer, Hash)] Stripe::BankAccount, response status code and response headers


[View source]
def post_customers_customer_sources_id_with_http_info(*, customer : String | Nil = nil, id : String | Nil = nil, account_holder_name : String | Nil = nil, account_holder_type : String | Nil = nil, address_city : String | Nil = nil, address_country : String | Nil = nil, address_line1 : String | Nil = nil, address_line2 : String | Nil = nil, address_state : String | Nil = nil, address_zip : String | Nil = nil, exp_month : String | Nil = nil, exp_year : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, name : String | Nil = nil, owner : Stripe::Owner | Nil = nil) : Tuple(Stripe::PostCustomersCustomerSourcesId200Response, Int32, Hash(String, Array(String) | String)) #

<p>Update a specified source for a given customer.</p> @required @param customer [String?] @required @param id [String?] @optional @param account_holder_name [String?] The name of the person or business that owns the bank account. @optional @param account_holder_type [String?] The type of entity that holds the account. This can be either individual or company. @optional @param address_city [String?] City/District/Suburb/Town/Village. @optional @param address_country [String?] Billing address country, if provided when creating card. @optional @param address_line1 [String?] Address line 1 (Street address/PO Box/Company name). @optional @param address_line2 [String?] Address line 2 (Apartment/Suite/Unit/Building). @optional @param address_state [String?] State/County/Province/Region. @optional @param address_zip [String?] ZIP or postal code. @optional @param exp_month [String?] Two digit number representing the card’s expiration month. @optional @param exp_year [String?] Four digit number representing the card’s expiration year. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @optional @param name [String?] Cardholder name. @optional @param owner [Stripe::Owner?] @return [Tuple(Stripe::PostCustomersCustomerSourcesId200Response, Integer, Hash)] Stripe::PostCustomersCustomerSourcesId200Response, response status code and response headers


[View source]
def post_customers_customer_sources_with_http_info(*, customer : String | Nil = nil, source : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Hash(String, String) | Nil = nil, validate : Bool | Nil = nil) : Tuple(Stripe::PaymentSource, Int32, Hash(String, Array(String) | String)) #

<p>When you create a new credit card, you must specify a customer or recipient on which to create it.</p> <p>If the card’s owner has no default card, then the new card will become the default. However, if the owner already has a default, then it will not change. To change the default, you should <a href=&quot;/docs/api#update_customer&quot;>update the customer</a> to have a new <code>default_source</code>.</p> @required @param customer [String?] @required @param source [String?] Please refer to full documentation instead. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Hash(String, String)?] @optional @param validate [Bool?] @return [Tuple(Stripe::PaymentSource, Integer, Hash)] Stripe::PaymentSource, response status code and response headers


[View source]
def post_customers_customer_tax_ids(*, customer : String | Nil = nil, _type : String | Nil = nil, value : String | Nil = nil, expand : Array(String) | Nil = nil) : Stripe::TaxId #

Creates a new tax_id object for a customer.

@required @param customer [String?] @required @param _type [String?] Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat` @required @param value [String?] Value of the tax ID. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Stripe::TaxId]

[View source]
def post_customers_customer_tax_ids(*, customer : String | Nil = nil, _type : String | Nil = nil, value : String | Nil = nil, expand : Array(String) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Creates a new <code>tax_id</code> object for a customer.</p> @required @param customer [String?] @required @param _type [String?] Type of the tax ID, one of ad_nrt, ae_trn, ar_cuit, au_abn, au_arn, bg_uic, bh_vat, bo_tin, br_cnpj, br_cpf, ca_bn, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, ca_qst, ch_uid, ch_vat, cl_tin, cn_tin, co_nit, cr_tin, de_stn, do_rcn, ec_ruc, eg_tin, es_cif, eu_oss_vat, eu_vat, gb_vat, ge_vat, hk_br, hr_oib, hu_tin, id_npwp, il_vat, in_gst, is_vat, jp_cn, jp_rn, jp_trn, ke_pin, kr_brn, kz_bin, li_uid, mx_rfc, my_frp, my_itn, my_sst, ng_tin, no_vat, no_voec, nz_gst, om_vat, pe_ruc, ph_tin, ro_tin, rs_pib, ru_inn, ru_kpp, sa_vat, sg_gst, sg_uen, si_tin, sv_nit, th_vat, tr_tin, tw_vat, ua_vat, us_ein, uy_ruc, ve_rif, vn_tin, or za_vat @required @param value [String?] Value of the tax ID. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return nil


[View source]
def post_customers_customer_tax_ids_with_http_info(*, customer : String | Nil = nil, _type : String | Nil = nil, value : String | Nil = nil, expand : Array(String) | Nil = nil) : Tuple(Stripe::TaxId, Int32, Hash(String, Array(String) | String)) #

<p>Creates a new <code>tax_id</code> object for a customer.</p> @required @param customer [String?] @required @param _type [String?] Type of the tax ID, one of ad_nrt, ae_trn, ar_cuit, au_abn, au_arn, bg_uic, bh_vat, bo_tin, br_cnpj, br_cpf, ca_bn, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, ca_qst, ch_uid, ch_vat, cl_tin, cn_tin, co_nit, cr_tin, de_stn, do_rcn, ec_ruc, eg_tin, es_cif, eu_oss_vat, eu_vat, gb_vat, ge_vat, hk_br, hr_oib, hu_tin, id_npwp, il_vat, in_gst, is_vat, jp_cn, jp_rn, jp_trn, ke_pin, kr_brn, kz_bin, li_uid, mx_rfc, my_frp, my_itn, my_sst, ng_tin, no_vat, no_voec, nz_gst, om_vat, pe_ruc, ph_tin, ro_tin, rs_pib, ru_inn, ru_kpp, sa_vat, sg_gst, sg_uen, si_tin, sv_nit, th_vat, tr_tin, tw_vat, ua_vat, us_ein, uy_ruc, ve_rif, vn_tin, or za_vat @required @param value [String?] Value of the tax ID. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::TaxId, Integer, Hash)] Stripe::TaxId, response status code and response headers


[View source]
def post_customers_customer_with_http_info(*, customer : String | Nil = nil, address : Stripe::PostCustomersRequestAddress | Nil = nil, balance : Int64 | Nil = nil, cash_balance : Stripe::CashBalanceParam | Nil = nil, coupon : String | Nil = nil, default_source : String | Nil = nil, description : String | Nil = nil, email : String | Nil = nil, expand : Array(String) | Nil = nil, invoice_prefix : String | Nil = nil, invoice_settings : Stripe::CustomerParam | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, name : String | Nil = nil, next_invoice_sequence : Int64 | Nil = nil, phone : String | Nil = nil, preferred_locales : Array(String) | Nil = nil, promotion_code : String | Nil = nil, shipping : Stripe::PostCustomersRequestShipping | Nil = nil, source : String | Nil = nil, tax : Stripe::TaxParam | Nil = nil, tax_exempt : String | Nil = nil, validate : Bool | Nil = nil) : Tuple(Stripe::Customer, Int32, Hash(String, Array(String) | String)) #

<p>Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the <strong>source</strong> parameter, that becomes the customer’s active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the <strong>source</strong> parameter: for each of the customer’s current subscriptions, if the subscription bills automatically and is in the <code>past_due</code> state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the <strong>default_source</strong> for a customer will not trigger this behavior.</p> <p>This request accepts mostly the same arguments as the customer creation call.</p> @required @param customer [String?] @optional @param address [Stripe::PostCustomersRequestAddress?] @optional @param balance [Int32?] An integer amount in cents (or local equivalent) that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice. @optional @param cash_balance [Stripe::CashBalanceParam?] @optional @param coupon [String?] @optional @param default_source [String?] If you are using payment methods created via the PaymentMethods API, see the invoice_settings.default_payment_method parameter. Provide the ID of a payment source already attached to this customer to make it this customer's default payment source. If you want to add a new payment source and make it the default, see the source property. @optional @param description [String?] An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard. @optional @param email [String?] Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to 512 characters. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param invoice_prefix [String?] The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers. @optional @param invoice_settings [Stripe::CustomerParam?] @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @optional @param name [String?] The customer's full name or business name. @optional @param next_invoice_sequence [Int32?] The sequence to be used on the customer's next invoice. Defaults to 1. @optional @param phone [String?] The customer's phone number. @optional @param preferred_locales [Array(String)?] Customer's preferred languages, ordered by preference. @optional @param promotion_code [String?] The ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount. @optional @param shipping [Stripe::PostCustomersRequestShipping?] @optional @param source [String?] @optional @param tax [Stripe::TaxParam?] @optional @param tax_exempt [String?] The customer's tax exemption. One of none, exempt, or reverse. @optional @param validate [Bool?] @return [Tuple(Stripe::Customer, Integer, Hash)] Stripe::Customer, response status code and response headers


[View source]
def post_customers_with_http_info(*, address : Stripe::PostCustomersRequestAddress | Nil = nil, balance : Int64 | Nil = nil, cash_balance : Stripe::CashBalanceParam | Nil = nil, coupon : String | Nil = nil, description : String | Nil = nil, email : String | Nil = nil, expand : Array(String) | Nil = nil, invoice_prefix : String | Nil = nil, invoice_settings : Stripe::CustomerParam | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, name : String | Nil = nil, next_invoice_sequence : Int64 | Nil = nil, payment_method : String | Nil = nil, phone : String | Nil = nil, preferred_locales : Array(String) | Nil = nil, promotion_code : String | Nil = nil, shipping : Stripe::PostCustomersRequestShipping | Nil = nil, source : String | Nil = nil, tax : Stripe::TaxParam | Nil = nil, tax_exempt : String | Nil = nil, tax_id_data : Array(Stripe::DataParams) | Nil = nil, test_clock : String | Nil = nil, validate : Bool | Nil = nil) : Tuple(Stripe::Customer, Int32, Hash(String, Array(String) | String)) #

<p>Creates a new customer object.</p> @optional @param address [Stripe::PostCustomersRequestAddress?] @optional @param balance [Int32?] An integer amount in cents (or local equivalent) that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice. @optional @param cash_balance [Stripe::CashBalanceParam?] @optional @param coupon [String?] @optional @param description [String?] An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard. @optional @param email [String?] Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to 512 characters. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param invoice_prefix [String?] The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers. @optional @param invoice_settings [Stripe::CustomerParam?] @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @optional @param name [String?] The customer's full name or business name. @optional @param next_invoice_sequence [Int32?] The sequence to be used on the customer's next invoice. Defaults to 1. @optional @param payment_method [String?] @optional @param phone [String?] The customer's phone number. @optional @param preferred_locales [Array(String)?] Customer's preferred languages, ordered by preference. @optional @param promotion_code [String?] The ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount. @optional @param shipping [Stripe::PostCustomersRequestShipping?] @optional @param source [String?] @optional @param tax [Stripe::TaxParam?] @optional @param tax_exempt [String?] The customer's tax exemption. One of none, exempt, or reverse. @optional @param tax_id_data [Array(Stripe::DataParams)?] The customer's tax IDs. @optional @param test_clock [String?] ID of the test clock to attach to the customer. @optional @param validate [Bool?] @return [Tuple(Stripe::Customer, Integer, Hash)] Stripe::Customer, response status code and response headers


[View source]