Update a subscription | Prolifi

curl -X PATCH https://api.prolifi.co/api/v1/public/subscriptions/id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "plan_id": "b2c3d4e5-6789-01bc-def0-2345678901bc",
  "billing_cycle": "monthly"
}'

{
  "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"
  }
}

Updates a subscription. If plan_id is changed, this triggers a plan switch.

For non-plan changes (quantity, metadata), the subscription is updated in place.

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.

plan_idstring or nullOptionalformat: "uuid"

New plan ID (triggers a plan switch).

billing_cyclestring or nullOptional

New billing cycle (used with plan switches).

quantityinteger or nullOptional>=1

metadataobject or nullOptional

Response

Subscription updated successfully

dataobject

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error