latestOpenAPI 3.0.32026-08-215925112.0 MB
36be0dca14e7
api
payment-plans
Complete a Payment Plan
post/api/payments/plans/{id}/complete
Path parameters
idstring required
Response
OK
_idstring required
The ID of the payment plan
secretstring required
The secret of the payment plan
status'DRAFT' | 'ACTIVE' | 'INCOMPLETE' | 'CANCELED' | 'COMPLETED' required
The status of the payment plan
currency'EUR' | 'USD' | 'GBP' | 'AUD' | 'CHF' | 'THB' | 'ILS' | 'COP' | 'MXN' | 'DKK' | 'NOK' | 'SEK' | 'QAR' | 'CAD' | 'ISK' | 'GTQ' | 'INR' | 'DOP' | 'SGD' | 'PLN' | 'SAR' | 'TTD' | 'ZAR' | 'KYD' | 'HKD' | 'CZK' | 'KRW' | 'JPY' | 'NZD' | 'AED' | 'MAD' | 'TWD' | 'BRL' | 'BWP' | 'NAD' | 'KES' | 'SCR' | 'TRY' | 'SZL' | 'LSL' | 'TZS' | 'UGX' | 'ZMW' | 'ZWG' | 'GHS' | 'NGN' | 'SLE' | 'LRD' | 'XOF' | 'XAF' | 'GEL' | 'IDR' | 'ARS' | 'CRC' | 'HUF' | 'EGP' | 'MYR' | 'VND' | 'PHP' | 'MWK' required
The currency of the payment plan
customerPaymentMethodIdstring required
The ID of the customer payment method
paymentStrategyIdstring required
The ID of the payment strategy
paymentOptionIdstring required
The ID of the payment option
checkoutIdstring
The ID of the checkout
subscriptionIdstring
The ID of the subscription
sellerIdstring required
The ID of the seller