Pause a Subscription

POST {{url}}/subscriptions/{{subscription}}/actions/pause

Pause a subscription object. No payments will be created until it is resumed.

This can only be used when a subscription is collecting a fixed number of payments (created using count), when they continue forever (created without count or end_date) or the subscription is already paused for a number of cycles.

Pause a Subscription API Docs

Request Body

{"subscriptions"=>{"pause_cycles"=>1}}

RESPONSES

status: OK

{&quot;subscriptions&quot;:{&quot;id&quot;:&quot;SB000AJY2BWBJ9&quot;,&quot;created_at&quot;:&quot;2024-03-04T21:00:19.488Z&quot;,&quot;amount&quot;:88976,&quot;currency&quot;:&quot;USD&quot;,&quot;status&quot;:&quot;paused&quot;,&quot;name&quot;:&quot;orchestrate granular e-commerce&quot;,&quot;start_date&quot;:&quot;2024-03-05&quot;,&quot;end_date&quot;:null,&quot;interval&quot;:1,&quot;interval_unit&quot;:&quot;monthly&quot;,&quot;day_of_month&quot;:5,&quot;month&quot;:null,&quot;count&quot;:12,&quot;metadata&quot;:{&quot;order_no&quot;:&quot;ORDER910&quot;},&quot;payment_reference&quot;:null,&quot;upcoming_payments&quot;:[],&quot;app_fee&quot;:null,&quot;links&quot;:{&quot;mandate&quot;:&quot;MD000ZG53ED8SZ&quot;},&quot;retry_if_possible&quot;:true,&quot;earliest_charge_date_after_resume&quot;:&quot;2024-04-05&quot;}}