BillKit/DocsConsole
Subscriptions

Preview update subscription

Quote what moving a subscription to another price would cost now.

POST/v1/subscriptions/{subscription_id}/preview_update
Operation preview_update_subscription·Scope subscriptions:read·OpenAPI v1.1.0

Parameters

ParameterDescription
subscription_idstring · pathrequiredId of the subscription, which starts sub_.
target_price_idstringrequiredId of the price to quote a move to. It and its product must be active, in the subscription's currency and not metered, and it must differ from the current price.

Returns

Returns a PlanChangePreviewResponse object.

Errors

StatusCause
400The request was refused (type: invalid_request_error): a required parameter is missing (parameter_missing), one failed validation (parameter_invalid) or is not one the operation takes (parameter_unknown), and param names it.
401No credential, or one that does not authenticate.
402The account is suspended (tenant_suspended), or the payment provider refused a charge or refund the call made (type: payment_error, code: payment_refused).
403Authenticated, but not allowed: missing scope (insufficient_scope), a key of the wrong mode (mode_mismatch), or a refused origin. Needs the subscriptions:read scope.
404No such object in this account and mode.
409Conflicts with the object's current state (state_conflict, or a more specific code), or an operation still in flight (operation_pending).
413The request body is larger than the API accepts.
429Rate limited. Retry-After says when to try again.
500Something failed on BillKit's side (type: api_error). Retry with the same Idempotency-Key.
502The payment provider failed or did not answer.
503Temporarily unable to serve. reason says whether the request was attempted.
Request · curl
curl -X POST https://api.billkit.eu/v1/subscriptions/sub_9XKp2vQ1/preview_update \
  -H "Authorization: Bearer $BILLKIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"target_price_id":"price_9XKp2vQ1"}'
Response · 200 OK
{
  "charge_cents": 1900,
  "charge_net_cents": 1900,
  "charge_tax_cents": 1900,
  "credit_cents": 1900,
  "currency": "EUR",
  "new_period_end": 0,
  "object": "plan_change_preview",
  "proration_at": 1789392000,
  "refusal_reason": "renewal_imminent",
  "refused": false,
  "target_price_cents": 1900,
  "target_price_id": "price_9XKp2vQ1"
}