API reference Memberships & checkout Confirm usage invoice adjustment POST /api/v1/billing/invoices/confirm-adjustment
Explicitly confirm fixed additional payment terms after customer review; the server rechecks the original invoice and amount.
SDK 0.0.1 Updated Oct 14, 2026
On this page
Make the request Explicitly confirm fixed additional payment terms after customer review; the server rechecks the original invoice and amount.
Credential Customer token only. Identity is bound to the token.
Permission billing:writeSet the base URL and App ID from SDK setup. These examples use placeholders and do not execute requests. Never put a server key in browser code.
For this Web Beta, configure the Stripe Sandbox test account and published price mappings before checkout. Redirects do not confirm payment.
1 curl -X POST "$GROOVE_BASE_URL/api/v1/billing/invoices/confirm-adjustment" \2 -H "Authorization: Bearer $GROOVE_CUSTOMER_TOKEN" \ 3 -H "X-Groove-Project: $GROOVE_PROJECT_ID" \ 4 -H "X-Groove-Environment: sandbox" \ 5 -H "Content-Type: application/json" \ 6 -d '{ 7 "invoiceId" : "00000000-0000-4000-8000-000000000001" , 8 "accepted" : true 9 } '
The response tab lists field types, not an example payload. Actual values depend on customer state.
Request parameters JSON body invoiceIduuid Required The invoiceId value for this operation. Its accepted type and constraints are listed above and below.
acceptedtrue Required Whether business rules accepted the operation. HTTP 200 does not imply accepted is true.
Response fields Successful responses include requestId and scope. Use the actual business status or accepted field to determine the result. Optional fields are omitted when unavailable.
HTTP 200 · application/json requestIduuid Required Server-generated HTTP request UUID. Include it when reporting a failed request.
scopeobject Required The App and environment of this response. Headers only verify scope; they cannot switch key scope.
projectIdstring Required App ID bound to the credential.
minLength: 1
environmentenum Required Separate data scope: sandbox or live.
"sandbox""live"
invoiceobject Required The invoice value for this operation. Its accepted type and constraints are listed above and below.
iduuid Required The id value for this operation. Its accepted type and constraints are listed above and below.
sourceKindenum Required The sourceKind value for this operation. Its accepted type and constraints are listed above and below.
"product""usage"
providerInvoiceIdstring | null Required The providerInvoiceId value for this operation. Its accepted type and constraints are listed above and below.
statusenum Required The status value for this operation. Its accepted type and constraints are listed above and below.
"accruing""open""pending""paid""failed""void"
currencyenum Required Currency code supported by the published price.
"USD""EUR""CNY""GBP""JPY""CAD""AUD""NZD""CHF""HKD""SGD""KRW""INR""BRL""MXN""TWD""THB""IDR""MYR""PHP""VND""ZAR""AED""SAR""SEK""NOK""DKK""PLN""CZK""HUF""ILS""TRY""RON"
startsAtdate-time Required The startsAt value for this operation. Its accepted type and constraints are listed above and below.
endsAtdate-time Required The endsAt value for this operation. Its accepted type and constraints are listed above and below.
amountMinorstring Required The amountMinor value for this operation. Its accepted type and constraints are listed above and below.
pattern: ^(0|[1-9]\d{0,14})$
grossAmountMinorstring Required The grossAmountMinor value for this operation. Its accepted type and constraints are listed above and below.
pattern: ^(0|[1-9]\d{0,14})$
discountMinorstring Required The discountMinor value for this operation. Its accepted type and constraints are listed above and below.
pattern: ^(0|[1-9]\d{0,14})$
paidAmountMinorstring Required The paidAmountMinor value for this operation. Its accepted type and constraints are listed above and below.
pattern: ^(0|[1-9]\d{0,14})$
refundedAmountMinorstring Required The refundedAmountMinor value for this operation. Its accepted type and constraints are listed above and below.
pattern: ^(0|[1-9]\d{0,14})$
createdAtdate-time Required ISO 8601 UTC time when the record was created.
hostedInvoiceUrluri | null Required The hostedInvoiceUrl value for this operation. Its accepted type and constraints are listed above and below.
adjustmentobject | null Required The adjustment value for this operation. Its accepted type and constraints are listed above and below.
originalInvoiceIduuid Required The originalInvoiceId value for this operation. Its accepted type and constraints are listed above and below.
amountMinorstring Required The amountMinor value for this operation. Its accepted type and constraints are listed above and below.
pattern: ^-?(0|[1-9]\d{0,8})$
acceptedAtdate-time | null Required The acceptedAt value for this operation. Its accepted type and constraints are listed above and below.
linesarray Required The lines value for this operation. Its accepted type and constraints are listed above and below.
maxItems: 100
iduuid Required The id value for this operation. Its accepted type and constraints are listed above and below.
entitlementIduuid Required The entitlementId value for this operation. Its accepted type and constraints are listed above and below.
entitlementVersionIduuid Required The entitlementVersionId value for this operation. Its accepted type and constraints are listed above and below.
productVersionIduuid Required The productVersionId value for this operation. Its accepted type and constraints are listed above and below.
authorizationIduuid Required The authorizationId value for this operation. Its accepted type and constraints are listed above and below.
entityIduuid | null Required Entity ID within the current customer scope, for configured entity and license features.
unitsobject Required The units value for this operation. Its accepted type and constraints are listed above and below.
amountMinorstring Required The amountMinor value for this operation. Its accepted type and constraints are listed above and below.
pattern: ^(0|[1-9]\d{0,17})(\.\d{1,30})?$
cashPriceobject Required The cashPrice value for this operation. Its accepted type and constraints are listed above and below.
currencyenum Required Currency code supported by the published price.
"USD""EUR""CNY""GBP""JPY""CAD""AUD""NZD""CHF""HKD""SGD""KRW""INR""BRL""MXN""TWD""THB""IDR""MYR""PHP""VND""ZAR""AED""SAR""SEK""NOK""DKK""PLN""CZK""HUF""ILS""TRY""RON"
pricingobject | object Required The pricing value for this operation. Its accepted type and constraints are listed above and below.
billingCycleobject Optional The billingCycle value for this operation. Its accepted type and constraints are listed above and below.
linesLimitedboolean Required The linesLimited value for this operation. Its accepted type and constraints are listed above and below.
Handle errors Common failures Code Recovery UNAUTHENTICATED Verify the key or refresh the expired customer token once. FORBIDDEN Check current key permissions and customer access. INVALID_REQUEST Check field types, UUIDs, decimal strings and mutually exclusive fields. SCOPE_MISMATCH Use the App and environment bound to the credential.
Common failures
UNAUTHENTICATED
Recovery Verify the key or refresh the expired customer token once. FORBIDDEN
Recovery Check current key permissions and customer access. INVALID_REQUEST
Recovery Check field types, UUIDs, decimal strings and mutually exclusive fields. SCOPE_MISMATCH
Recovery Use the App and environment bound to the credential. Related:All request and error conventions · Back to endpoint index