Billing

Enable or update auto-refill

Changed on

When the balance is below threshold_credits, the worker charges the pack on sale off-session, up to the monthly caps. Prices are listed at https://recruitmcp.com/pricing. A card must already be on file from a pack checkout. Credits are granted only after the payment succeeds. Account keys only.

Scope: billing:manage. Acts on the account; keys bound to a customer are refused.

put/v1/billing/auto-refill

Request

  • Base URL: https://api.recruitmcp.com
  • URL: https://api.recruitmcp.com/v1/billing/auto-refill
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://recruitmcp.com/oauth/authorize, token URL https://recruitmcp.com/oauth/token, scopes: billing:manage)

Headers

Idempotency-Keystring

Optional on this route. At most 128 characters. When present, the same key and body replays the first response for 24 hours. A different body is 409 idempotency_key_reused. A second call waits for the first and replays it. Omit the header to run the request normally.

RecruitMCP-Version'2026-10-13'

API version. Defaults to the version the key was created with. Supported: 2026-10-13.

Request body

enabledboolean

Default true. False keeps the card and turns charging off.

threshold_creditsinteger required

Refill when the balance is below this.

max_refills_per_monthinteger required

Maximum charges in a UTC month.

max_eur_per_monthinteger required

Euro cap for a UTC month. At least the price of one pack. Prices are listed at https://recruitmcp.com/pricing.

Example request

{
  "enabled": true,
  "threshold_credits": 200,
  "max_refills_per_month": 3,
  "max_eur_per_month": 297
}

Response

Saved settings.

object'auto_refill' required
enabledboolean required
threshold_creditsinteger nullable

Refill when the balance is below this. Null until it is set.

max_refills_per_monthinteger nullable

Maximum charges in a UTC month.

max_eur_per_monthinteger nullable

Euro cap for a UTC month.

card_on_fileboolean required

True after a pack checkout saves a card.

refills_this_monthinteger required

Succeeded refills this UTC month. An in-flight charge is not counted until it is granted.

amount_eur_this_monthinteger required
disabled_reasonstring nullable

Why a failed charge turned auto-refill off.

Example response

{
  "object": "auto_refill",
  "enabled": true,
  "threshold_credits": 200,
  "max_refills_per_month": 3,
  "max_eur_per_month": 297,
  "card_on_file": true,
  "refills_this_month": 0,
  "amount_eur_this_month": 0,
  "disabled_reason": null
}

Changes

  • ad27b35513a6Revision changes
    • warning

      added the new approval_forced enum value to the / response property for the response status

    • warning

      added the new approval_forced enum value to the / response property for the response status

    • warning

      added the new approval_forced enum value to the / response property for the response status

    • warning

      added the new approval_forced enum value to the / response property for the response status

    • warning

      added the new approval_forced enum value to the / response property for the response status