Skip to content
Indiana
Dashboard
Docs
Browse docs / Restore native purchase

Restore native purchase

POST/api/v1/subscriptions/native/restore

Submit the store purchase intent and signed transaction or token. Verified provider facts prove ownership; retries recover the same order without granting twice.

SDK 0.0.1Updated

Make the request

Submit the store purchase intent and signed transaction or token. Verified provider facts prove ownership; retries recover the same order without granting twice.

Credential
Server API key or customer token. Customer calls cannot select another customer.
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/native/restore" \  -H "Authorization: Bearer $GROOVE_CUSTOMER_TOKEN" \  -H "X-Groove-Project: $GROOVE_PROJECT_ID" \  -H "X-Groove-Environment: sandbox" \  -H "Content-Type: application/json" \  -d '{  "requestId": "00000000-0000-4000-8000-000000000001",  "provider": "apple",  "purchaseIntentId": "00000000-0000-4000-8000-000000000001",  "productId": "app.pro",  "signedTransaction": "verified-store-jws"}'

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

Request parameters

JSON body

requestIduuid | uuidRequired

Business request UUID. Reuse for retries of one operation; generate a new value for a new operation.

provider"apple" | "google"Required

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

purchaseIntentIduuid | uuidRequired

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

productIdstring | stringRequired

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

signedTransactionstringOptional

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

minLength: 1 · maxLength: 131072

customerIduuid | uuidOptional

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

purchaseTokenstringOptional

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

minLength: 1 · maxLength: 16384

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
requestIduuidRequired

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

orderIduuidRequired

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

purchaseIntentIduuidRequired

The purchaseIntentId 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

"created""pending""trialing""paid""cancelled""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"

refundedbooleanRequired

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

completionobject | nullRequired

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

Show child fields
transactionIdsarrayRequired

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

minItems: 1 · maxItems: 50

membershipbooleanRequired

The membership 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