Praecise Platform
Menu

Skerry/ Reference/ Payers, saved methods and subscriptions

Charge a payer on a schedule from a saved method

post/subscriptions

Charge a payer on a schedule from a saved method. Needs an Idempotency-Key. Under a mandate that covers subscription.create, the amount of one period (integer minor units) is checked against the mandate and counted once.

Before you call

Credential
Authorization: Bearer $KEY
Scope
payments:write
Moves money
yes
Idempotency
required
Untrusted
reference, external_ref, metadata

Parameters

  • Idempotency-Keystringrequired
    Header. A repeat with the same key and body returns the first answer instead of acting twice.

Request bodyapplication/json, required

  • customer_idstringrequired
    At most 200 characters.
  • payer_idstringrequired
    At most 200 characters.
  • payment_method_idstringrequired
    At most 200 characters.
  • currencystringrequired
    Pattern: ^[A-Za-z]{3}$.
  • intervalstringrequired
    At most 40 characters.
  • interval_countinteger
    At least 1.
  • itemslist of objectrequired
    • namestringrequired
      At most 500 characters.
    • amountintegerrequired
      Integer minor units of currency, for one unit. At least 1.
    • quantityinteger
      At least 1.
  • trial_daysinteger
    At least 0.
  • referencestring
    At most 500 characters.
  • external_refstring
    The document this belongs to in your own system. At most 200 characters.
  • external_kindstring
    One of: invoice, bill, order, booking, other.
  • dry_runboolean
    Check the request and report what would happen, without doing it.

Responses

  • 200
    Success.
  • 202
    requires_approval — Not an error: the operation is held for a person. The body names the approval.
  • 400
    price_below_minimum — The price is below the smallest single payment for a method (detail.method, detail.minimum), or has a part of a cent. Set credit_only, raise the price, or drop the method.
  • 401
    dpop_invalid — The token is bound to a key and the DPoP proof was missing, wrong for this request, or already used.
  • 402
    payment_failed — The payer's bank or card refused. detail.reason says why in plain terms.
  • 403
    agent_payment_over_max — The merchant asks for more than max_amount. Nothing was signed. detail.asked_minor is the lowest price asked, in US cents.
  • 404
    not_found — No such object in this project — including one that belongs to somebody else.
  • 409
    token_not_issued — A delegated payment token could not be issued ready to use, for instance because the payer would have to act. Nothing was sent to the merchant.
  • 429
    too_many_waiters — This key already has as many requests waiting (?wait=) as it may. Let one finish, or read without wait.
  • 500
    internal_error — Ours. Quote the request_id and we can find the call.
  • 502
    platform_error — A provider failed. Safe to retry with the same Idempotency-Key.
  • 503
    oauth_unavailable — The authorisation server's keys could not be read, so tokens cannot be checked. API keys still work.

This page as Markdown