Skip to content
Open appBook a five-day pilot

Migrate grandfathered account to a paid plan

POST/api/v1/billing/migrate-from-grandfathered

Create a Stripe Checkout session to move from a grandfathered plan to a paid plan.

Request Body:

  • target_plan: Plan tier to migrate to (self_directed or managed)
  • success_url: Redirect URL after successful payment
  • cancel_url: Redirect URL if checkout is canceled

Prerequisites:

  • Business must currently be on the grandfathered plan tier

Effect:

  • Creates a Stripe Checkout session
  • On payment completion, plan_tier is updated to the target plan

Returns: Checkout URL and session ID.

Operation ID: migrate_from_grandfathered·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Request body

Schema: GrandfatheredMigrateRequest

target_planstringrequired

Target plan tier: 'self_directed' or 'managed'.

success_urlstringrequired

URL to redirect after successful payment.

cancel_urlstringrequired

URL to redirect if checkout is canceled.

billing_intervalstring

Billing cadence: 'month' or discounted annual 'year'.

One of: month, year

Responses

201Successful Response

Schema: SuccessEnvelope_MigrateFromGrandfatheredResponse_

successboolean
messagestring
codestring
dataMigrateFromGrandfatheredResponse

400Bad Request - Invalid input

Schema: ErrorResponse

errorstringrequired

Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.

messagestringrequired

Human-readable explanation, safe to show to end users.

codestringrequired

Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).

request_idstring

Correlation id for support requests. Echoes the x-request-id request header when one was supplied.

errorsobject

Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

401Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business

Schema: ErrorResponse

errorstringrequired

Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.

messagestringrequired

Human-readable explanation, safe to show to end users.

codestringrequired

Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).

request_idstring

Correlation id for support requests. Echoes the x-request-id request header when one was supplied.

errorsobject

Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

403Forbidden - Insufficient permissions

Schema: ErrorResponse

errorstringrequired

Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.

messagestringrequired

Human-readable explanation, safe to show to end users.

codestringrequired

Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).

request_idstring

Correlation id for support requests. Echoes the x-request-id request header when one was supplied.

errorsobject

Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

422Validation Error

Schema: ErrorResponse

errorstringrequired

Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.

messagestringrequired

Human-readable explanation, safe to show to end users.

codestringrequired

Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).

request_idstring

Correlation id for support requests. Echoes the x-request-id request header when one was supplied.

errorsobject

Field-level validation messages keyed by field name. Present on 400/422 validation failures only.