v1

latestOpenAPI 3.0.0Apache 2.02026-07-143281,4552.1 MB
Subscriptions

UpdateSubscription

Updates a subscription by modifying or clearing subscription field values. To clear a field, set its value to null.

put/v2/subscriptions/{subscription_id}

Path parameters

subscription_idstring required

The ID of the subscription to update.

Request body

Example request

{
  "subscription": {
    "canceled_date": null,
    "card_id": "{NEW CARD ID}"
  }
}

Response

Success

Example response

{
  "subscription": {
    "card_id": "{NEW CARD ID}",
    "charged_through_date": "2023-03-13",
    "created_at": "2023-01-30T19:27:32Z",
    "customer_id": "AM69AB81FT4479YH9HGWS1HZY8",
    "id": "7217d8ca-1fee-4446-a9e5-8540b5d8c9bb",
    "invoice_ids": [
      "inv:0-ChAPSfVYvNewckgf3x4iigN_ENMM",
      "inv:0-ChBQaCCLfjcm9WEUBGxvuydJENMM"
    ],
    "location_id": "LPJKHYR7WFDKN",
    "plan_variation_id": "XOUNEKCE6NSXQW5NTSQ73MMX",
    "source": {
      "name": "My Application"
    },
    "start_date": "2023-01-30",
    "status": "ACTIVE",
    "timezone": "UTC",
    "version": 3
  }
}