Sign in

v1

latestOpenAPI 3.0.02026-07-1498163181.9 KB
Subscriptions

Cancel a subscription immediately

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

post/api/v1/subscriptions/{id}/end

Path parameters

idstring required

Request body

cancellationCommentstring

Response

idstring required
createdAtstring date-time
updatedAtstring date-time
organizationIdstring uuid
tagsstring[]
clientReferenceIdstring
currency'usdc' | 'usdt' | 'pyusd' | 'eurc' | 'brett' | 'dai' | 'btc' | 'eth' | 'matic' | 'bnb' | 'sol' | 'busd' | 'trx' | 'food' | 'bonk' | 'wif' | 'goat' | 'spx' | 'truf' | 'pengu' required
collectionMethod'superfluid' | 'charge_automatically' | 'send_invoice'
interval'day' | 'week' | 'month' | 'year' required
intervalCountnumber
paymentMethodTypesPaymentMethodType[]
status'incomplete' | 'incomplete_expired' | 'trialing' | 'active' | 'past_due' | 'canceled' | 'unpaid' | 'paused' required
descriptionstring
metadataobject
defaultPaymentMethodIdstring uuid
customerIdstring uuid
startDatestring date-time
endedAtstring date-time
cancelAtstring date-time
canceledAtstring date-time
cancellationReasonstring
currentPeriodEndstring date-time
currentPeriodStartstring date-time
cancelAtPeriodEndboolean

Example response

{
  "organizationId": "c3611c05-df51-4b47-b601-f2eac02f4ef0",
  "intervalCount": 1,
  "defaultPaymentMethodId": "c3611c05-df51-4b47-b601-f2eac02f4ef0",
  "defaultPaymentMethod": {
    "assetId": "c3611c05-df51-4b47-b601-f2eac02f4ef0",
    "asset": {
      "chainId": 1,
      "decimals": 1,
      "superToken": {
        "decimals": 1
      }
    },
    "customerId": "c3611c05-df51-4b47-b601-f2eac02f4ef0"
  },
  "customerId": "c3611c05-df51-4b47-b601-f2eac02f4ef0",
  "customer": {
    "id": "c3611c05-df51-4b47-b601-f2eac02f4ef0",
    "taxIds": {
      "data": [
        {
          "customerId": "c3611c05-df51-4b47-b601-f2eac02f4ef0"
        }
      ]
    }
  },
  "lineItems": {
    "data": [
      {
        "quantity": 1,
        "price": {
          "productId": "c3611c05-df51-4b47-b601-f2eac02f4ef0",
          "intervalCount": 1,
          "product": {
            "defaultPriceId": "c3611c05-df51-4b47-b601-f2eac02f4ef0"
          }
        },
        "taxRates": [
          {
            "percentage": 1
          }
        ]
      }
    ]
  }
}