Docs/Admin API/Payment methods/Create intent

Create a payment method intent

Preview

POST/admin/v1/paymentMethods:createIntent

Create a payment method intent.

This can be used with a third-party billing provider API to store a payment method.

body parameters

organizationId
string
The identifier of the organization.
This is required if the user identifier is not specified.
userId
string
The identifier of the user.
This is required if the organization identifier is not not specified.
connectionId
string
Required
The identifier of the connection.

Returns

stripe
StripePaymentMethodIntent
A Stripe Setup Intent.
accountId
string
The Stripe account ID (e.g. acct_1LcUvxQYGbxD2SPK)
live
boolean
Whether the Stripe Setup Intent was created in live mode.
clientSecret
string
The Stripe Setup Intent client secret.
paymentElementOptions
any
The Stripe.js Payment Element options.

code
enum
The general error code (e.g. INVALID_ARGUMENT).
Possible values:
OKCANCELLEDUNKNOWNINVALID_ARGUMENTDEADLINE_EXCEEDEDNOT_FOUNDALREADY_EXISTSPERMISSION_DENIEDUNAUTHENTICATEDRESOURCE_EXHAUSTEDFAILED_PRECONDITIONABORTEDOUT_OF_RANGEUNIMPLEMENTEDINTERNALUNAVAILABLEDATA_LOSS
message
string
A developer-facing error message.
reason
string
A reason code for the error (e.g. USER_PENDING_DELETION).
param
string
The parameter path related to the error (e.g. member.userId).
metadata
string
Additional metadata related to the error.
localeMessage
string
A user-facing error message.

curl https://api.userhub.com/admin/v1/paymentMethods:createIntent \
  -H "Authorization: Bearer $USERHUB_ADMIN_KEY" \
  --json '{
    "organizationId": "org_28seyVGVL1got6",
    "connectionId": "conn_4HdRKnTvPmmjYK"
  }'

const res = await adminApi.paymentMethods.createIntent({
  organizationId: "org_28seyVGVL1got6",
  connectionId: "conn_4HdRKnTvPmmjYK",
});

res, err := adminApi.PaymentMethods().CreateIntent(
    context.Background(),
    &adminapi.PaymentMethodCreateIntentInput{
        OrganizationId: "org_28seyVGVL1got6",
        ConnectionId: "conn_4HdRKnTvPmmjYK",
    },
)

$res = $adminApi->paymentMethods->createIntent(
    organizationId: 'org_28seyVGVL1got6',
    connectionId: 'conn_4HdRKnTvPmmjYK',
);

res = admin_api.payment_methods.create_intent(
    organization_id="org_28seyVGVL1got6",
    connection_id="conn_4HdRKnTvPmmjYK",
)

Response bodyJSON

{
  "stripe": {
    "accountId": "acct_1MYWwjGZndmhrwhA",
    "live": false,
    "clientSecret": "seti_1JIn79LN82CfHITx1e2dCDiT_secret_SH..."
  }
}

PreviousCreate a payment method

NextGet a payment method

Create a payment method intent

.css-10iahqc{text-transform:capitalize;}body parameters

Returns

body parameters