Preview pending charges that will bill on the final invoice if not waived

curl --request GET \
  --url https://api.example.com/api/v1/workspaces/{workspace_id}/billing/cancel/preview \
  --header 'X-API-Key: <api-key>'

{
  "currency": "<string>",
  "next_invoice_date": "2023-11-07T05:31:56Z",
  "pending_items": [
    {
      "amount": 123,
      "description": "<string>",
      "id": "<string>",
      "period_end": "2023-11-07T05:31:56Z",
      "period_start": "2023-11-07T05:31:56Z"
    }
  ],
  "pending_total": 123
}

billing

Preview pending charges that will bill on the final invoice if not waived

Return the queued (uninvoiced) Stripe invoice items for this workspace’s customer.

Used by CancelPanel to surface orphan prorations BEFORE the user confirms cancellation — a queued $134 charge from a prior plan-switch will still flush onto the final cycle invoice unless explicitly waived via cancel?waive_pending_charges=true.

Implementation note: uses InvoiceItem.list(pending=True) directly rather than Invoice.create_preview because the latter conflates renewal recurring line items with prorations and requires brittle line-flag classification on Stripe API 2025-03-31.basil (see comment on preview_change_plan).

GET

api

workspaces

{workspace_id}

billing

cancel

preview

Preview pending charges that will bill on the final invoice if not waived

curl --request GET \
  --url https://api.example.com/api/v1/workspaces/{workspace_id}/billing/cancel/preview \
  --header 'X-API-Key: <api-key>'

{
  "currency": "<string>",
  "next_invoice_date": "2023-11-07T05:31:56Z",
  "pending_items": [
    {
      "amount": 123,
      "description": "<string>",
      "id": "<string>",
      "period_end": "2023-11-07T05:31:56Z",
      "period_start": "2023-11-07T05:31:56Z"
    }
  ],
  "pending_total": 123
}

Authorizations

X-API-Key

string

header

required

Headers

X-Workspace-Id

string | null

Path Parameters

workspace_id

string<uuid>

required

Cookies

riftmap_access

string | null

Response

Successful Response

Pending charges that will be billed on the final cycle invoice if not waived.

pending_total includes credits (negative items); pending_items shows only positive lines so the UI surfaces what the user will actually pay.

currency

string

required

next_invoice_date

string<date-time> | null

required

pending_items

PendingInvoiceItem · object[]

required

Show child attributes

pending_total

integer

required

Cancel Subscription Change Plan