Billing

Create billing portal session

post/billing/portal

Request

  • Base URL: https://app.openpo.st/api/v1
  • URL: https://app.openpo.st/api/v1/billing/portal
  • Auth: one of:
    • HTTP bearer
    • API key in cookie openpost_session

Request body

$schemastring uri

A URL to the JSON Schema for this object.

organization_idstring

Organization ID

purpose'manage' | 'update_payment_method' | 'cancel_subscription' | 'invoices' | 'billing_details'

Portal destination

workspace_idstring

Workspace ID

Example request

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

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

billing_periodstring

Selected billing period

client_tokenstring

Browser-safe Paddle.js client token

customer_emailstring

Authenticated customer's checkout email

environmentstring

Explicit Paddle.js environment: sandbox or production

idstring

OpenPost checkout attempt or Paddle portal session ID

plan_idstring

OpenPost plan ID

price_idsobject

Paddle price IDs for localized previews in the selected billing period

provider_price_idstring

Paddle price ID for the selected plan and period

purposestring

Requested Paddle portal destination

return_urlstring

OpenPost URL used after Paddle checkout completes

trial_ends_atstring

Expected end of the 14-day trial

urlstring

OpenPost checkout URL or short-lived Paddle customer portal URL

used_generic_fallbackboolean

Whether Paddle omitted the purpose-specific link and OpenPost returned the generic portal

workspace_idstring

Workspace bound to this checkout attempt

Example response

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

Changes

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