Skip to content
Indiana
Dashboard
Docs
Browse docs / Confirm subscription refund

Confirm subscription refund

POST/api/v1/subscriptions/refunds/confirm

Confirm the original operationId to request the fixed provider refund and credit note. Retries recover the original provider outcome.

SDK 0.0.1Updated

Make the request

Confirm the original operationId to request the fixed provider refund and credit note. Retries recover the original provider outcome.

Credential
Server API key only. Call from your trusted backend.
Permission
billing:write
Set 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.
request.shShell
curl -X POST "$GROOVE_BASE_URL/api/v1/subscriptions/refunds/confirm" \  -H "Authorization: Bearer $GROOVE_SECRET_KEY" \  -H "X-Groove-Project: $GROOVE_PROJECT_ID" \  -H "X-Groove-Environment: sandbox" \  -H "Content-Type: application/json" \  -d '{  "customerId": "00000000-0000-4000-8000-000000000001",  "operationId": "00000000-0000-4000-8000-000000000001"}'

The response tab lists field types, not an example payload. Actual values depend on customer state.

Request parameters

JSON body

operationIduuidRequired

Business operation UUID. Subscription execution references operationId from previewAttach; balance refunds reference the original consumption.

customerIduuidRequired

Indiana customer ID mapped from a verified identity on the server. Omit for customer-token calls, which use the token-bound customer.

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

requestIduuidRequired

Server-generated HTTP request UUID. Include it when reporting a failed request.

scopeobjectRequired

The App and environment of this response. Headers only verify scope; they cannot switch key scope.

Show child fields
projectIdstringRequired

App ID bound to the credential.

minLength: 1

environmentenumRequired

Separate data scope: sandbox or live.

Show allowed values

"sandbox""live"

operationobjectRequired

The operation value for this operation. Its accepted type and constraints are listed above and below.

Show child fields
operationIduuidRequired

Business operation UUID. Subscription execution references operationId from previewAttach; balance refunds reference the original consumption.

membershipIduuidRequired

The membershipId value for this operation. Its accepted type and constraints are listed above and below.

purchaseIduuidRequired

The purchaseId value for this operation. Its accepted type and constraints are listed above and below.

statusenumRequired

The status value for this operation. Its accepted type and constraints are listed above and below.

Show allowed values

"prepared""confirmed""pending""effective""failed"

currencyenumRequired

Currency code supported by the published price.

Show allowed values

"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"

amountMinorintegerRequired

The amountMinor value for this operation. Its accepted type and constraints are listed above and below.

max: 100000000

entitlementActionenumRequired

The entitlementAction value for this operation. Its accepted type and constraints are listed above and below.

Show allowed values

"retain""revoke"

refundIdstarts_with | nullRequired

The refundId value for this operation. Its accepted type and constraints are listed above and below.

creditNoteIdstarts_with | nullRequired

The creditNoteId value for this operation. Its accepted type and constraints are listed above and below.

Handle errors

Common failures
CodeRecovery
UNAUTHENTICATEDVerify the key or refresh the expired customer token once.
FORBIDDENCheck current key permissions and customer access.
INVALID_REQUESTCheck field types, UUIDs, decimal strings and mutually exclusive fields.
SCOPE_MISMATCHUse 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