General APIs with JWT

Buy one month of the paid API plan from the balance

Changed on

Charges the plan's monthly price from the balance; an active subscription is extended by a month. An Idempotency-Key header makes a retry safe: the same key returns the first answer instead of a second month.

post/api-plans/pro/subscribe

Request

  • Base URL: https://lium.io/api
  • URL: https://lium.io/api/api-plans/pro/subscribe
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Headers

Idempotency-Keystring

Makes a retry safe: within 24 h the same key with the byte-identical body returns the first call's answer with Idempotent-Replayed: true; a different body is 422 idempotency_key_reused; a repeat while the first call runs is 409 idempotency_in_progress; a repeat of a call that may have rented but whose answer was not recorded is 409 idempotency_outcome_unknown, with no expiry.

Response

Successful Response

plan'free' | 'pro' required
display_namestring required
rate_limit_multiplierinteger required
endpointsstring[] required
expires_atstring date-time nullable required
pro_usd_per_monthnumber required

Changes