Create a customer

POST {{baseUrl}}/v1/customers

Adds a customer to merchant

Request Body

{"name"=>"<string>", "addresses"=>[{"canton"=>"<string>", "city"=>"<string>", "country"=>"RU", "created_at"=>"<number>", "district"=>"<string>", "id"=>"<string>", "line_1"=>"<string>", "line_2"=>"<string>", "line_3"=>"<string>", "name"=>"<string>", "phone_number"=>"<string>", "state"=>"<string>", "zip"=>"<string>"}, {"canton"=>"<string>", "city"=>"<string>", "country"=>"YE", "created_at"=>"<number>", "district"=>"<string>", "id"=>"<string>", "line_1"=>"<string>", "line_2"=>"<string>", "line_3"=>"<string>", "name"=>"<string>", "phone_number"=>"<string>", "state"=>"<string>", "zip"=>"<string>"}], "business_vat_id"=>"<string>", "coupon"=>"<string>", "default_payment_method"=>"<string>", "description"=>"<string>", "email"=>"<string>", "ewallet"=>"<string>", "invoice_prefix"=>"<string>", "phone_number"=>"<string>"}

HEADERS

RESPONSES

status: OK

{"status":{"error_code":"\u003cstring\u003e","message":"\u003cstring\u003e","operation_id":"\u003cstring\u003e","response_code":"\u003cstring\u003e","status":"\u003cstring\u003e"},"data":{"name":"\u003cstring\u003e","addresses":[{"canton":"\u003cstring\u003e","city":"\u003cstring\u003e","country":"AE","created_at":"\u003cnumber\u003e","district":"\u003cstring\u003e","id":"\u003cstring\u003e","line_1":"\u003cstring\u003e","line_2":"\u003cstring\u003e","line_3":"\u003cstring\u003e","metadata":{},"name":"\u003cstring\u003e","phone_number":"\u003cstring\u003e","state":"\u003cstring\u003e","zip":"\u003cstring\u003e"},{"canton":"\u003cstring\u003e","city":"\u003cstring\u003e","country":"PW","created_at":"\u003cnumber\u003e","district":"\u003cstring\u003e","id":"\u003cstring\u003e","line_1":"\u003cstring\u003e","line_2":"\u003cstring\u003e","line_3":"\u003cstring\u003e","metadata":{},"name":"\u003cstring\u003e","phone_number":"\u003cstring\u003e","state":"\u003cstring\u003e","zip":"\u003cstring\u003e"}],"business_vat_id":"\u003cstring\u003e","created_at":"\u003cinteger\u003e","default_payment_method":"\u003cstring\u003e","delinquent":"\u003cboolean\u003e","description":"\u003cstring\u003e","discount":{"coupon":{"amount_off":"\u003cnumber\u003e","created":"\u003cnumber\u003e","currency":"BBD","description":"\u003cstring\u003e","discount_duration_in_uses":"\u003cnumber\u003e","discount_valid_until":"\u003cnumber\u003e","discount_validity_in_months":"\u003cnumber\u003e","duration":"repeating","duration_in_months":"\u003cnumber\u003e","id":"\u003cstring\u003e","max_redemptions":"\u003cnumber\u003e","metadata":{},"percent_off":2,"redeem_by":"\u003cnumber\u003e","times_redeemed":"\u003cnumber\u003e","valid":"\u003cboolean\u003e"},"customer":"\u003cstring\u003e","end":"\u003cnumber\u003e","id":"\u003cstring\u003e","number_of_uses":"\u003cnumber\u003e","start":"\u003cnumber\u003e","subscription":"\u003cstring\u003e","valid":"\u003cboolean\u003e"},"email":"\u003cstring\u003e","ewallet":"\u003cstring\u003e","id":"\u003cstring\u003e","invoice_prefix":"\u003cstring\u003e","metadata":{},"payment_methods":{"data":[{"id":"\u003cstring\u003e","type":"\u003cstring\u003e","category":"cash","metadata":{},"image":"\u003cstring\u003e","webhook_url":"\u003cstring\u003e","supporting_documentation":"\u003cstring\u003e","next_action":"pending_capture","bic_swift":"\u003cstring\u003e","account_last4":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","type":"\u003cstring\u003e","category":"bank","metadata":{},"image":"\u003cstring\u003e","webhook_url":"\u003cstring\u003e","supporting_documentation":"\u003cstring\u003e","next_action":"3d_verification","bic_swift":"\u003cstring\u003e","account_last4":"\u003cstring\u003e"}],"has_more":"\u003cboolean\u003e","total_count":"\u003cinteger\u003e","url":"\u003cstring\u003e"},"phone_number":"\u003cstring\u003e","subscriptions":[{"billing":"\u003cstring\u003e","billing_cycle_anchor":"\u003cstring\u003e","cancel_at_period_end":"\u003cboolean\u003e","canceled_at":"\u003cnumber\u003e","created_at":"\u003cnumber\u003e","current_period_end":"\u003cnumber\u003e","current_period_start":"\u003cnumber\u003e","customer_token":"\u003cstring\u003e","days_until_due":"\u003cnumber\u003e","discount":{"coupon":{"amount_off":"\u003cnumber\u003e","created":"\u003cnumber\u003e","currency":"GMD","description":"\u003cstring\u003e","discount_duration_in_uses":"\u003cnumber\u003e","discount_valid_until":"\u003cnumber\u003e","discount_validity_in_months":"\u003cnumber\u003e","duration":"forever","duration_in_months":"\u003cnumber\u003e","id":"\u003cstring\u003e","max_redemptions":"\u003cnumber\u003e","metadata":{},"percent_off":100,"redeem_by":"\u003cnumber\u003e","times_redeemed":"\u003cnumber\u003e","valid":"\u003cboolean\u003e"},"end":"\u003cnumber\u003e","id":"\u003cstring\u003e","number_of_uses":"\u003cnumber\u003e","start":"\u003cnumber\u003e","subscription":"\u003cstring\u003e","valid":"\u003cboolean\u003e"},"ended_at":"\u003cnumber\u003e","id":"\u003cstring\u003e","metadata":{},"payment_fields":{},"payment_method":"\u003cstring\u003e","payout_fields":{},"simultaneous_invoice":"\u003cboolean\u003e","status":"trialing","subscription_items":{"data":[{"created":"\u003cnumber\u003e","id":"\u003cstring\u003e","metadata":{},"plan":{"active":"\u003cboolean\u003e","aggregate_usage":"max","amount":"\u003cnumber\u003e","billing_scheme":"per_unit","created_at":"\u003cnumber\u003e","currency":"CUC","id":"\u003cstring\u003e","interval":"week","interval_count":"\u003cnumber\u003e","metadata":{},"nickname":"\u003cstring\u003e","product":{"active":"\u003cboolean\u003e","attributes":["\u003cstring\u003e","\u003cstring\u003e"],"created_at":"\u003cnumber\u003e","description":"\u003cstring\u003e","id":"\u003cstring\u003e","images":["\u003cstring\u003e","\u003cstring\u003e"],"metadata":{},"name":"\u003cstring\u003e","package_dimensions":{"height":"\u003cnumber\u003e","length":"\u003cnumber\u003e","weight":"\u003cnumber\u003e","width":"\u003cnumber\u003e"},"shippable":"\u003cboolean\u003e","skus":[{"active":"\u003cboolean\u003e","attributes":{},"created_at":"\u003cnumber\u003e","currency":"PKR","id":"\u003cstring\u003e","image":"\u003cstring\u003e","inventory":{},"metadata":{},"package_dimensions":{"height":"\u003cnumber\u003e","length":"\u003cnumber\u003e","weight":"\u003cnumber\u003e","width":"\u003cnumber\u003e"},"price":"\u003cnumber\u003e","product":"\u003cstring\u003e","updated_at":"\u003cnumber\u003e"},{"active":"\u003cboolean\u003e","attributes":{},"created_at":"\u003cnumber\u003e","currency":"BAM","id":"\u003cstring\u003e","image":"\u003cstring\u003e","inventory":{},"metadata":{},"package_dimensions":{"height":"\u003cnumber\u003e","length":"\u003cnumber\u003e","weight":"\u003cnumber\u003e","width":"\u003cnumber\u003e"},"price":"\u003cnumber\u003e","product":"\u003cstring\u003e","updated_at":"\u003cnumber\u003e"}],"statement_descriptor":"\u003cstring\u003e","type":"goods","unit_label":"\u003cstring\u003e","updated_at":"\u003cnumber\u003e"},"tiers":[{"amount":"\u003cnumber\u003e","flat_amount":"\u003cnumber\u003e","up_to":"\u003cstring\u003e"},{"amount":"\u003cnumber\u003e","flat_amount":"\u003cnumber\u003e","up_to":"\u003cstring\u003e"}],"tiers_mode":"graduated","transform_usage":{"divide_by":"\u003cnumber\u003e","round":"\u003cstring\u003e"},"trial_period_days":"\u003cnumber\u003e","usage_type":"licensed"},"quantity":"\u003cnumber\u003e","subscription_id":"\u003cstring\u003e"},{"created":"\u003cnumber\u003e","id":"\u003cstring\u003e","metadata":{},"plan":{"active":"\u003cboolean\u003e","aggregate_usage":"last_during_period","amount":"\u003cnumber\u003e","billing_scheme":"per_unit","created_at":"\u003cnumber\u003e","currency":"VEF","id":"\u003cstring\u003e","interval":"month","interval_count":"\u003cnumber\u003e","metadata":{},"nickname":"\u003cstring\u003e","product":{"active":"\u003cboolean\u003e","attributes":["\u003cstring\u003e","\u003cstring\u003e"],"created_at":"\u003cnumber\u003e","description":"\u003cstring\u003e","id":"\u003cstring\u003e","images":["\u003cstring\u003e","\u003cstring\u003e"],"metadata":{},"name":"\u003cstring\u003e","package_dimensions":{"height":"\u003cnumber\u003e","length":"\u003cnumber\u003e","weight":"\u003cnumber\u003e","width":"\u003cnumber\u003e"},"shippable":"\u003cboolean\u003e","skus":[{"active":"\u003cboolean\u003e","attributes":{},"created_at":"\u003cnumber\u003e","currency":"FKP","id":"\u003cstring\u003e","image":"\u003cstring\u003e","inventory":{},"metadata":{},"package_dimensions":{"height":"\u003cnumber\u003e","length":"\u003cnumber\u003e","weight":"\u003cnumber\u003e","width":"\u003cnumber\u003e"},"price":"\u003cnumber\u003e","product":"\u003cstring\u003e","updated_at":"\u003cnumber\u003e"},{"active":"\u003cboolean\u003e","attributes":{},"created_at":"\u003cnumber\u003e","currency":"GYD","id":"\u003cstring\u003e","image":"\u003cstring\u003e","inventory":{},"metadata":{},"package_dimensions":{"height":"\u003cnumber\u003e","length":"\u003cnumber\u003e","weight":"\u003cnumber\u003e","width":"\u003cnumber\u003e"},"price":"\u003cnumber\u003e","product":"\u003cstring\u003e","updated_at":"\u003cnumber\u003e"}],"statement_descriptor":"\u003cstring\u003e","type":"services","unit_label":"\u003cstring\u003e","updated_at":"\u003cnumber\u003e"},"tiers":[{"amount":"\u003cnumber\u003e","flat_amount":"\u003cnumber\u003e","up_to":"\u003cstring\u003e"},{"amount":"\u003cnumber\u003e","flat_amount":"\u003cnumber\u003e","up_to":"\u003cstring\u003e"}],"tiers_mode":"volume","transform_usage":{"divide_by":"\u003cnumber\u003e","round":"\u003cstring\u003e"},"trial_period_days":"\u003cnumber\u003e","usage_type":"licensed"},"quantity":"\u003cnumber\u003e","subscription_id":"\u003cstring\u003e"}],"has_more":"\u003cboolean\u003e","total_count":"\u003cnumber\u003e","url":"\u003cstring\u003e"},"tax_percent":"\u003cnumber\u003e","trial_end":"\u003cnumber\u003e","trial_start":"\u003cnumber\u003e","type":"payment"},{"billing":"\u003cstring\u003e","billing_cycle_anchor":"\u003cstring\u003e","cancel_at_period_end":"\u003cboolean\u003e","canceled_at":"\u003cnumber\u003e","created_at":"\u003cnumber\u003e","current_period_end":"\u003cnumber\u003e","current_period_start":"\u003cnumber\u003e","customer_token":"\u003cstring\u003e","days_until_due":"\u003cnumber\u003e","discount":{"coupon":{"amount_off":"\u003cnumber\u003e","created":"\u003cnumber\u003e","currency":"IRR","description":"\u003cstring\u003e","discount_duration_in_uses":"\u003cnumber\u003e","discount_valid_until":"\u003cnumber\u003e","discount_validity_in_months":"\u003cnumber\u003e","duration":"repeating","duration_in_months":"\u003cnumber\u003e","id":"\u003cstring\u003e","max_redemptions":"\u003cnumber\u003e","metadata":{},"percent_off":3,"redeem_by":"\u003cnumber\u003e","times_redeemed":"\u003cnumber\u003e","valid":"\u003cboolean\u003e"},"end":"\u003cnumber\u003e","id":"\u003cstring\u003e","number_of_uses":"\u003cnumber\u003e","start":"\u003cnumber\u003e","subscription":"\u003cstring\u003e","valid":"\u003cboolean\u003e"},"ended_at":"\u003cnumber\u003e","id":"\u003cstring\u003e","metadata":{},"payment_fields":{},"payment_method":"\u003cstring\u003e","payout_fields":{},"simultaneous_invoice":"\u003cboolean\u003e","status":"canceled","subscription_items":{"data":[{"created":"\u003cnumber\u003e","id":"\u003cstring\u003e","metadata":{},"plan":{"active":"\u003cboolean\u003e","aggregate_usage":"last_during_period","amount":"\u003cnumber\u003e","billing_scheme":"tiered","created_at":"\u003cnumber\u003e","currency":"BND","id":"\u003cstring\u003e","interval":"month","interval_count":"\u003cnumber\u003e","metadata":{},"nickname":"\u003cstring\u003e","product":{"active":"\u003cboolean\u003e","attributes":["\u003cstring\u003e","\u003cstring\u003e"],"created_at":"\u003cnumber\u003e","description":"\u003cstring\u003e","id":"\u003cstring\u003e","images":["\u003cstring\u003e","\u003cstring\u003e"],"metadata":{},"name":"\u003cstring\u003e","package_dimensions":{"height":"\u003cnumber\u003e","length":"\u003cnumber\u003e","weight":"\u003cnumber\u003e","width":"\u003cnumber\u003e"},"shippable":"\u003cboolean\u003e","skus":[{"active":"\u003cboolean\u003e","attributes":{},"created_at":"\u003cnumber\u003e","currency":"AUD","id":"\u003cstring\u003e","image":"\u003cstring\u003e","inventory":{},"metadata":{},"package_dimensions":{"height":"\u003cnumber\u003e","length":"\u003cnumber\u003e","weight":"\u003cnumber\u003e","width":"\u003cnumber\u003e"},"price":"\u003cnumber\u003e","product":"\u003cstring\u003e","updated_at":"\u003cnumber\u003e"},{"active":"\u003cboolean\u003e","attributes":{},"created_at":"\u003cnumber\u003e","currency":"TZS","id":"\u003cstring\u003e","image":"\u003cstring\u003e","inventory":{},"metadata":{},"package_dimensions":{"height":"\u003cnumber\u003e","length":"\u003cnumber\u003e","weight":"\u003cnumber\u003e","width":"\u003cnumber\u003e"},"price":"\u003cnumber\u003e","product":"\u003cstring\u003e","updated_at":"\u003cnumber\u003e"}],"statement_descriptor":"\u003cstring\u003e","type":"goods","unit_label":"\u003cstring\u003e","updated_at":"\u003cnumber\u003e"},"tiers":[{"amount":"\u003cnumber\u003e","flat_amount":"\u003cnumber\u003e","up_to":"\u003cstring\u003e"},{"amount":"\u003cnumber\u003e","flat_amount":"\u003cnumber\u003e","up_to":"\u003cstring\u003e"}],"tiers_mode":"graduated","transform_usage":{"divide_by":"\u003cnumber\u003e","round":"\u003cstring\u003e"},"trial_period_days":"\u003cnumber\u003e","usage_type":"licensed"},"quantity":"\u003cnumber\u003e","subscription_id":"\u003cstring\u003e"},{"created":"\u003cnumber\u003e","id":"\u003cstring\u003e","metadata":{},"plan":{"active":"\u003cboolean\u003e","aggregate_usage":"last_during_period","amount":"\u003cnumber\u003e","billing_scheme":"per_unit","created_at":"\u003cnumber\u003e","currency":"PGK","id":"\u003cstring\u003e","interval":"day","interval_count":"\u003cnumber\u003e","metadata":{},"nickname":"\u003cstring\u003e","product":{"active":"\u003cboolean\u003e","attributes":["\u003cstring\u003e","\u003cstring\u003e"],"created_at":"\u003cnumber\u003e","description":"\u003cstring\u003e","id":"\u003cstring\u003e","images":["\u003cstring\u003e","\u003cstring\u003e"],"metadata":{},"name":"\u003cstring\u003e","package_dimensions":{"height":"\u003cnumber\u003e","length":"\u003cnumber\u003e","weight":"\u003cnumber\u003e","width":"\u003cnumber\u003e"},"shippable":"\u003cboolean\u003e","skus":[{"active":"\u003cboolean\u003e","attributes":{},"created_at":"\u003cnumber\u003e","currency":"GNF","id":"\u003cstring\u003e","image":"\u003cstring\u003e","inventory":{},"metadata":{},"package_dimensions":{"height":"\u003cnumber\u003e","length":"\u003cnumber\u003e","weight":"\u003cnumber\u003e","width":"\u003cnumber\u003e"},"price":"\u003cnumber\u003e","product":"\u003cstring\u003e","updated_at":"\u003cnumber\u003e"},{"active":"\u003cboolean\u003e","attributes":{},"created_at":"\u003cnumber\u003e","currency":"GYD","id":"\u003cstring\u003e","image":"\u003cstring\u003e","inventory":{},"metadata":{},"package_dimensions":{"height":"\u003cnumber\u003e","length":"\u003cnumber\u003e","weight":"\u003cnumber\u003e","width":"\u003cnumber\u003e"},"price":"\u003cnumber\u003e","product":"\u003cstring\u003e","updated_at":"\u003cnumber\u003e"}],"statement_descriptor":"\u003cstring\u003e","type":"goods","unit_label":"\u003cstring\u003e","updated_at":"\u003cnumber\u003e"},"tiers":[{"amount":"\u003cnumber\u003e","flat_amount":"\u003cnumber\u003e","up_to":"\u003cstring\u003e"},{"amount":"\u003cnumber\u003e","flat_amount":"\u003cnumber\u003e","up_to":"\u003cstring\u003e"}],"tiers_mode":"volume","transform_usage":{"divide_by":"\u003cnumber\u003e","round":"\u003cstring\u003e"},"trial_period_days":"\u003cnumber\u003e","usage_type":"metered"},"quantity":"\u003cnumber\u003e","subscription_id":"\u003cstring\u003e"}],"has_more":"\u003cboolean\u003e","total_count":"\u003cnumber\u003e","url":"\u003cstring\u003e"},"tax_percent":"\u003cnumber\u003e","trial_end":"\u003cnumber\u003e","trial_start":"\u003cnumber\u003e","type":"payment"}]}}