Set up a payment method

POST/api/v1/billing/setup-payment

Create a standalone Stripe Sandbox Setup Checkout. Reuse requestId to recover the same setup; makeDefault explicitly controls the default method. Collecting a card creates no subscription, entitlement or usage billing consent. Browser requests use the verified customer identity.

SDK 0.0.1Updated Oct 14, 2026

Make the request

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

1curl -X POST "$GROOVE_BASE_URL/api/v1/billing/setup-payment" \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  "customerId": "00000000-0000-4000-8000-000000000001",8  "requestId": "00000000-0000-4000-8000-000000000001",9  "currency": "USD",10  "makeDefault": false11}'

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

Request parameters

JSON body

requestIduuidRequired: Business request UUID. Reuse for retries of one operation; generate a new value for a new operation.
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"
makeDefaultbooleanRequired: The makeDefault value for this operation. Its accepted type and constraints are listed above and below.
customerIduuidOptional: 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"

setupobjectRequired

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

Show child fields

iduuidRequired: The id value for this operation. Its accepted type and constraints are listed above and below.
provider"stripe"Required: The provider 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""complete""expired"
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"
makeDefaultbooleanRequired: The makeDefault value for this operation. Its accepted type and constraints are listed above and below.
urluri | nullRequired: Hosted checkout URL. Verified provider notifications confirm payment.
createdAtdate-timeRequired: ISO 8601 UTC time when the record was created.
expiresAtdate-timeRequired: ISO 8601 UTC expiry. Expired sessions and reservations cannot be reused.
completedAtdate-time | nullRequired: The completedAt 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.