Cancel subscription

cURL

curl -X PUT \
 /subscriptions/{id}/cancel \
 --header "Content-Type: application/json" \
 --header "Authorization: Bearer <token>" \
 --data '{
    "cancellationDateType": "next_possible",
    "cancellationDate": "2022-12-31",
    "sendConfirmationEmail": "1",
    "reason": ""
}'

import requests

url = "https://coreapi.io/subscriptions/{id}/cancel"

payload = {
    "cancellationDateType": "next_possible",
    "cancellationDate": "2022-12-31",
    "sendConfirmationEmail": True,
    "reason": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    cancellationDateType: 'next_possible',
    cancellationDate: '2022-12-31',
    sendConfirmationEmail: true,
    reason: '<string>'
  })
};

fetch('https://coreapi.io/subscriptions/{id}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://coreapi.io/subscriptions/{id}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'cancellationDateType' => 'next_possible',
    'cancellationDate' => '2022-12-31',
    'sendConfirmationEmail' => true,
    'reason' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
  "externalId": "<string>",
  "paymentMethod": {
    "id": "c1a2b3c4-d5e6-4f7a-8b9b-0c1d2e3f4a5b",
    "gatewayName": "wallet",
    "type": "sepa_debit",
    "default": true,
    "status": "active",
    "enabled": true,
    "name": "Visa (4242)",
    "creationDate": "2024-01-15T10:30:00+00:00",
    "expirationDate": "2026-12-31T23:59:59+00:00",
    "card": {
      "brand": "Visa",
      "last4": "4242",
      "expMonth": 12,
      "expYear": 2022,
      "cardHolder": "Max Mustermann"
    },
    "sepaDebit": {
      "iban": "DE8937*********3232",
      "bic": "COBADEFFXXX",
      "mandateReference": "MNDT-2021-123456",
      "signingDate": "2021-01-01T00:00:00+00:00"
    },
    "paypal": {
      "email": "max@mustermann.de",
      "billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
    }
  },
  "invoiceAddress": {
    "id": "<string>",
    "vatId": "DE123456789",
    "type": "TYPE_DEFAULT",
    "default": "true",
    "status": "active",
    "city": "Berlin",
    "zip": "12345",
    "street": "Musterstraße",
    "houseNumber": "1a",
    "countryCode": "DE",
    "companyName": "ACME Inc.",
    "salutation": "Herr",
    "addition": "c/o John Doe",
    "costCentre": "123456789",
    "firstName": "John",
    "lastName": "Doe"
  },
  "number": "S-00000001",
  "customer": {
    "id": "00000000-0000-0000-0000-000000000000",
    "customerNumber": "CUSTOMER-000",
    "timeZone": "Europe/Berlin",
    "firstName": "John",
    "lastName": "Doe",
    "currencyCode": "EUR",
    "companyName": "Acme Inc.",
    "datevId": "123456789",
    "status": "STATUS_ACTIVE"
  },
  "plan": {
    "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
    "family": {
      "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
      "createdAt": "2021-01-01T00:00:00+00:00",
      "updatedAt": "2021-01-01T00:00:00+00:00"
    },
    "code": "basic-m2023",
    "originProduct": {
      "type": "product",
      "measurement": {
        "unit": {
          "id": {},
          "name": "Stück",
          "createdAt": "2021-01-01T00:00:00+00:00",
          "updatedAt": "2021-01-01T00:00:00+00:00"
        },
        "code": "users",
        "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
        "description": "The number of users.",
        "aggregationType": "sum",
        "fairBilling": true,
        "type": "recurring"
      },
      "taxGroup": {},
      "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
      "name": "Basic",
      "description": "For small teams.",
      "internalName": "Basic (Weekly)",
      "invoiceVisibility": "always",
      "costCentre": {},
      "costCentre2": {},
      "customFields": {
        "field1": "value1",
        "field2": "value2"
      }
    },
    "allowCheckout": true,
    "status": "draft",
    "changeBehaviour": "upgradeable_and_downgradeable",
    "changeApplyBehaviour": "end_of_period",
    "createdAt": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "description": "<string>"
  },
  "name": "Fitness M",
  "billingGroup": {},
  "periods": [
    {
      "id": "<string>",
      "contractPeriodCount": 123,
      "contractPeriod": {},
      "cancellationPeriod": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "status": "active",
  "activatedAt": "2021-01-01T00:00:00+00:00",
  "poNumber": "PO-00000001",
  "contractDetails": {
    "contractStart": "2023-11-07T05:31:56Z",
    "contractEnd": "2023-11-07T05:31:56Z"
  },
  "trialEndsOn": "2021-01-01T00:00:00+00:00",
  "customFields": {
    "field1": "value1",
    "field2": "value2"
  },
  "createdAt": "2021-01-01T00:00:00+00:00",
  "updatedAt": "2021-01-01T00:00:00+00:00",
  "defaultPaymentMethod": true,
  "defaultInvoiceAddress": true,
  "nextBillingDate": "2023-11-07T05:31:56Z",
  "lastBillingAt": "2023-11-07T05:31:56Z",
  "cancellationDate": "2023-11-07T05:31:56Z",
  "cancelledAt": "2023-11-07T05:31:56Z",
  "isCancellationPending": true,
  "nextPossibleCancellationDate": [
    "<string>"
  ],
  "partner": {
    "id": "ad8f7e7d-3b3b-4b3b-8b3b-3b3b3b3b3b3b",
    "name": "John Doe",
    "number": "123456",
    "email": "partner@example.com"
  }
}

PUT

subscriptions

{id}

cancel

cURL

curl -X PUT \
 /subscriptions/{id}/cancel \
 --header "Content-Type: application/json" \
 --header "Authorization: Bearer <token>" \
 --data '{
    "cancellationDateType": "next_possible",
    "cancellationDate": "2022-12-31",
    "sendConfirmationEmail": "1",
    "reason": ""
}'

import requests

url = "https://coreapi.io/subscriptions/{id}/cancel"

payload = {
    "cancellationDateType": "next_possible",
    "cancellationDate": "2022-12-31",
    "sendConfirmationEmail": True,
    "reason": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    cancellationDateType: 'next_possible',
    cancellationDate: '2022-12-31',
    sendConfirmationEmail: true,
    reason: '<string>'
  })
};

