Billing

Consumer withdrawal state for this account

What was declared at checkout, when the 14-day withdrawal window closes, and whether a withdrawal is already on file. Reports the deadline even once it has passed and even where the right was waived. declarations is returned in the requested language where a translation exists (Czech today; English otherwise), falling back to the account's default language when none is requested.

get/v1/billing/withdrawal

Request

  • Base URL: https://api.briefgate.dev
  • URL: https://api.briefgate.dev/v1/billing/withdrawal
  • Auth: HTTP bearer

Query parameters

language'cs' | 'sk' | 'pl' | 'de' | 'es' | 'en'

Language to return declarations in — the interface language the checkout form will show them in, so that the same value can be sent as language to POST /v1/billing/checkout and the record matches what the buyer saw.

Response

Withdrawal state

applicableboolean

False when there is nothing to withdraw from. True on a paid plan, and also true on the free plan while a deferred-start subscription (see /v1/billing/checkout) is trialling — the contract already exists even though paid access has not started yet.

customer_type'consumer' | 'business' | 'undeclared'
withdrawal_waivedboolean
consent_textstring nullable

The exact sentence agreed to, stored verbatim.

consent_language'cs' | 'sk' | 'pl' | 'de' | 'es' | 'en' nullable

Language consent_text was actually shown in at the time it was agreed to. Null when no consent is on file yet.

consent_recorded_atstring date-time nullable
subscription_started_atstring date-time nullable
window_daysinteger
deadlinestring date-time nullable
within_windowboolean
pending_requestobject nullable

Changes

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