Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Create payment payload
Payment type.
one_time
: One-time payment, generating one-off invoice.
Available options:
one_time
Example:
"one_time"
ID of the customer.
Example:
"cus_Typ0px2W0aiEtl"
Charging method.
immediately
: Customer's payment method will be charged directly to pay the invoice.checkout
: Dedicated checkout page will be created for the customer to pay the invoice.
Available options:
immediately
Deprecated field, please use products
.
Minimum length:
1
Products composing the related invoice.
Minimum length:
1
Purchase order added on the generated invoice.
Custom note added on the generated invoice.
Type of payment method to use to pay the invoice. If not specified, the payment_method_id or the default customer payment method is used.
Available options:
transfer
, external
ID of the payment method to use to pay the invoice. Ignored if payment_method_type is specified.
Example:
"pm_1ryTrMj4TTAT1N"