Update a Subscription

PATCH /subscription/{subscription_id}

Path Parameters

Parameter Type Description
subscription_id Integer The ID of the subscription.

Request Body Data

Attribute Type Description
trial_length Integer The duration of the trial for the subscription in days.
status String The subscription status. Can be either active, trial, cancelled, paused, or past-due.

Request

Content-Type: application/json
Authorization: Bearer y5QNsEEGg8s9XqiQFuqGOB5a1zV22pGRFJgHgCbH
{
  "status": "paused",
  "trial_length": 0
}

Response 200

Content-Type: application/json
ETag: 409e55a8f8fdabb0932a6a5e3f565a5d
Cache-Control: private, max-age=60
Last-Modified: Mon, 09 Jun 2014 16:54:41 GMT
Content-Length: 4642
{
    "meta": {
        "status": 200,
        "success": true
    },
    "data": {
        "id": 1,
        "status": "paused",
        "billing_status": "success",
        "next_invoice_date": "2019-02-19",
        "next_invoice_amount": "$14.99",
        "is_continuous": null,
        "shop_shipping_method_id": 3,
        "shop_payment_method_id": 1,
        "billing_plan_id": 7,
        "trial_length": null,
        "pending_billing_plan_id": null,
        "shipping_service": null,
        "failed_payments_count": null,
        "failed_payment_reason": null,
        "last_invoice_date": "2019-02-18",
        "created_at": "2019-02-08T12:04:49-0800",
        "updated_at": "2019-02-28T18:17:00-0800",
        "custom_fields": []
    }
}