Subscription

Signup

Changed on

Create subscription: Stripe customer + Metronome customer + contract.

post/v1/subscription/signup

Request

  • Base URL
    https://api.getbluejay.ai
  • URL
    https://api.getbluejay.ai/v1/subscription/signup
  • 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

package_idstring required

Metronome Package ID

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

  • aa501502e1fcRevision changes
    • info

      added the new optional header request parameter X-Organization-Id

  • 44d183272ce1Revision changes
    • info

      the request property became optional

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      added the optional property to the response with the status