Create Subscription

POST {{baseUrl}}/v1/payments/subscriptions

Create a subscription for regular, automatic payments.

Request Body

{"customer"=>"<string>", "subscription_items"=>[{"plan"=>"<string>", "quantity"=>"<number>"}], "billing"=>"<string>", "billing_cycle_anchor"=>"<number>", "cancel_at_period_end"=>"<boolean>", "coupon"=>"<string>", "days_until_due"=>"<number>", "payment_fields"=>{"address"=>{"canton"=>"<string>", "city"=>"<string>", "country"=>"NC", "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>"}, "amount"=>0, "auth_code"=>"<string>", "cancel_reason"=>"<string>", "captured"=>true, "complete_payment_url"=>"<string>", "country_code"=>"GM", "created_at"=>"<integer>", "currency_code"=>"JMD", "customer_token"=>"<string>", "description"=>"<string>", "dispute"=>{"id"=>"<string>", "token"=>"<string>", "status"=>"ACT", "amount"=>"<number>", "currency"=>"<string>", "dispute_category"=>"<string>", "dispute_reason_description"=>"<string>", "original_transaction_currency"=>"GHS", "original_transaction_amount"=>"<number>", "original_dispute_amount"=>"<number>", "original_dispute_currency"=>"BOB", "original_transaction_id"=>"<string>", "ewallet_id"=>"<string>", "central_processing_date"=>"<number>", "created_at"=>"<number>", "updated_at"=>"<number>", "due_date"=>"<number>", "payment_method"=>"<string>", "rate"=>"<number>", "evidence"=>"<string>", "evidence_reason_code"=>"<string>", "pre_dispute"=>"<boolean>", "arn"=>"<string>"}, "error_code"=>"<string>", "error_payment_url"=>"<string>", "ewallet_id"=>"<string>", "ewallets"=>[{"ewallet_id"=>"<string>", "amount"=>"<number>", "percent"=>"<number>", "refunded_amount"=>"<number>"}], "expiration"=>0, "failure_code"=>"<string>", "failure_message"=>"<string>", "fixed_side"=>"<string>", "flow_type"=>"<string>", "fx_rate"=>1, "group_payment"=>"<string>", "id"=>"<string>", "initiation_type"=>"<string>", "instructions"=>[{"name"=>"<string>", "steps"=>[{"step"=>"<string>"}]}], "invoice"=>"<string>", "is_partial"=>false, "merchant_reference_id"=>"<string>", "merchant_requested_amount"=>"<string>", "merchant_requested_currency"=>"<string>", "mid"=>"<string>", "next_action"=>"pending_confirmation", "order"=>"<string>", "original_amount"=>0, "outcome"=>{"network_status"=>"reversed_after_approval", "payment_flow_type"=>"eWallet", "payment_options"=>{"address"=>{"canton"=>"<string>", "city"=>"<string>", "country"=>"NO", "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>"}, "amount_range_per_currency"=>[{"maximum_amount"=>"<number>", "minimum_amount"=>"<number>", "currency"=>"BWP"}], "bin_details"=>{"brand"=>"<string>", "bin_number"=>"<string>", "type"=>"<string>", "issuer"=>"<string>", "country"=>"SM", "level"=>"<string>"}, "category"=>"ewallet", "conditions"=>[{"description"=>"<string>", "element_name"=>"<string>", "operator"=>"<string>", "threshold_value"=>"<string>"}], "country"=>"LK", "currencies"=>["AMD"], "customer"=>{"name"=>"<string>", "addresses"=>[{"canton"=>"<string>", "city"=>"<string>", "country"=>"KM", "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>", "created_at"=>"<integer>", "default_payment_method"=>"<string>", "delinquent"=>"<boolean>", "description"=>"<string>", "discount"=>{"coupon"=>{"amount_off"=>"<number>", "created"=>"<number>", "currency"=>"BBD", "description"=>"<string>", "discount_duration_in_uses"=>"<number>", "discount_valid_until"=>"<number>", "discount_validity_in_months"=>"<number>", "duration"=>"forever", "duration_in_months"=>"<number>", "id"=>"<string>", "max_redemptions"=>"<number>", "percent_off"=>100, "redeem_by"=>"<number>", "times_redeemed"=>"<number>", "valid"=>"<boolean>"}, "customer"=>"<string>", "end"=>"<number>", "id"=>"<string>", "number_of_uses"=>"<number>", "start"=>"<number>", "subscription"=>"<string>", "valid"=>"<boolean>"}, "email"=>"<string>", "ewallet"=>"<string>", "id"=>"<string>", "invoice_prefix"=>"<string>", "payment_methods"=>{"data"=>[{"id"=>"<string>", "type"=>"<string>", "category"=>"cash", "image"=>"<string>", "webhook_url"=>"<string>", "supporting_documentation"=>"<string>", "next_action"=>"not_applicable", "bic_swift"=>"<string>", "account_last4"=>"<string>"}], "has_more"=>"<boolean>", "total_count"=>"<integer>", "url"=>"<string>"}, "phone_number"=>"<string>", "subscriptions"=>[{"billing"=>"<string>", "billing_cycle_anchor"=>"<string>", "cancel_at_period_end"=>"<boolean>", "canceled_at"=>"<number>", "created_at"=>"<number>", "current_period_end"=>"<number>", "current_period_start"=>"<number>", "customer_token"=>"<string>", "days_until_due"=>"<number>", "discount"=>{"coupon"=>{"amount_off"=>"<number>", "created"=>"<number>", "currency"=>"LKR", "description"=>"<string>", "discount_duration_in_uses"=>"<number>", "discount_valid_until"=>"<number>", "discount_validity_in_months"=>"<number>", "duration"=>"forever", "duration_in_months"=>"<number>", "id"=>"<string>", "max_redemptions"=>"<number>", "percent_off"=>4, "redeem_by"=>"<number>", "times_redeemed"=>"<number>", "valid"=>"<boolean>"}, "end"=>"<number>", "id"=>"<string>", "number_of_uses"=>"<number>", "start"=>"<number>", "subscription"=>"<string>", "valid"=>"<boolean>"}, "ended_at"=>"<number>", "id"=>"<string>", "payment_method"=>"<string>", "simultaneous_invoice"=>"<boolean>", "status"=>"unpaid", "subscription_items"=>{"data"=>[{"created"=>"<number>", "id"=>"<string>", "plan"=>{"active"=>"<boolean>", "aggregate_usage"=>"last_during_period", "amount"=>"<number>", "billing_scheme"=>"tiered", "created_at"=>"<number>", "currency"=>"IRR", "id"=>"<string>", "interval"=>"year", "interval_count"=>"<number>", "nickname"=>"<string>", "product"=>{"active"=>"<boolean>", "attributes"=>["<string>"], "created_at"=>"<number>", "description"=>"<string>", "id"=>"<string>", "images"=>["<string>"], "name"=>"<string>", "package_dimensions"=>{"height"=>"<number>", "length"=>"<number>", "weight"=>"<number>", "width"=>"<number>"}, "shippable"=>"<boolean>", "skus"=>[{"active"=>"<boolean>", "created_at"=>"<number>", "currency"=>"GBP", "id"=>"<string>", "image"=>"<string>", "package_dimensions"=>{"height"=>"<number>", "length"=>"<number>", "weight"=>"<number>", "width"=>"<number>"}, "price"=>"<number>", "product"=>"<string>", "updated_at"=>"<number>"}], "statement_descriptor"=>"<string>", "type"=>"services", "unit_label"=>"<string>", "updated_at"=>"<number>"}, "tiers"=>[{"amount"=>"<number>", "flat_amount"=>"<number>", "up_to"=>"<string>"}], "tiers_mode"=>"graduated", "transform_usage"=>{"divide_by"=>"<number>", "round"=>"<string>"}, "trial_period_days"=>"<number>", "usage_type"=>"metered"}, "quantity"=>"<number>", "subscription_id"=>"<string>"}], "has_more"=>"<boolean>", "total_count"=>"<number>", "url"=>"<string>"}, "tax_percent"=>"<number>", "trial_end"=>"<number>", "trial_start"=>"<number>", "type"=>"payout"}]}, "fingerprint"=>"<string>", "image"=>"<string>", "instructions"=>"<string>", "is_cancelable"=>"<boolean>", "is_expirable"=>"<boolean>", "is_online"=>"<boolean>", "is_refundable"=>"<boolean>", "is_required"=>"<boolean>", "is_tokenizable"=>"<boolean>", "is_virtual"=>"<boolean>", "last4"=>"2689", "maximum_expiration_seconds"=>"<integer>", "minimum_expiration_seconds"=>"<integer>", "multiple_overage_allowed"=>"<boolean>", "name"=>"<string>", "payment_flow_type"=>"direct"}, "status"=>"<string>", "risk_level"=>"not_assessed", "seller_message"=>"<string>"}, "paid"=>false, "paid_at"=>0, "payment_fees"=>{"fx_fee"=>{"calc_type"=>"<string>", "value"=>"<number>"}, "gross_fees"=>"<number>", "net_fees"=>"<number>", "transaction_fee"=>{"calc_type"=>"<string>", "fee_type"=>"<string>", "value"=>"<number>"}}, "payment_method"=>"<string>", "payment_method_type"=>"<string>", "payment_method_type_category"=>"card", "receipt_email"=>"<string>", "receipt_number"=>"<string>", "redirect_url"=>"<string>", "refunded"=>false, "refunded_amount"=>0, "refunds"=>{"data"=>["<string>"], "has_more"=>"<boolean>", "total_count"=>"<integer>", "url"=>"<string>"}, "save_payment_method"=>"<boolean>", "statement_descriptor"=>"<string>", "status"=>"ACT", "transaction_id"=>"<string>"}, "payment_method"=>"<string>", "simultaneous_invoice"=>"<boolean>", "tax_percent"=>"<number>", "trial_end"=>"<number>", "trial_from_plan"=>"<boolean>", "trial_period_days"=>"<number>"}

HEADERS

RESPONSES

status: OK

{"data":{"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":"GTQ","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":9,"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":"active","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":"TOP","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":"COP","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":"CHF","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"},{"created":"\u003cnumber\u003e","id":"\u003cstring\u003e","metadata":{},"plan":{"active":"\u003cboolean\u003e","aggregate_usage":"last_ever","amount":"\u003cnumber\u003e","billing_scheme":"per_unit","created_at":"\u003cnumber\u003e","currency":"KRW","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":"BSD","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":"IRR","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"},"status":{"error_code":"\u003cstring\u003e","message":"\u003cstring\u003e","operation_id":"\u003cstring\u003e","response_code":"\u003cstring\u003e","status":"\u003cstring\u003e"}}