Create Setup Intent

POST /v3/teams/{team}/billing/payment-methods/setup-intent

Create Setup Intent

cURL

curl --request POST \
  --url https://app.plugchoice.com/api/v3/teams/{team}/billing/payment-methods/setup-intent \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "context": "<string>"
}
'

200

{
  "client_secret": "<string>",
  "billing_defaults": {
    "name": "<string>",
    "email": "<string>",
    "address": {
      "country": "<string>",
      "line1": "<string>",
      "postal_code": "<string>",
      "city": "<string>"
    }
  }
}

Creates a Stripe Setup Intent for adding a new payment method. Returns a client secret for use with Stripe.js.

team · string · required

The UUID of the team.

context · string

Set to reimbursement to restrict to SEPA/iDEAL payment methods only.

Response

client_secret · string

The Stripe Setup Intent client secret for use with Stripe.js.

billing_defaults · object

Default billing information to pre-fill in the payment form.

Show billing_defaults properties

name · string

The company name, or null if not set.

email · string

The billing email address, or null if not set.

address · object

The billing address defaults.

Show address properties

country · string

Two-letter ISO country code.

line1 · string

Street address line.

postal_code · string

Postal or ZIP code.

city · string

City name.