Sign in
organizations

Changed on

Return whether the organization may claim the bonus, and its amount.

Read-only — never creates or modifies billing state. The eligibility check may perform outbound Stripe reads to verify abandonment.

get/v1/organizations/billing/checkout-bonus/

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP bearer
    • API key in cookie sessionid
    • API key in header X-Session-Token

Headers

Vellum-Organization-Idstring uuid

Required if using Cookie-based or X-Session-Token authentication methods.

Response

eligibleboolean required
amount_usdstring required

Changes