Invoices

Pay invoice

POST/v1/billing/invoices/{id}/pay

Pays the invoice from account credit or a saved payment method, or starts a payment for the caller to confirm when no method is given.

curl --request POST \
  --url https://api.serverside.com/v1/billing/invoices/{id}/pay \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "methodId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "providerType": "STRIPE"
}
'

{
  "success": true,
  "data": {
    "status": "PENDING",
    "transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "clientSecret": "<string>",
    "declineCode": "UNKNOWN"
  }
}

Autorisierung

Authorizationstringheadererforderlich
Organization API key (org_...), created in the cloud console at https://cloud.serverside.com and shown once, sent as Authorization: Bearer <key>. It authenticates as the organization.

Erforderliche Berechtigung: organization.billing.pay

Pfadparameter

idstring<uuid>erforderlich

Body

application/json

methodIdstring<uuid> | null
providerTypeenum<string>erforderlich
Zulässige Werte:STRIPEMANUALACCOUNT_CREDIT

Antwort

200 · application/json

OK

successbooleanerforderlich
Zulässige Werte:true
dataobject | nullerforderlich