Billing

Create or validate a hosted plan purchase choice

Returns canonical plan, price, trial, payment, and expiry facts in an integrity-protected continuation token.

post/billing/purchase-choice

Request

  • Base URL: https://app.openpo.st/api/v1
  • URL: https://app.openpo.st/api/v1/billing/purchase-choice
  • Auth: none required

Request body

$schemastring uri

A URL to the JSON Schema for this object.

billing_period'monthly' | 'annual' required

Canonical billing period

plan_idstring required

Canonical hosted plan ID: founder (Solo), team, or agency

purchase_choice_tokenstring

Existing integrity-protected choice to validate against the supplied plan and period

Example request

{
  "$schema": "https://example.com/api/v1/schemas/CreatePurchaseChoiceInputBody.json"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

billing_period'monthly' | 'annual' required

Canonical billing period

card_requiredboolean required

Whether checkout requires a payment card for the trial

catalog_versionstring required

Canonical plan catalogue revision bound to the choice

due_today_usdinteger required

Canonical USD amount due when the trial starts

expires_atstring date-time required

When this purchase choice must be replaced

list_price_usdinteger required

Full-period canonical USD list price

plan_idstring required

Canonical hosted plan ID

plan_namestring required

Canonical hosted plan name

tokenstring required

Integrity-protected purchase choice continuation token

trial_daysinteger required

Trial length in calendar days

Example response

{
  "$schema": "https://example.com/api/v1/schemas/PurchaseChoiceResponse.json"
}

Changes

No recorded changes to this operation across all 1 revision of this API.