Update a subscription

put

{protocol}://{environment}/recurring/v1/subscriptions/{subscriptionId}

Updates a subscription based on the subscriptionId. Merchants can create subscriptions that associate customers with specific plans, including details such as customer billing information, card-on-file, scheduled payment amount, start date, and payment intervals.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

subscriptionId

string

required

Universally unique identifier (UUID) of a subscription in a plan.

Body Params

startDate

date-time

Start date of the subscription plan in ISO-8601 format. For example, September 7, 2019 displays as 20190907 or expressed with delimiters as 2019-09-07. Time displays in hours, minutes, and seconds, as 12:07:22.

collectionMethod

string

enum

Method for collecting payment.
Currently, charge_automatically is the only method allowed.

Allowed:

endDate

date-time

End date of the subscription plan in ISO-8601 format. For example, September 7, 2019 displays as 20190907 or expressed with delimiters as 2019-09-07. Time displays in hours, minutes, and seconds, as 12:07:22.

softDescriptor

object

Information about the business that processed the charge.

level2

object

note

string

Subscription note, if any. If available, it overrides the plan's subscription.

tipAmount

int64

Tip amount. If available, it overrides the plan's amount.

amount

int64

Amount of the subscription plan. If available, it overrides the plan's amount.

active

boolean

Indicates whether the subscription is currently active.
Values:

True
False

taxRateUuids

array of strings

Universally unique identifiers (UUIDs) of the tax rate. If available, it overrides the plan's subscription. Maximum length of combined UUIDs is more than 255 characters.

taxRateUuids

Headers

X-Clover-Merchant-Id

string

required

Clover merchant identifier (mId).

User-Agent

string

required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <application>/<version>

Responses

200Successful response. Subscription is updated.

defaultUnexpected error.