v1

latestOpenAPI 3.0.02026-07-243678114.1 KB

Subscriptions

Cancel Subscription

The Cancel Subscription endpoint allows you to cancel an active subscription within your organization. Use this endpoint to manage and control the lifecycle of your subscriptions effectively.

delete/v1/subscriptions/{subscriptionID}

Path parameters

subscriptionIDstring required

The unique identifier of the subscription to be canceled.

Response

errorboolean

Example response

{
  "data": {
    "created_at": "2023-01-01T12:00:00Z",
    "currency": "USD",
    "customer": {
      "created_at": "2023-01-01T12:00:00Z",
      "deleted_at": "2023-01-05T10:00:00Z",
      "email": "customer@example.com",
      "id": "customer123",
      "name": "John Doe",
      "org_id": "org123",
      "reference": "REF-123456",
      "updated_at": "2023-01-02T09:00:00Z"
    },
    "customer_id": "customer123",
    "id": "sub123",
    "items": [
      {
        "created_at": "2023-01-01T12:00:00Z",
        "id": "item123",
        "plan_id": "plan456",
        "subscription_id": "sub123",
        "updated_at": "2023-01-02T09:00:00Z"
      }
    ],
    "org_id": "org123",
    "reference": "REF-123456",
    "start_at": "2023-01-05T10:00:00Z",
    "updated_at": "2023-01-02T09:00:00Z"
  }
}