Billing

Get billing status

get/billing/status

Request

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

Query parameters

workspace_idstring

Workspace ID

organization_idstring

Organization ID

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

access_restrictedboolean required

Whether failed payment currently restricts paid-plan access

billing_contact_emailstring

Billing contact email from the latest Paddle customer snapshot

can_manage_billingboolean required

Whether the current user may manage organization billing

cancel_at_period_endboolean required

Whether the subscription cancels at period end

current_period_endstring

Current billing period end

limitsobject

Entitlement limits from the local subscription snapshot

organization_idstring required

Organization ID

past_due_sincestring

Canonical Paddle time when the current past-due state began

period_startstring

UTC month start for the usage counters

plan_idstring

Plan ID

providerstring

Billing provider

statusstring

Subscription status from the latest Paddle snapshot

usageobject

Current-month product usage counters for a mirrored subscription

workspace_idstring required

Workspace ID

Example response

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

Changes

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