Sign in
Account

Buy credits

Purchase additional credits for your organization. Saved-card purchases cost $20.00 per 1,000 credits on a subscription, or $30.00 per 1,000 credits on a pay-as-you-go plan. A one-time payment authorization charges the pay-as-you-go rate. This endpoint immediately charges real money. Confirm with a human operator before calling it from an agent.

<span>⚡ <strong>Rate limit:</strong> 2 requests per 1 minute</span>

<span>💰 <strong>Cost:</strong> FREE! No credits are charged for this API. <span title="Pricing shown is default pricing. Actual pricing may vary.">ⓘ</span></span>

post/v1/buy-credits

Request body

apiKeystring required

Your Fiber API key

subscriptionIdstring nullable

The subscription to add credits to. Required when the organization has more than one subscription, or when charging a saved payment method. Must be omitted when paying with a one-time payment authorization; sending both is rejected.

creditsToBuyinteger required

Number of credits to purchase. One-time payment authorizations require at least 100 credits. Saved-card purchases require at least 1,000 credits.

sharedPaymentGrantedTokenstring nullable

A one-time payment authorization from your payment provider. When set, this purchase charges that authorization instead of a saved card. Each purchase needs a freshly minted authorization.

idempotencyKeystring nullable

A unique key to safely retry a purchase. If a request fails or times out, resend with the same key to avoid being charged twice. When omitted, each call is a new purchase.

Response

Default Response

advicestring[] nullable

Tips, recommendations, and suggestions for using this API effectively.

Changes

Changed in 2 of the 11 revisions of this API.316

  • f8a78c729da915See the full diff
    • ●

      removed the optional property outOfCreditsAlert from the response with the 402 status

      response-optional-property-removed

    • ○

      added the new optional request property sharedPaymentGrantedToken

      new-optional-request-property

    • ○

      the request property subscriptionId became nullable

      request-property-became-nullable

    • ○

      the request property subscriptionId became optional

      request-property-became-optional

    • ○

      the creditsToBuy request property's min was decreased from 1000.00 to 100.00

      request-property-min-decreased

    • ○

      added the optional property declineCode to the response with the 402 status

      response-optional-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 4002aa81d4fb31See the full diff
    • ▲

      added the new required request property subscriptionId

      new-required-request-property

    • ▲

      the response property advice became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property advice became optional for the status 200

      response-property-became-optional

    • ○

      the advice response's property default value was removed for the status 200

      response-property-default-value-removed