Payout

Payout - Hold

Pause a draft/pending payout so the transfer worker skips it. Does not change the ledger (we still owe it) — just delays sending.

post/admin/v1/billing/payouts/{id}/hold

Request

  • Base URL: https://api.juju.com
  • URL: https://api.juju.com/admin/v1/billing/payouts/{id}/hold
  • Auth: none declared

Path parameters

idinteger required

Response

Held payout.

metaobject required

Pagination and context metadata. Always present, empty object ({}) when no metadata applies to the response.

errorsstring[] required

Empty array on success. On failure, human-readable error strings suitable for surfacing to end users.

Example response

{
  "data": {
    "amount": "1875.0000",
    "currency": "USD"
  },
  "errors": []
}

Changes

No recorded changes to this operation across all 1 revision of this API.