billing
billing

Get Billing Status

get/api/v1/billing/status

Request

  • Base URL: https://api.peil.app (the document declares no server; this is the origin it was published from)
  • URL: https://api.peil.app/api/v1/billing/status
  • Auth: OAuth 2 (password, token URL /api/v1/auth/jwt/login)

Response

Successful Response

planstring required
statusstring required
billing_configuredboolean required
pro_sourcestring nullable
is_founderboolean
grantobject nullable
trialobject nullable
eligible_termsstring[]
provider_statusstring nullable required
payment_statusstring nullable required
mollie_customer_idstring nullable required
mollie_subscription_idstring nullable required
current_period_endstring nullable required
cancel_at_period_endboolean required
cancelled_atstring nullable required
last_failure_reasonstring nullable required
payment_methodstring nullable
billing_intervalstring
billing_visibleboolean
needs_reconciliationboolean required

Changes

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