CreateSetupIntentRequest

customerId
required
string <uuid>

The unique identifier for the customer record.

standingInstructionType
string

Indicates the type of standing instruction when Usage=OFF_SESSION.

Enum: "UNSCHEDULED" "INSTALLMENT" "RECURRING"
usage
required
string (Usage)
Default: "ON_SESSION"

The usage of the setup intent. Use ON_SESSION for payments made when customer are present and OFF_SESSION for payments made when customer are not present.

Enum: "ON_SESSION" "OFF_SESSION"
{
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "usage": "ON_SESSION",
  • "standingInstructionType": "UNSCHEDULED"
}