Create a subscription under a plan

post

{protocol}://{environment}/recurring/v1/plans/{planId}/subscriptions

Creates a subscription under a plan, 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

planId

string

required

Universally unique identifier (UUID) of the plan with subscriptions.

Body Params

startDate

date-time

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

collectionMethod

string

enum

required

Method of collecting the subscription.
Values:

Charge_automatically
Authorize_automatically
Send_invoice

Allowed:

endDate

date-time

End date of the subscription plan in ISO-8601 format. For example, September 7, 2023 displays as 20230907 or with delimiters as 2023-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

length ≤ 255

Additional information or note related to the subscription. 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. 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. Length: Maximum length of combined UUIDs is more than 255 characters.

taxRateUuids

customerId

uuid

required

Customer identifier (ID).

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 created in a plan.

defaultUnexpected error.