v1

latestOpenAPI 3.0.0Apache 2.02026-07-143281,4552.1 MB

Subscriptions

ResumeSubscription

Schedules a RESUME action to resume a paused or a deactivated subscription.

post/v2/subscriptions/{subscription_id}/resume

Path parameters

subscription_idstring required

The ID of the subscription to resume.

Request body

resume_effective_datestring nullable

The YYYY-MM-DD-formatted date when the subscription reactivated.

resume_change_timing'IMMEDIATE' | 'END_OF_BILLING_CYCLE'

Supported timings when a pending change, as an action, takes place to a subscription.

Response

Success

Example response

{
  "actions": [
    {
      "effective_date": "2023-09-01",
      "id": "18ff74f4-3da4-30c5-929f-7d6fca84f115",
      "type": "RESUME"
    }
  ],
  "subscription": {
    "card_id": "ccof:qy5x8hHGYsgLrp4Q4GB",
    "created_at": "2023-06-20T21:53:10Z",
    "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G",
    "id": "56214fb2-cc85-47a1-93bc-44f3766bb56f",
    "location_id": "S8GWD5R9QB376",
    "phases": [
      {
        "order_template_id": "U2NaowWxzXwpsZU697x7ZHOAnCNZY",
        "ordinal": 0,
        "plan_phase_uid": "X2Q2AONPB3RB64Y27S25QCZP",
        "uid": "873451e0-745b-4e87-ab0b-c574933fe616"
      }
    ],
    "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H",
    "source": {
      "name": "My Application"
    },
    "start_date": "2023-06-20",
    "status": "ACTIVE",
    "timezone": "America/Los_Angeles",
    "version": 1
  }
}