What "Choose a different plan" will void, before the customer confirms.

POST

/billing/subscription/start-over/preview

curl --request POST \
  --url https://api.siteqwality.com/billing/subscription/start-over/preview \
  --header 'Authorization: Bearer <token>'

• Production

Authorizations

• bearer_auth

Responses

200

The invoices the start over voids

Media type application/json

object

invoices

required

Voided by the start over, oldest first: nothing more is owed on them.

Array<object>

One invoice “Choose a different plan” voids.

object

id

required

string

number

string | null

created

required

Unix seconds.

integer format: int64

amount_cents

required

Left to pay on it, minor units.

integer format: int64

currency

required

ISO 4217, uppercase.

string

status

required

string

amount_cents

required

What is left to pay on them together, minor units.

integer format: int64

currency

ISO 4217, uppercase; null when nothing is outstanding.

string | null

Example ^generated

{
  "invoices": [
    {
      "id": "example",
      "number": "example",
      "created": 1,
      "amount_cents": 1,
      "currency": "example",
      "status": "example"
    }
  ],
  "amount_cents": 1,
  "currency": "example"
}

401

Missing or invalid authentication

403

Caller has no billing role

409

The plan is not unpaid

500

Internal server error