Cancel a subscription | Prolifi

curl -X DELETE https://api.prolifi.co/api/v1/public/subscriptions/id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "cancel_at": "immediately",
  "reason": "Duplicate subscription"
}'

{
  "data": {
    "id": "string",
    "customer_id": "string",
    "plan_id": "string",
    "plan_name": "string",
    "status": "active",
    "billing_cycle": "string",
    "current_period_start": "2023-01-15",
    "current_period_end": "2023-01-15",
    "start_date": "2023-01-15",
    "billing_date": "2023-01-15",
    "cancel_at": "2024-01-15T09:30:00Z",
    "canceled_at": "2024-01-15T09:30:00Z",
    "pause_start": "2024-01-15T09:30:00Z",
    "pause_end": "2024-01-15T09:30:00Z",
    "pricing": {
      "amount": 1.1,
      "currency": "string",
      "pricing_scheme_id": "string"
    },
    "metadata": {},
    "created_at": "2024-01-15T09:30:00Z",
    "updated_at": "2024-01-15T09:30:00Z"
  }
}

Cancels a subscription. By default, the subscription continues until the end of the current billing period. Set cancel_at to "immediately" for immediate cancellation.

Authentication

AuthorizationBearer

Use a secret key (sk_test_* or sk_live_*) for full read/write access, or a public key (pk_test_* or pk_live_*) for read-only access.

Path parameters

idstringRequiredformat: "uuid"

The unique identifier of the subscription.

Request

This endpoint expects an object.

cancel_atenumOptionalDefaults to end_of_period

When the cancellation takes effect.

reasonstring or nullOptional

Cancellation reason (for records and analytics).

Response

Subscription cancelled successfully

dataobjectOptional

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error