Cancel subscription

If the subscription has no non-draft invoices it is hard-deleted; otherwise it is cancelled (status=cancelled, cancelled timestamp set) and a cancel_reason is recorded (defaults to not_specified).

DELETE /subscriptions/{id}

Cancel subscription

cURL

curl --request DELETE \
  --url https://api.piriod.com/subscriptions/{id}/ \
  --header 'Authorization: <api-key>' \
  --header 'x-simple-workspace: <x-simple-workspace>'

Authorizations

Authorization · string · header · required

Use header Authorization: Token <api_token>. API tokens are obtained from the Piriod dashboard.

Headers

x-simple-workspace · string · required

Workspace (account) identifier. Required for every request.

x-piriod-test-mode · boolean · default: false

Whether to operate against test-mode data. Defaults to false.

Path Parameters

id · string · required

Resource identifier.

Query Parameters

cancel_reason_description · string

Response

204

Cancelled or deleted.