Skip to content
Indiana
Dashboard
Docs
Browse docs / Set billing coupons

Set billing coupons

POST/api/v1/billing/coupons

The verified customer selects up to 20 owned grants for a confirmed authorization. Discounts apply in order; an empty list removes them. Retain the request ID for retries; an active collection stays fixed.

SDK 0.0.1Updated

Make the request

The verified customer selects up to 20 owned grants for a confirmed authorization. Discounts apply in order; an empty list removes them. Retain the request ID for retries; an active collection stays fixed.

Credential
Customer token only. Identity is bound to the token.
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/billing/coupons" \  -H "Authorization: Bearer $GROOVE_CUSTOMER_TOKEN" \  -H "X-Groove-Project: $GROOVE_PROJECT_ID" \  -H "X-Groove-Environment: sandbox" \  -H "Content-Type: application/json" \  -d '{  "authorizationId": "00000000-0000-4000-8000-000000000001",  "requestId": "00000000-0000-4000-8000-000000000001",  "grantIds": []}'

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

Request parameters

JSON body

authorizationIduuidRequired

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

requestIduuidRequired

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

grantIdsarrayRequired

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

maxItems: 20

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"

couponsobjectRequired

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

Show child fields
authorizationIduuidRequired

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

grantsarrayRequired

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

maxItems: 20

Show child fields
iduuidRequired

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

couponIduuidRequired

Coupon UUID in the current App and environment.

namestringRequired

Display name of the customer or object; not an identity key.

discountobject | objectRequired

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

Show child fields
type"percent" | "amount"Required

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

percentOffintegerOptional

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

min: 1 · max: 100

amountOffCentsintegerOptional

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

min: 1 · max: 100000000

currencyenumOptional

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"

durationobject | object | objectRequired

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

Show child fields
type"once" | "repeating" | "forever"Required

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

monthsintegerOptional

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

min: 1 · max: 36

startedAtdate-time | nullRequired

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