Cancel a subscription immediately

post https://api.copperx.dev/api/v1/subscriptions/{id}/end

Cancel a subscription. It ends the subscription immediately and no refund is made.

Responses

Response body

object

string

required

createdAt

date-time

updatedAt

date-time

organizationId

uuid

tags

clientReferenceId

string

currency

string

required

usdc usdt pyusd eurc brett dai btc eth matic bnb sol busd trx food bonk wif goat spx truf pengu

collectionMethod

string

superfluid charge_automatically send_invoice

interval

string

required

day week month year

intervalCount

number

paymentMethodTypes

array of strings

paymentMethodTypes

status

string

required

incomplete incomplete_expired trialing active past_due canceled unpaid paused

description

string

metadata

object

Has additional fields

defaultPaymentMethodId

uuid

defaultPaymentMethod

object

string

required

createdAt

date-time

updatedAt

date-time

assetId

uuid

required

asset

object

required

type

string

required

superfluid wallet allowance_based_recurring stripe binance_pay

accountAddress

string

billingDetails

object

customerId

uuid

options

object

Has additional fields

customerId

uuid

customer

object

name

string

The name

string

The email

phone

string

The phone

organizationName

string

The organization name

address

object

The address

uuid

required

Customer's id

createdAt

date-time

Customer's created at

updatedAt

date-time

Customer's updated at

customerReferenceId

string

Customer's reference id

shipping

object

Customer's shipping address

taxIds

object

visibility

string

Customer's visibility. If Dashboard then displayed on dashboard UI. If API then only returned in API response only.

10 20

metadata

object

Customer's metadata

Has additional fields

customerNumber

string

required

Customer number assigned by the system

startDate

date-time

endedAt

date-time

cancelAt

date-time

canceledAt

date-time

lineItems

object

required

object

string

data

array of objects

data

object

description

string

quantity

number

price

object

required

taxRates

array of objects

taxRates

object

string

required

name

string

required

The name of the tax rate.

description

string

The description of the tax rate.

country

string

The country of the tax rate.

percentage

number

required

0 to 100

Percent that will be added to subtotal as a tax.

type

string

required

The type of the tax rate.

exclusive inclusive

isDefault

boolean

required

amountTotal

int64

amountSubtotal

int64

amountTax

int64

currency

string

usdc usdt pyusd eurc brett dai btc eth matic bnb sol busd trx food bonk wif goat spx truf pengu usd inr

cancellationReason

string

currentPeriodEnd

date-time

currentPeriodStart

date-time

cancelAtPeriodEnd

boolean

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.copperx.dev/api/v1/subscriptions/id/end \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

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

application/json

200

500