Credits

Read the workspace credit balance

The credit balance of the workspace this credential is bound to.

A send spends one credit for the envelope, one for every signer who is not the sender, and one more when the envelope requires a one-time code; GET /envelopes/{envelopeId} quotes the total as creditCost. Check this balance before calling POST /envelopes/{envelopeId}/send: a send the balance cannot cover is refused, and the envelope stays in draft.

policy says whether that refusal can happen at all. A metered workspace is the normal case. An unmetered workspace is exempt from the charge: its balance never moves, and a send is never refused for credits, so an integration can skip the pre-flight check entirely.

Credits belong to the workspace, not to a member, so this never reports the balance of the user who issued the credential, and nothing in the request can point it at another workspace. Credits are bought at a Stripe checkout a human completes; createCreditCheckout opens one and returns the URL to hand them, and this number moves when they pay.

get/credits/balance

Request

  • Base URL: https://inkseal.net/api/v1
  • URL: https://inkseal.net/api/v1/credits/balance
  • Auth: HTTP bearer

Response

The workspace's current balance.

Example response

{
  "data": {
    "balance": 42,
    "policy": "metered"
  }
}

Changes

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