Subscription

Start Contract

Changed on

Collect the customer's card and start the custom plan staff loaded for their org.

post/v1/subscription/start-contract

Request

  • Base URL
    https://api.getbluejay.ai
  • URL
    https://api.getbluejay.ai/v1/subscription/start-contract
  • Auth
    HTTPBearer (a scheme the document does not define)

Headers

X-Organization-Idstring
X-API-Keystring required

API key required to authenticate requests.

Request body

payment_method_idstring nullable

Stripe payment method ID; omit to reuse the org's existing default card

Response

Successful Response

successboolean required

Whether the signup was successful

messagestring required

Response message

effective_atstring nullable

When a scheduled plan change takes effect (ISO 8601); null means immediate

Changes