---
title: "Activate a subscription"
method: PUT
path: "/billing/subscriptions/{subscriptionId}/activate"
---

# Activate a subscription

`PUT /billing/subscriptions/{subscriptionId}/activate`

## Request

- Base URL: `https://api-sandbox.ezypay.com/v2`
- URL: `https://api-sandbox.ezypay.com/v2/billing/subscriptions/{subscriptionId}/activate`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://identity-sandbox.ezypay.com/token`

## Path parameters

- `subscriptionId` string, required

## Headers

- `merchant` string, required

## Request body

- object
  - `startDate` string: The preferred start date of the subscription. The subscription start date cannot be back-dated. If not specified, the subscription will follow the start date of the subscription's plan. An invoice will be generated immediately upon activation if the start date equals today's date.
  - `paymentMethodToken` string: The payment method token that is generated by the vault.

## Response `200`

200

- object
  - `id` string
  - `customerId` string
  - `planId` string
  - `name` string
  - `status` string
  - `startDate` string
  - `endDate` unknown
  - `paymentMethodToken` string
  - `accountingCode` string
  - `amount` object
    - `currency` string
    - `value` integer
    - `type` unknown
  - `tax` object
    - `rate` integer
  - `nextBillingDate` string
  - `nextFutureInvoice` unknown
  - `interval` integer
  - `intervalUnit` string
  - `totalPaid` object
    - `currency` string
    - `value` integer
    - `type` unknown
  - `totalBillingCycles` integer
  - `remainingToPay` unknown
  - `remainingBillingCycles` unknown
  - `endTargetAmount` unknown
  - `endTargetBillingCycles` unknown
  - `cancelledDate` unknown
  - `failedPaymentHandling` unknown
  - `failedAttemptsCount` integer
  - `totalPastDue` object
    - `currency` string
    - `value` integer
    - `type` unknown
  - `totalDiscounted` object
    - `currency` string
    - `value` integer
    - `type` unknown
  - `metadata` unknown
  - `createdOn` string
  - `autoPayment` boolean
  - `setupPayments` unknown

## Other responses

- `400`: 400

## Changes

- **2026-11-03** `924be4030f56`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/ezypay/apis/vault/changes/billing/subscriptions/:subscriptionId/activate/put.md)

---

[API](https://skmtc.dev/ezypay/apis/vault.md) - [All operations](https://skmtc.dev/ezypay/apis/vault/llms.txt) - [OpenAPI document](https://skmtc.dev/ezypay/apis/vault/revisions/924be4030f56?raw)
