Cancel Subscription

DELETE {{baseUrl}}/v1/payments/subscriptions/:subscriptionId

Cancel a subscription.

Request Body

{"cancel_at_period_end"=>"<boolean>"}

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"}}