Hold / Pause Subscription
Places the subscription on hold, preventing it from renewing.
Limitations
You may not place a subscription on hold if the next_billing_at date is within 24 hours.
Authorization
BasicAuth The username is a Maxio Chargify API key. The password is x.
In: header
Path Parameters
The Chargify id of the subscription.
Request Body
application/json
Allows you to pause a Subscription.
Response Body
application/json
application/json
curl -X POST "https://example.com/subscriptions/0/hold.json" \ -H "Content-Type: application/json" \ -d '{ "hold": { "automatically_resume_at": "2017-05-25T11:25:00Z" } }'{ "subscription": { "id": 18220670, "state": "on_hold", "trial_started_at": null, "trial_ended_at": null, "activated_at": "2017-06-27T13:45:15-05:00", "created_at": "2017-06-27T13:45:13-05:00", "updated_at": "2017-06-30T09:26:50-05:00", "expires_at": null, "balance_in_cents": 10000, "current_period_ends_at": "2017-06-30T12:00:00-05:00", "next_assessment_at": "2017-06-30T12:00:00-05:00", "canceled_at": null, "cancellation_message": null, "next_product_id": null, "cancel_at_end_of_period": false, "payment_collection_method": "automatic", "snap_day": "end", "cancellation_method": null, "current_period_started_at": "2017-06-27T13:45:13-05:00", "previous_state": "active", "signup_payment_id": 191819284, "signup_revenue": "0.00", "delayed_cancel_at": null, "coupon_code": null, "total_revenue_in_cents": 0, "product_price_in_cents": 0, "product_version_number": 1, "payment_type": null, "referral_code": "d3pw7f", "coupon_use_count": null, "coupon_uses_allowed": null, "reason_code": null, "automatically_resume_at": null, "current_billing_amount_in_cents": 10000, "customer": { "id": 17780587, "first_name": "Catie", "last_name": "Test", "organization": "Acme, Inc.", "email": "catie@example.com", "created_at": "2017-06-27T13:01:05-05:00", "updated_at": "2017-06-30T09:23:10-05:00", "reference": "123ABC", "address": "123 Anywhere Street", "address_2": "Apartment #10", "city": "Los Angeles", "state": "CA", "zip": "90210", "country": "US", "phone": "555-555-5555", "portal_invite_last_sent_at": "2017-06-27T13:45:16-05:00", "portal_invite_last_accepted_at": null, "verified": true, "portal_customer_created_at": "2017-06-27T13:01:08-05:00", "cc_emails": "support@example.com", "tax_exempt": true }, "product": { "id": 4470347, "name": "Zero Dollar Product", "handle": "zero-dollar-product", "description": "", "accounting_code": "", "request_credit_card": true, "expiration_interval": null, "expiration_interval_unit": "never", "created_at": "2017-03-23T10:54:12-05:00", "updated_at": "2017-04-20T15:18:46-05:00", "price_in_cents": 0, "interval": 1, "interval_unit": "month", "initial_charge_in_cents": null, "trial_price_in_cents": null, "trial_interval": null, "trial_interval_unit": "month", "archived_at": null, "require_credit_card": false, "return_params": "", "taxable": false, "update_return_url": "", "tax_code": "", "initial_charge_after_trial": false, "version_number": 1, "update_return_params": "", "product_family": { "id": 997233, "name": "Acme Products", "description": "", "handle": "acme-products", "accounting_code": null }, "public_signup_pages": [ { "id": 316810, "return_url": "", "return_params": "", "url": "https://general-goods.chargify.com/subscribe/69x825m78v3d/zero-dollar-product" } ] } }}Resume Subscription POST
Resumes a paused (on-hold) subscription. If the normal next renewal date has not passed, the subscription will return to active and will renew on that date. Otherwise, it will behave like a reactivation, setting the billing date to 'now' and charging the subscriber.
Update Automatic Subscription Resumption PUT
Updates the date on which a paused subscription will automatically resume. To update a subscription's resume date, use this method to change or update the `automatically_resume_at` date. ### Remove the resume date Alternatively, you can change the `automatically_resume_at` to `null` if you would like the subscription to not have a resume date.