fetch('https://coreapi.io/subscriptions/{id}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://coreapi.io/subscriptions/{id}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'cancellationDateType' => 'next_possible',
    'cancellationDate' => '2022-12-31',
    'sendConfirmationEmail' => true,
    'reason' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
  "externalId": "<string>",
  "paymentMethod": {
    "id": "c1a2b3c4-d5e6-4f7a-8b9b-0c1d2e3f4a5b",
    "gatewayName": "wallet",
    "type": "sepa_debit",
    "default": true,
    "status": "active",
    "enabled": true,
    "name": "Visa (4242)",
    "creationDate": "2024-01-15T10:30:00+00:00",
    "expirationDate": "2026-12-31T23:59:59+00:00",
    "card": {
      "brand": "Visa",
      "last4": "4242",
      "expMonth": 12,
      "expYear": 2022,
      "cardHolder": "Max Mustermann"
    },
    "sepaDebit": {
      "iban": "DE8937*********3232",
      "bic": "COBADEFFXXX",
      "mandateReference": "MNDT-2021-123456",
      "signingDate": "2021-01-01T00:00:00+00:00"
    },
    "paypal": {
      "email": "max@mustermann.de",
      "billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
    }
  },
  "invoiceAddress": {
    "id": "<string>",
    "vatId": "DE123456789",
    "type": "TYPE_DEFAULT",
    "default": "true",
    "status": "active",
    "city": "Berlin",
    "zip": "12345",
    "street": "Musterstraße",
    "houseNumber": "1a",
    "countryCode": "DE",
    "companyName": "ACME Inc.",
    "salutation": "Herr",
    "addition": "c/o John Doe",
    "costCentre": "123456789",
    "firstName": "John",
    "lastName": "Doe"
  },
  "number": "S-00000001",
  "customer": {
    "id": "00000000-0000-0000-0000-000000000000",
    "customerNumber": "CUSTOMER-000",
    "timeZone": "Europe/Berlin",
    "firstName": "John",
    "lastName": "Doe",
    "currencyCode": "EUR",
    "companyName": "Acme Inc.",
    "datevId": "123456789",
    "status": "STATUS_ACTIVE"
  },
  "plan": {
    "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
    "family": {
      "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
      "createdAt": "2021-01-01T00:00:00+00:00",
      "updatedAt": "2021-01-01T00:00:00+00:00"
    },
    "code": "basic-m2023",
    "originProduct": {
      "type": "product",
      "measurement": {
        "unit": {
          "id": {},
          "name": "Stück",
          "createdAt": "2021-01-01T00:00:00+00:00",
          "updatedAt": "2021-01-01T00:00:00+00:00"
        },
        "code": "users",
        "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
        "description": "The number of users.",
        "aggregationType": "sum",
        "fairBilling": true,
        "type": "recurring"
      },
      "taxGroup": {},
      "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
      "name": "Basic",
      "description": "For small teams.",
      "internalName": "Basic (Weekly)",
      "invoiceVisibility": "always",
      "costCentre": {},
      "costCentre2": {},
      "customFields": {
        "field1": "value1",
        "field2": "value2"
      }
    },
    "allowCheckout": true,
    "status": "draft",
    "changeBehaviour": "upgradeable_and_downgradeable",
    "changeApplyBehaviour": "end_of_period",
    "createdAt": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "description": "<string>"
  },
  "name": "Fitness M",
  "billingGroup": {},
  "periods": [
    {
      "id": "<string>",
      "contractPeriodCount": 123,
      "contractPeriod": {},
      "cancellationPeriod": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "status": "active",
  "activatedAt": "2021-01-01T00:00:00+00:00",
  "poNumber": "PO-00000001",
  "contractDetails": {
    "contractStart": "2023-11-07T05:31:56Z",
    "contractEnd": "2023-11-07T05:31:56Z"
  },
  "trialEndsOn": "2021-01-01T00:00:00+00:00",
  "customFields": {
    "field1": "value1",
    "field2": "value2"
  },
  "createdAt": "2021-01-01T00:00:00+00:00",
  "updatedAt": "2021-01-01T00:00:00+00:00",
  "defaultPaymentMethod": true,
  "defaultInvoiceAddress": true,
  "nextBillingDate": "2023-11-07T05:31:56Z",
  "lastBillingAt": "2023-11-07T05:31:56Z",
  "cancellationDate": "2023-11-07T05:31:56Z",
  "cancelledAt": "2023-11-07T05:31:56Z",
  "isCancellationPending": true,
  "nextPossibleCancellationDate": [
    "<string>"
  ],
  "partner": {
    "id": "ad8f7e7d-3b3b-4b3b-8b3b-3b3b3b3b3b3b",
    "name": "John Doe",
    "number": "123456",
    "email": "partner@example.com"
  }
}

Autorisierungen

Authorization

string

header

erforderlich

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Pfadparameter

string

erforderlich

Subscription identifier

Body

The updated Subscription resource

cancellationDateType

enum<string>

The type how the cancellation date should be interpreted.

Verfügbare Optionen:

immediate,

next_possible,

custom

Beispiel:

"next_possible"

cancellationDate

string<date-time> | null

The date when the subscription should be cancelled. Required if the type is custom.

Beispiel:

"2022-12-31"

sendConfirmationEmail

boolean

If the confirmation email should be sent to the customer.

Beispiel:

true

reason

string | null

The reason code why the subscription should be cancelled.

Antwort

Subscription resource updated

string

read-only

Beispiel:

"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b"

externalId

string | null

paymentMethod

object | null

The payment method of the subscription. If null, the default payment method of the customer is used.

Show child attributes

invoiceAddress

object | null

The invoice address of the subscription. If null, the default invoice address of the customer is used.

Show child attributes

number

string

The number of the subscription.

Beispiel:

"S-00000001"

customer

object

Show child attributes

plan

object | null

The plan this subscription is based on.

Show child attributes

name

string | null

The name of the subscription. Defaults to the name of the plan. This will be used in the invoice for the grouping headers.

Beispiel:

"Fitness M"

billingGroup

object | null

The billing group defines the billing cycle of the subscription.

periods

object[]

Show child attributes

status

any

read-only

The status of the subscription.

Possible values:

draft: The subscription is in draft mode and not active yet.
active: The subscription is active and will be billed.
paused: The subscription is paused and will not be billed.
cancelled: The subscription is cancelled and will not be billed anymore.
terminated: The subscription is terminated and will not be billed anymore.
offer: The subscription is an offer and waiting for acceptance.

Beispiel:

"active"

activatedAt

string<date-time> | null

read-only

The date the subscription was activated.

Beispiel:

"2021-01-01T00:00:00+00:00"

poNumber

string | null

The po number of the subscription.

Beispiel:

"PO-00000001"

contractDetails

object

The contract details of the subscription.

Show child attributes

trialEndsOn

string<date-time> | null

read-only

The date the trial period ends.

Beispiel:

"2021-01-01T00:00:00+00:00"

customFields

object | null

Custom fields for the entity. The keys are the field names and the values are the field values. They need to be configured under "/custom-fields" in the API documentation. The input is validated against the configuration. For more details see Custom Fields Guide

Show child attributes

Beispiel:

{ "field1": "value1", "field2": "value2" }

createdAt

string<date-time>

read-only

The date and time when the resource was created.

Beispiel:

"2021-01-01T00:00:00+00:00"

updatedAt

string<date-time>

read-only

The date and time when the resource was last updated.

Beispiel:

"2021-01-01T00:00:00+00:00"

defaultPaymentMethod

boolean

read-only

The payment method is null, we use the default payment method of the customer.

defaultInvoiceAddress

boolean

read-only

The invoice address is null, we use the default invoice address of the customer.

nextBillingDate

string<date-time> | null

read-only

The next billing date of the subscription.

lastBillingAt

string<date-time> | null

read-only

The last billing date of the subscription.

cancellationDate

string<date-time> | null

read-only

The date the subscription will be cancelled.

cancelledAt

string<date-time> | null

read-only

The date when the subscription was cancelled.

isCancellationPending

boolean

read-only

Indicates if the subscription is pending for cancellation. If true, the subscription will be cancelled in the future and the cancellation could be revoked.

nextPossibleCancellationDate

string[] | null

read-only

partner

object | null

The partner of the customer.

Show child attributes

API documentation

User

Tenant

Customer

Catalogue

Subscription

Invoice

Payment

Dunning

Offer

Checkout

Feature & Entitlement

Analytics

Accounting

Settings

Cancel subscription

Autorisierungen

Pfadparameter

Body

Antwort