Delete subscription

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

Responses

Response body

object

string

Subscription object.

string

Subscription identifier.

customerUuid

uuid

Customer universally unique identifier.

collectionMethod

string

Method of collection for the subscription.

CHARGE_AUTOMATICALLY AUTHORIZE_AUTOMATICALLY SEND_INVOICE

plan

object

string

Subscription plan identifier (ID).

uuid

Universally unique identifier (UUID) of the subscription plan.

name

string

Name of the subscription plan.

merchantId

string

Merchant identifier (ID) who applied for the subscription plan.

taxRateUuids

array of strings

Tax rate universally unique identifier (UUID) for the plan.

taxRateUuids

tipAmount

int64

Tip amount.

amount

int64

Amount of the subscription plan.

active

boolean

Indicates if the subscription plan is active.

interval

string

Interval of the subscription plan.

DAY WEEK MONTH YEAR

intervalCount

int32

Number of intervals in the subscription plan.

productUuid

string

Universally unique identifier (ID) of the subscription plan product.

note

string

subscription plan note, if any.

createdTime

date-time

Time when the subscription plan was created.

modifiedTime

date-time

Time when the subscription plan was modified.

deletedTime

date-time

Time when the subscription plan was deleted.

merchantId

uuid

Merchant identifier.

active

boolean

Indicates whether the merchant business is active or not.

tipAmount

int64

Tip amount.

amount

int64

Amount of subscription.

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.

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.

note

string

Subscription note, if any.

lastRunDate

date-time

Last run date of subscription.

createdTime

date-time

Time when subscription was created.

modifiedTime

date-time

Time when subscription was modified.

deletedTime

date-time

Time when subscription was deleted.

softDescriptor

object

dbaName

string

length ≤ 38

Doing business as (Dba) for the merchant.

street

string

length ≤ 30

Street of the business address.

city

string

City of the business address.

region

string

length ≤ 2

Region of the business address.

postalCode

string

Postal code of the business address.

countryCode

string

length ≤ 3

Country code of the business.

merchantContactInfo

string

length ≤ 40

Contact details of the merchant.

level2

object

taxAmount

int64

Amount of applicable taxes.

taxIndicator

string

Indicates if the amount is taxable.

UNKNOWN TAXABLE NON_TAXABLE

vatTaxAmount

int64

Amount of applicable value added taxes (VAT).

vatTaxRate

int32

Rate of applicable value added taxes (VAT).

purchaseIdentifier

string

Purchase identifier.

pcOrderNumber

string

Placed order number.

discountAmount

int64

Discounted amount.

freightAmount

int64

Amount spent for freight.

dutyAmount

int64

Amount of duty charges.

destinationPostalCode

string

Postal code of the destination.

shipFromPostalCode

string

Postal code of the origination.

destinationCountryCode

string

Destination country code.

merchantTaxId

string

Tax identifier of the merchant.

productDescription

string

Detailed description of the product.

taxRateUuids

array of strings

taxRateUuids

Language

Credentials

Bearer

URL


xxxxxxxxxx
1
curl --request DELETE \
2
     --url https://sandbox.dev.clover.com/recurring/v1/subscriptions/ \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Delete subscription was successful

defaultUnexpected error.