Create an installment for a customer (specified by Customer ID) with a Billing Frequency Type (Daily, Weekly, Biweekly, Monthly, Bimonthly, Quarterly, Semiannually, Yearly), Installment type (Interval, Amount), Installment value and Installment items. Payment method information (with billing address, billing first name, billing last name, payment method type (credit card, ach, google pay)) or an authorized payment method identifier or payment method identifier must be provided.
Optionally, a MerchantInstallmentRefId, TaxAddress, StartDate, TrailDuration and TrailDurationType (the same values as in Billing Frequency Type), DownPayment may be included.
Upon successful creation of the installment, a status code of 201 (Created) will be returned.
If the Customer ID provided does not exist, a status code of 404 (NotFound) will be returned.
If an installment cannot be created with the provided data, a status code of 400 (Bad Request) will be returned.
| Name | Description |
|---|---|
| BillingFrequencyType | How often the subscription should be attempted for billing |
| InstallmentItems | The installment's individual billing items |
| InstallmentType | How the installment period will be divided by amount or number of intervals |
| InstallmentValue | The number of cycles if installment type is Interval or payment amount per settlement cycle if installment type is Amount |
| Name | Description | Default value |
|---|---|---|
| MerchantInstallmentRefId | Merchant's unique identifier for the installment | null |
| StartDate | Subscription's start date | Today |
| TrialDuration | The amount of trial duration time in the unit of TrialDurationType | 0 |
| TrialDurationType | The type of trial duration | Daily |
| TaxAddress | Address to be used for taxation purposes. Possible sets of Address details: AddressLine1, City and State or AddressLine1 and PostalCode or State and PostalCode | null |
| DownPayment | The payment a customer pays upfront | 0 |
| PaymentMethodAuthorizationId | Unique identifier for a previously pre-authorized payment method | null |
| PaymentMethod | The payment method information | null |
| PaymentMethodId | Unique identifier for the customer's payment information | null |