Skip to main content
POST
Finalize gateway billing group

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Body

application/json
billing_group_id
string
required
Required string length: 1 - 255
Pattern: ^[A-Za-z0-9._:-]+$

Response

Billing group finalized

ok
enum<boolean>
required
Available options:
true
billing_group_id
string
required
already_finalized
boolean
required
request_count
integer
required
Required range: x >= 0
charged_credits
number
required
Required range: x >= 0
target_credits
number
required
Required range: x >= 0
adjustment_credits
number
required
Required range: x >= 0
adjustment
enum<string>
required
Available options:
none,
refund,
spend
provider_cost_usd
number
required
Required range: x >= 0
veryfront_charge_usd
number
required
Required range: x >= 0
veryfront_billed_usd
number
required
Required range: x >= 0
usage_capture_status
enum<string>
required
Available options:
complete