DEdecodahealth
provider
billing
public

Create Payment Plan With Charges

Create a payment plan with charges for $0 down payments.

  1. Creates charges using existing billing service
  2. Creates/stores payment method using existing billing service methods
  3. Creates payment plan with those charge IDs and payment method
post/billing/payment-plan/create-with-charges

Request

Headers

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

Request body

rainforestPaymentMethodIdstring required

Response

Successful Response

initialAmountinteger required

The initial payment amount for the payment plan

chargeIdsstring[] required

The IDs of the associated charges

frequency'WEEKLY' | 'BIWEEKLY' | 'MONTHLY' required
installmentsinteger required

The number of installment payments

installmentAmountinteger required

The amount of each installment payment

locationIdstring nullable

The ID of the associated location

startDatestring date nullable

Optional start date for the first payment (only allowed for $0 down payment plans)

idstring

The ID of the payment plan

paymentMethodIdstring required

The ID of the associated payment method

Changes

No recorded changes to this operation across all 2 revisions of this API.